IFactorGraphChild.java

/*******************************************************************************
*   Copyright 2015 Analog Devices, Inc.
*
*   Licensed under the Apache License, Version 2.0 (the "License");
*   you may not use this file except in compliance with the License.
*   You may obtain a copy of the License at
*
*       http://www.apache.org/licenses/LICENSE-2.0
*
*   Unless required by applicable law or agreed to in writing, software
*   distributed under the License is distributed on an "AS IS" BASIS,
*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*   See the License for the specific language governing permissions and
*   limitations under the License.
********************************************************************************/

package com.analog.lyric.dimple.model.core;

import org.eclipse.jdt.annotation.Nullable;

import com.analog.lyric.util.misc.IGetId;

/**
 * 
 * @since 0.08
 * @author Christopher Barber
 */
public interface IFactorGraphChild extends IGetId
{
	/**
	 * Uniquely identifies node within its graph tree.
	 * <p>
	 * Similar to the {@linkplain #getGlobalId() global id} but is only unique within the
	 * tree of graphs containing this node. Looking up nodes by this id is faster than
	 * lookup by the global id.
	 * <p>
	 * @since 0.08
	 * @see Ids#graphTreeIdFromParts(int, int)
	 * @see Ids#graphTreeIndexFromGraphTreeId(long)
	 * @see Ids#localIdFromGraphTreeId(long)
	 */
	public long getGraphTreeId();

	/**
	 * Returns factor graph most immediately containing this object. Returns this object if
	 * it is already a {@link FactorGraph}.
	 *
	 * @since 0.08
	 */
	public @Nullable FactorGraph getContainingGraph();
	
	public @Nullable FactorGraph getParentGraph();
	
	public @Nullable FactorGraph getRootGraph();
}