org.npsnet.xrti.proxies
Class HLAattributeProxy

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

All Implemented Interfaces:

HLAattribute, HLAobjectRoot, HLAreflection

public class HLAattributeProxy

extends HLAreflectionProxy

implements HLAattribute

Represents an HLA object attribute.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Field Summary

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

autoFlushDisabled, classHandle, deleted, instanceHandle, rtiAmbassador

Constructor Summary

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

Method Summary

void	addHLAattributeListener(HLAattributeListener l) Adds a listener for attributes associated with the HLAattribute class.
protected void	getAttributeValuesToFlush(AttributeHandleValueMap ahvm, boolean superFlush) Places the attribute values to flush into the specified map.
java.lang.String	getDataType() Returns the value of the dataType attribute.
java.lang.String	getDimensions() Returns the value of the dimensions attribute.
HLAorderType	getOrder() Returns the value of the order attribute.
HLAownershipType	getOwnership() Returns the value of the ownership 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.
java.lang.String	getUpdateCondition() Returns the value of the updateCondition attribute.
HLAupdateType	getUpdateType() Returns the value of the updateType attribute.
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	removeHLAattributeListener(HLAattributeListener l) Removes a listener for attributes associated with the HLAattribute class.
void	setDataType(java.lang.String pDataType, byte[] userSuppliedTag) Sets the value of the dataType attribute.
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	setOwnership(HLAownershipType pOwnership, byte[] userSuppliedTag) Sets the value of the ownership 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.
void	setUpdateCondition(java.lang.String pUpdateCondition, byte[] userSuppliedTag) Sets the value of the updateCondition attribute.
void	setUpdateType(HLAupdateType pUpdateType, byte[] userSuppliedTag) Sets the value of the updateType 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

Constructor Detail

HLAattributeProxy

protected HLAattributeProxy(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

HLAattributeProxy

protected HLAattributeProxy(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

HLAattributeProxy

protected HLAattributeProxy(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

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

addHLAattributeListener

public void addHLAattributeListener(HLAattributeListener l)

Adds a listener for attributes associated with the HLAattribute class.

Specified by:

addHLAattributeListener in interface HLAattribute

Parameters:

l - the listener to remove

removeHLAattributeListener

public void removeHLAattributeListener(HLAattributeListener l)

Removes a listener for attributes associated with the HLAattribute class.

Specified by:

removeHLAattributeListener in interface HLAattribute

Parameters:

l - the listener to remove

setDataType

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

Sets the value of the dataType attribute.

Specified by:

setDataType in interface HLAattribute

Parameters:

pDataType - 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

getDataType

public java.lang.String getDataType()

Returns the value of the dataType attribute.

Specified by:

getDataType in interface HLAattribute

Returns:

the current attribute value

setUpdateType

public void setUpdateType(HLAupdateType pUpdateType,
                          byte[] userSuppliedTag)
                   throws ObjectInstanceNotKnown,
                          AttributeNotDefined,
                          AttributeNotOwned,
                          FederateNotExecutionMember,
                          SaveInProgress,
                          RestoreInProgress,
                          RTIinternalError

Sets the value of the updateType attribute.

Specified by:

setUpdateType in interface HLAattribute

Parameters:

pUpdateType - 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

getUpdateType

public HLAupdateType getUpdateType()

Returns the value of the updateType attribute.

Specified by:

getUpdateType in interface HLAattribute

Returns:

the current attribute value

setUpdateCondition

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

Sets the value of the updateCondition attribute.

Specified by:

setUpdateCondition in interface HLAattribute

Parameters:

pUpdateCondition - 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

getUpdateCondition

public java.lang.String getUpdateCondition()

Returns the value of the updateCondition attribute.

Specified by:

getUpdateCondition in interface HLAattribute

Returns:

the current attribute value

setOwnership

public void setOwnership(HLAownershipType pOwnership,
                         byte[] userSuppliedTag)
                  throws ObjectInstanceNotKnown,
                         AttributeNotDefined,
                         AttributeNotOwned,
                         FederateNotExecutionMember,
                         SaveInProgress,
                         RestoreInProgress,
                         RTIinternalError

Sets the value of the ownership attribute.

Specified by:

setOwnership in interface HLAattribute

Parameters:

pOwnership - 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

getOwnership

public HLAownershipType getOwnership()

Returns the value of the ownership attribute.

Specified by:

getOwnership in interface HLAattribute

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 HLAattribute

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 HLAattribute

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 HLAattribute

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 HLAattribute

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 HLAattribute

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 HLAattribute

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 HLAattribute

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 HLAattribute

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 HLAattribute

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 HLAattribute

Returns:

the current attribute value