copyright The Portico Project 2008.

org.portico.shared.model
Class ACInstance

java.lang.Object
  extended by org.portico.shared.model.ACInstance
All Implemented Interfaces:
Serializable

public class ACInstance
extends Object
implements Serializable

This class represents a single instance of an attribute that exists inside an OCInstance. It contains information such as the handle and type (metadata) of the attribute, however, it does not hold the value of the attribute.

See Also:
Serialized Form

Field Summary
private  OCInstance container
           
private  int handle
           
private  int owner
           
private  RegionInstance region
           
private static long serialVersionUID
           
private  ACMetadata type
           
 
Constructor Summary
ACInstance()
           
ACInstance(ACMetadata type)
           
ACInstance(ACMetadata type, int owner)
           
ACInstance(ACMetadata type, int owner, OCInstance container)
           
 
Method Summary
 OCInstance getContainer()
           
 int getHandle()
          The handle of the attribute type from the FOM.
 int getOwner()
          The federate handle of the owning federate.
 RegionInstance getRegion()
          Returns the region associated with this particular attribute.
 ACMetadata getType()
           
 void setContainer(OCInstance container)
           
 void setOwner(int owner)
          The federate handle of the owning federate.
 void setRegion(RegionInstance region)
           
 void setType(ACMetadata type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

handle

private int handle

owner

private int owner

container

private OCInstance container

type

private ACMetadata type

region

private RegionInstance region
Constructor Detail

ACInstance

public ACInstance()

ACInstance

public ACInstance(ACMetadata type)

ACInstance

public ACInstance(ACMetadata type,
                  int owner)

ACInstance

public ACInstance(ACMetadata type,
                  int owner,
                  OCInstance container)
Method Detail

getContainer

public OCInstance getContainer()

setContainer

public void setContainer(OCInstance container)

getHandle

public int getHandle()
The handle of the attribute type from the FOM. This is not a unique handle for the instance itself, but the handle that identifies the attribute within the FOM.


getOwner

public int getOwner()
The federate handle of the owning federate. If this attribute is not owned by any federate, PorticoConstants.NULL_HANDLE is used.


setOwner

public void setOwner(int owner)
The federate handle of the owning federate. If this attribute is not owned by any federate, PorticoConstants.NULL_HANDLE should be used.


getType

public ACMetadata getType()

setType

public void setType(ACMetadata type)

getRegion

public RegionInstance getRegion()
Returns the region associated with this particular attribute. If there is no region for the attribute, null is returned.


setRegion

public void setRegion(RegionInstance region)

copyright The Portico Project 2008.