org.npsnet.xrti.proxies
Class HLAinteractionClassProxy

java.lang.Object
  org.npsnet.xrti.utilities.ObjectInstanceProxy
      org.npsnet.xrti.proxies.HLAobjectRootProxy
          org.npsnet.xrti.proxies.HLAreflectionProxy
              org.npsnet.xrti.proxies.HLAinteractionClassProxy

All Implemented Interfaces:

HLAinteractionClass, HLAobjectRoot, HLAreflection

public class HLAinteractionClassProxy

extends HLAreflectionProxy

implements HLAinteractionClass

Represents an HLA interaction class.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Field Summary

private java.lang.String	dimensions The dimensions of the interaction.
private AttributeHandle	dimensionsHandle The handle of the dimensions attribute.
private boolean	dimensionsIsDirty Whether or not the dimensions attribute has changed.
private boolean	dimensionsIsValid Whether or not the dimensions attribute has been set.
private java.util.Vector	HLAinteractionClassListeners Listeners for attributes associated with the HLAinteractionClass class.
private HLAorderType	order The order of the interaction.
private AttributeHandle	orderHandle The handle of the order attribute.
private boolean	orderIsDirty Whether or not the order attribute has changed.
private boolean	orderIsValid Whether or not the order attribute has been set.
private long[]	parameters The handles of the interaction parameters.
private AttributeHandle	parametersHandle The handle of the parameters attribute.
private boolean	parametersIsDirty Whether or not the parameters attribute has changed.
private boolean	parametersIsValid Whether or not the parameters attribute has been set.
private java.lang.String	parents The parents of the interaction class.
private AttributeHandle	parentsHandle The handle of the parents attribute.
private boolean	parentsIsDirty Whether or not the parents attribute has changed.
private boolean	parentsIsValid Whether or not the parents attribute has been set.
private java.lang.String	semantics The semantics of the interaction.
private AttributeHandle	semanticsHandle The handle of the semantics attribute.
private boolean	semanticsIsDirty Whether or not the semantics attribute has changed.
private boolean	semanticsIsValid Whether or not the semantics attribute has been set.
private HLAsharingType	sharing The types of sharing permitted on the interaction.
private AttributeHandle	sharingHandle The handle of the sharing attribute.
private boolean	sharingIsDirty Whether or not the sharing attribute has changed.
private boolean	sharingIsValid Whether or not the sharing attribute has been set.
private java.lang.String	transportation The transportation of the interaction.
private AttributeHandle	transportationHandle The handle of the transportation attribute.
private boolean	transportationIsDirty Whether or not the transportation attribute has changed.
private boolean	transportationIsValid Whether or not the transportation attribute has been set.

Fields inherited from class org.npsnet.xrti.proxies.HLAreflectionProxy

Fields inherited from class org.npsnet.xrti.proxies.HLAobjectRootProxy

Fields inherited from class org.npsnet.xrti.utilities.ObjectInstanceProxy

autoFlushDisabled, classHandle, deleted, instanceHandle, rtiAmbassador

Constructor Summary

protected	HLAinteractionClassProxy(RTIambassador pRTIAmbassador, ObjectClassHandle pClassHandle) Constructor for object instance proxies created to represent new locally owned objects.
protected	HLAinteractionClassProxy(RTIambassador pRTIAmbassador, ObjectClassHandle pClassHandle, java.lang.String pName) Constructor for object instance proxies created to represent new locally owned objects.
protected	HLAinteractionClassProxy(RTIambassador pRTIAmbassador, ObjectInstanceHandle pInstanceHandle, ObjectClassHandle pClassHandle, java.lang.String pName) Constructor for object instance proxies created in response to discovered objects.

Method Summary

void	addHLAinteractionClassListener(HLAinteractionClassListener l) Adds a listener for attributes associated with the HLAinteractionClass class.
protected void	getAttributeValuesToFlush(AttributeHandleValueMap ahvm, boolean superFlush) Places the attribute values to flush into the specified map.
java.lang.String	getDimensions() Returns the value of the dimensions attribute.
HLAorderType	getOrder() Returns the value of the order attribute.
long[]	getParameters() Returns the value of the parameters attribute.
java.lang.String	getParents() Returns the value of the parents attribute.
java.lang.String	getSemantics() Returns the value of the semantics attribute.
HLAsharingType	getSharing() Returns the value of the sharing attribute.
java.lang.String	getTransportation() Returns the value of the transportation attribute.
private void	initializeAttributes() Initializes the attributes and their handles.
void	provideAttributeValueUpdate(AttributeHandleSet theAttributes, byte[] userSuppliedTag) Notifies the proxy that it should provide an update regarding a set of object attributes.
void	reflectAttributeValues(AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the proxy of changes to the state of an object instance.
void	removeHLAinteractionClassListener(HLAinteractionClassListener l) Removes a listener for attributes associated with the HLAinteractionClass class.
void	setDimensions(java.lang.String pDimensions, byte[] userSuppliedTag) Sets the value of the dimensions attribute.
void	setOrder(HLAorderType pOrder, byte[] userSuppliedTag) Sets the value of the order attribute.
void	setParameters(long[] pParameters, byte[] userSuppliedTag) Sets the value of the parameters attribute.
void	setParents(java.lang.String pParents, byte[] userSuppliedTag) Sets the value of the parents attribute.
void	setSemantics(java.lang.String pSemantics, byte[] userSuppliedTag) Sets the value of the semantics attribute.
void	setSharing(HLAsharingType pSharing, byte[] userSuppliedTag) Sets the value of the sharing attribute.
void	setTransportation(java.lang.String pTransportation, byte[] userSuppliedTag) Sets the value of the transportation attribute.

Methods inherited from class org.npsnet.xrti.proxies.HLAreflectionProxy

addHLAreflectionListener, getName, removeHLAreflectionListener, setName

Methods inherited from class org.npsnet.xrti.proxies.HLAobjectRootProxy

addHLAobjectRootListener, removeHLAobjectRootListener

Methods inherited from class org.npsnet.xrti.utilities.ObjectInstanceProxy

delete, equals, flushAttributeValues, flushAttributeValues, getAutoFlushDisabled, getClassHandle, getInstanceHandle, hashCode, isDeleted, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, setAutoFlushDisabled, setDeleted, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.npsnet.xrti.proxies.HLAreflection

addHLAreflectionListener, getName, removeHLAreflectionListener, setName

Methods inherited from interface org.npsnet.xrti.proxies.HLAobjectRoot

addHLAobjectRootListener, removeHLAobjectRootListener

Field Detail

HLAinteractionClassListeners

private java.util.Vector HLAinteractionClassListeners

Listeners for attributes associated with the HLAinteractionClass class.

parentsHandle

private AttributeHandle parentsHandle

The handle of the parents attribute.

parentsIsValid

private boolean parentsIsValid

Whether or not the parents attribute has been set.

parentsIsDirty

private boolean parentsIsDirty

Whether or not the parents attribute has changed.

parents

private java.lang.String parents

The parents of the interaction class.

sharingHandle

private AttributeHandle sharingHandle

The handle of the sharing attribute.

sharingIsValid

private boolean sharingIsValid

Whether or not the sharing attribute has been set.

sharingIsDirty

private boolean sharingIsDirty

Whether or not the sharing attribute has changed.

sharing

private HLAsharingType sharing

The types of sharing permitted on the interaction.

dimensionsHandle

private AttributeHandle dimensionsHandle

The handle of the dimensions attribute.

dimensionsIsValid

private boolean dimensionsIsValid

Whether or not the dimensions attribute has been set.

dimensionsIsDirty

private boolean dimensionsIsDirty

Whether or not the dimensions attribute has changed.

dimensions

private java.lang.String dimensions

The dimensions of the interaction.

transportationHandle

private AttributeHandle transportationHandle

The handle of the transportation attribute.

transportationIsValid

private boolean transportationIsValid

Whether or not the transportation attribute has been set.

transportationIsDirty

private boolean transportationIsDirty

Whether or not the transportation attribute has changed.

transportation

private java.lang.String transportation

The transportation of the interaction.

orderHandle

private AttributeHandle orderHandle

The handle of the order attribute.

orderIsValid

private boolean orderIsValid

Whether or not the order attribute has been set.

orderIsDirty

private boolean orderIsDirty

Whether or not the order attribute has changed.

order

private HLAorderType order

The order of the interaction.

parametersHandle

private AttributeHandle parametersHandle

The handle of the parameters attribute.

parametersIsValid

private boolean parametersIsValid

Whether or not the parameters attribute has been set.

parametersIsDirty

private boolean parametersIsDirty

Whether or not the parameters attribute has changed.

parameters

private long[] parameters

The handles of the interaction parameters.

semanticsHandle

private AttributeHandle semanticsHandle

The handle of the semantics attribute.

semanticsIsValid

private boolean semanticsIsValid

Whether or not the semantics attribute has been set.

semanticsIsDirty

private boolean semanticsIsDirty

Whether or not the semantics attribute has changed.

semantics

private java.lang.String semantics

The semantics of the interaction.

Constructor Detail

HLAinteractionClassProxy

protected HLAinteractionClassProxy(RTIambassador pRTIAmbassador,
                                   ObjectInstanceHandle pInstanceHandle,
                                   ObjectClassHandle pClassHandle,
                                   java.lang.String pName)
                            throws RTIinternalError

Constructor for object instance proxies created in response to discovered objects.

Parameters:

pRTIAmbassador - the run-time infrastructure ambassador

pInstanceHandle - the object instance handle

pClassHandle - the object class handle

pName - the object name

Throws:

RTIinternalError - if an internal error occurred in the run-time infrastructure

HLAinteractionClassProxy

protected HLAinteractionClassProxy(RTIambassador pRTIAmbassador,
                                   ObjectClassHandle pClassHandle)
                            throws ObjectClassNotDefined,
                                   ObjectClassNotPublished,
                                   FederateNotExecutionMember,
                                   SaveInProgress,
                                   RestoreInProgress,
                                   RTIinternalError

Constructor for object instance proxies created to represent new locally owned objects. Automatically notifies the run-time infrastructure.

Parameters:

pRTIAmbassador - the run-time infrastructure ambassador

pClassHandle - the object class handle

Throws:

ObjectClassNotDefined - if the specified object class is not defined

ObjectClassNotPublished - if the specified object class is not published

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

HLAinteractionClassProxy

protected HLAinteractionClassProxy(RTIambassador pRTIAmbassador,
                                   ObjectClassHandle pClassHandle,
                                   java.lang.String pName)
                            throws ObjectClassNotDefined,
                                   ObjectClassNotPublished,
                                   IllegalName,
                                   ObjectInstanceNameInUse,
                                   FederateNotExecutionMember,
                                   SaveInProgress,
                                   RestoreInProgress,
                                   RTIinternalError

Constructor for object instance proxies created to represent new locally owned objects. Automatically notifies the run-time infrastructure.

Parameters:

pRTIAmbassador - the run-time infrastructure ambassador

pClassHandle - the object class handle

pName - the object name

Throws:

ObjectClassNotDefined - if the specified object class is not defined

ObjectClassNotPublished - if the specified object class is not published

IllegalName - if the instance name has is illegal

ObjectInstanceNameInUse - if the instance name is already in use

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

Method Detail

initializeAttributes

private void initializeAttributes()
                           throws InvalidObjectClassHandle,
                                  NameNotFound,
                                  ObjectClassNotDefined,
                                  AttributeNotDefined,
                                  FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Initializes the attributes and their handles.

Throws:

InvalidObjectClassHandle - if an object class handle is invalid

NameNotFound - if a name is not found

ObjectClassNotDefined - if an object class is not defined

AttributeNotDefined - if an attribute is not defined

FederateNotExecutionMember - if the federate is not an execution member

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

reflectAttributeValues

public void reflectAttributeValues(AttributeHandleValueMap theAttributes,
                                   byte[] userSuppliedTag,
                                   OrderType sentOrdering,
                                   TransportationType theTransport)
                            throws AttributeNotRecognized,
                                   AttributeNotSubscribed,
                                   FederateInternalError

Notifies the proxy of changes to the state of an object instance.

Overrides:

reflectAttributeValues in class HLAreflectionProxy

Parameters:

theAttributes - the map between attribute handles and the new values of the identified attributes

userSuppliedTag - a user-supplied tag associated with the state change

sentOrdering - the type of ordering with which the update was sent

theTransport - the type of transport associated with the update

Throws:

AttributeNotRecognized - if the attribute was not recognized

AttributeNotSubscribed - if the federate had not subscribed to the attribute

FederateInternalError - if an error occurs in the federate

provideAttributeValueUpdate

public void provideAttributeValueUpdate(AttributeHandleSet theAttributes,
                                        byte[] userSuppliedTag)
                                 throws AttributeNotRecognized,
                                        AttributeNotOwned,
                                        FederateInternalError

Notifies the proxy that it should provide an update regarding a set of object attributes.

Overrides:

provideAttributeValueUpdate in class HLAreflectionProxy

Parameters:

theAttributes - the set of attribute handles identifying the attributes that should be sent

userSuppliedTag - the user-supplied tag associated with the request

Throws:

AttributeNotRecognized - if an identified attribute was not recognized

AttributeNotOwned - if the federate did not own a specified attribute

FederateInternalError - if an error occurs in the federate

getAttributeValuesToFlush

protected void getAttributeValuesToFlush(AttributeHandleValueMap ahvm,
                                         boolean superFlush)
                                  throws RTIinternalError

Places the attribute values to flush into the specified map.

Overrides:

getAttributeValuesToFlush in class HLAreflectionProxy

Parameters:

ahvm - the attribute handle value map to populate

superFlush - if true provide updates for all attributes; if false, only provide updates for the modified ones

Throws:

RTIinternalError - if an internal error occurs in the run-time infrastructure

addHLAinteractionClassListener

public void addHLAinteractionClassListener(HLAinteractionClassListener l)

Adds a listener for attributes associated with the HLAinteractionClass class.

Specified by:

addHLAinteractionClassListener in interface HLAinteractionClass

Parameters:

l - the listener to remove

removeHLAinteractionClassListener

public void removeHLAinteractionClassListener(HLAinteractionClassListener l)

Removes a listener for attributes associated with the HLAinteractionClass class.

Specified by:

removeHLAinteractionClassListener in interface HLAinteractionClass

Parameters:

l - the listener to remove

setParents

public void setParents(java.lang.String pParents,
                       byte[] userSuppliedTag)
                throws ObjectInstanceNotKnown,
                       AttributeNotDefined,
                       AttributeNotOwned,
                       FederateNotExecutionMember,
                       SaveInProgress,
                       RestoreInProgress,
                       RTIinternalError

Sets the value of the parents attribute.

Specified by:

setParents in interface HLAinteractionClass

Parameters:

pParents - the new attribute value

userSuppliedTag - a user-supplied tag to associate with the action

Throws:

ObjectInstanceNotKnown - if the object instance is unknown

AttributeNotDefined - if one of the attributes is undefined

AttributeNotOwned - if one of the attributes is not owned

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

getParents

public java.lang.String getParents()

Returns the value of the parents attribute.

Specified by:

getParents in interface HLAinteractionClass

Returns:

the current attribute value

setSharing

public void setSharing(HLAsharingType pSharing,
                       byte[] userSuppliedTag)
                throws ObjectInstanceNotKnown,
                       AttributeNotDefined,
                       AttributeNotOwned,
                       FederateNotExecutionMember,
                       SaveInProgress,
                       RestoreInProgress,
                       RTIinternalError

Sets the value of the sharing attribute.

Specified by:

setSharing in interface HLAinteractionClass

Parameters:

pSharing - the new attribute value

userSuppliedTag - a user-supplied tag to associate with the action

Throws:

ObjectInstanceNotKnown - if the object instance is unknown

AttributeNotDefined - if one of the attributes is undefined

AttributeNotOwned - if one of the attributes is not owned

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

getSharing

public HLAsharingType getSharing()

Returns the value of the sharing attribute.

Specified by:

getSharing in interface HLAinteractionClass

Returns:

the current attribute value

setDimensions

public void setDimensions(java.lang.String pDimensions,
                          byte[] userSuppliedTag)
                   throws ObjectInstanceNotKnown,
                          AttributeNotDefined,
                          AttributeNotOwned,
                          FederateNotExecutionMember,
                          SaveInProgress,
                          RestoreInProgress,
                          RTIinternalError

Sets the value of the dimensions attribute.

Specified by:

setDimensions in interface HLAinteractionClass

Parameters:

pDimensions - the new attribute value

userSuppliedTag - a user-supplied tag to associate with the action

Throws:

ObjectInstanceNotKnown - if the object instance is unknown

AttributeNotDefined - if one of the attributes is undefined

AttributeNotOwned - if one of the attributes is not owned

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

getDimensions

public java.lang.String getDimensions()

Returns the value of the dimensions attribute.

Specified by:

getDimensions in interface HLAinteractionClass

Returns:

the current attribute value

setTransportation

public void setTransportation(java.lang.String pTransportation,
                              byte[] userSuppliedTag)
                       throws ObjectInstanceNotKnown,
                              AttributeNotDefined,
                              AttributeNotOwned,
                              FederateNotExecutionMember,
                              SaveInProgress,
                              RestoreInProgress,
                              RTIinternalError

Sets the value of the transportation attribute.

Specified by:

setTransportation in interface HLAinteractionClass

Parameters:

pTransportation - the new attribute value

userSuppliedTag - a user-supplied tag to associate with the action

Throws:

ObjectInstanceNotKnown - if the object instance is unknown

AttributeNotDefined - if one of the attributes is undefined

AttributeNotOwned - if one of the attributes is not owned

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

getTransportation

public java.lang.String getTransportation()

Returns the value of the transportation attribute.

Specified by:

getTransportation in interface HLAinteractionClass

Returns:

the current attribute value

setOrder

public void setOrder(HLAorderType pOrder,
                     byte[] userSuppliedTag)
              throws ObjectInstanceNotKnown,
                     AttributeNotDefined,
                     AttributeNotOwned,
                     FederateNotExecutionMember,
                     SaveInProgress,
                     RestoreInProgress,
                     RTIinternalError

Sets the value of the order attribute.

Specified by:

setOrder in interface HLAinteractionClass

Parameters:

pOrder - the new attribute value

userSuppliedTag - a user-supplied tag to associate with the action

Throws:

ObjectInstanceNotKnown - if the object instance is unknown

AttributeNotDefined - if one of the attributes is undefined

AttributeNotOwned - if one of the attributes is not owned

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

getOrder

public HLAorderType getOrder()

Returns the value of the order attribute.

Specified by:

getOrder in interface HLAinteractionClass

Returns:

the current attribute value

setParameters

public void setParameters(long[] pParameters,
                          byte[] userSuppliedTag)
                   throws ObjectInstanceNotKnown,
                          AttributeNotDefined,
                          AttributeNotOwned,
                          FederateNotExecutionMember,
                          SaveInProgress,
                          RestoreInProgress,
                          RTIinternalError

Sets the value of the parameters attribute.

Specified by:

setParameters in interface HLAinteractionClass

Parameters:

pParameters - the new attribute value

userSuppliedTag - a user-supplied tag to associate with the action

Throws:

ObjectInstanceNotKnown - if the object instance is unknown

AttributeNotDefined - if one of the attributes is undefined

AttributeNotOwned - if one of the attributes is not owned

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

getParameters

public long[] getParameters()

Returns the value of the parameters attribute.

Specified by:

getParameters in interface HLAinteractionClass

Returns:

the current attribute value

setSemantics

public void setSemantics(java.lang.String pSemantics,
                         byte[] userSuppliedTag)
                  throws ObjectInstanceNotKnown,
                         AttributeNotDefined,
                         AttributeNotOwned,
                         FederateNotExecutionMember,
                         SaveInProgress,
                         RestoreInProgress,
                         RTIinternalError

Sets the value of the semantics attribute.

Specified by:

setSemantics in interface HLAinteractionClass

Parameters:

pSemantics - the new attribute value

userSuppliedTag - a user-supplied tag to associate with the action

Throws:

ObjectInstanceNotKnown - if the object instance is unknown

AttributeNotDefined - if one of the attributes is undefined

AttributeNotOwned - if one of the attributes is not owned

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

getSemantics

public java.lang.String getSemantics()

Returns the value of the semantics attribute.

Specified by:

getSemantics in interface HLAinteractionClass

Returns:

the current attribute value