COM.hugin.HAPI
Class Clique

java.lang.Object
  COM.hugin.HAPI.Clique

public class Clique

extends java.lang.Object

Represents the cliques in the JunctionTree.

Method Summary

JunctionTree	getJunctionTree() Returns the JunctionTree to which this Clique belongs.
NodeList	getMembers() Returns a list of Nodes that are members of this Clique.
CliqueList	getNeighbors() Returns a list of Cliques that are neighbors of this Clique.
java.lang.Object	getUserData() Returns the value stored within the user data slot of this Clique.
boolean	isAlive() Is this Clique object alive?
void	setUserData(java.lang.Object data) Sets the user data field of this Clique.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getJunctionTree

public JunctionTree getJunctionTree()
                             throws ExceptionHugin

Returns the JunctionTree to which this Clique belongs.

Throws:

ExceptionHugin

getNeighbors

public CliqueList getNeighbors()
                        throws ExceptionHugin

Returns a list of Cliques that are neighbors of this Clique.

Returns:

A CliqueList containing the neighbors.

Throws:

ExceptionHugin

getMembers

public NodeList getMembers()
                    throws ExceptionHugin

Returns a list of Nodes that are members of this Clique.

Returns:

A NodeList containing the members.

Throws:

ExceptionHugin

isAlive

public boolean isAlive()

Is this Clique object alive?

getUserData

public java.lang.Object getUserData()

Returns the value stored within the user data slot of this Clique. If the stored value is NULL, or if no value has been stored, NULL is returned.

Returns:

Object stored within the Clique.

setUserData

public void setUserData(java.lang.Object data)

Sets the user data field of this Clique. The Hugin API provides a slot within each Clique for use exclusively by the user/application.

Parameters:

data - User-defined data associated with this Clique.