org.npsnet.xrti.proxies
Class HLAenumeratedDataTypeProxy

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

All Implemented Interfaces:

HLAdataType, HLAenumeratedDataType, HLAobjectRoot, HLAreflection

public class HLAenumeratedDataTypeProxy

extends HLAdataTypeProxy

implements HLAenumeratedDataType

Represents an HLA enumerated data type.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Field Summary

private HLAenumerator[]	enumerators The enumerators of the enumerated type.
private AttributeHandle	enumeratorsHandle The handle of the enumerators attribute.
private boolean	enumeratorsIsDirty Whether or not the enumerators attribute has changed.
private boolean	enumeratorsIsValid Whether or not the enumerators attribute has been set.
private java.util.Vector	HLAenumeratedDataTypeListeners Listeners for attributes associated with the HLAenumeratedDataType class.
private java.lang.String	representation The representation of the enumerated type.
private AttributeHandle	representationHandle The handle of the representation attribute.
private boolean	representationIsDirty Whether or not the representation attribute has changed.
private boolean	representationIsValid Whether or not the representation attribute has been set.
private java.lang.String	semantics The semantics of the enumerated type.
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.

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

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	HLAenumeratedDataTypeProxy(RTIambassador pRTIAmbassador, ObjectClassHandle pClassHandle) Constructor for object instance proxies created to represent new locally owned objects.
protected	HLAenumeratedDataTypeProxy(RTIambassador pRTIAmbassador, ObjectClassHandle pClassHandle, java.lang.String pName) Constructor for object instance proxies created to represent new locally owned objects.
protected	HLAenumeratedDataTypeProxy(RTIambassador pRTIAmbassador, ObjectInstanceHandle pInstanceHandle, ObjectClassHandle pClassHandle, java.lang.String pName) Constructor for object instance proxies created in response to discovered objects.

Method Summary

void	addHLAenumeratedDataTypeListener(HLAenumeratedDataTypeListener l) Adds a listener for attributes associated with the HLAenumeratedDataType class.
protected void	getAttributeValuesToFlush(AttributeHandleValueMap ahvm, boolean superFlush) Places the attribute values to flush into the specified map.
HLAenumerator[]	getEnumerators() Returns the value of the enumerators attribute.
java.lang.String	getRepresentation() Returns the value of the representation attribute.
java.lang.String	getSemantics() Returns the value of the semantics 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	removeHLAenumeratedDataTypeListener(HLAenumeratedDataTypeListener l) Removes a listener for attributes associated with the HLAenumeratedDataType class.
void	setEnumerators(HLAenumerator[] pEnumerators, byte[] userSuppliedTag) Sets the value of the enumerators attribute.
void	setRepresentation(java.lang.String pRepresentation, byte[] userSuppliedTag) Sets the value of the representation attribute.
void	setSemantics(java.lang.String pSemantics, byte[] userSuppliedTag) Sets the value of the semantics attribute.

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

addHLAdataTypeListener, removeHLAdataTypeListener

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.HLAdataType

addHLAdataTypeListener, removeHLAdataTypeListener

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

HLAenumeratedDataTypeListeners

private java.util.Vector HLAenumeratedDataTypeListeners

Listeners for attributes associated with the HLAenumeratedDataType class.

representationHandle

private AttributeHandle representationHandle

The handle of the representation attribute.

representationIsValid

private boolean representationIsValid

Whether or not the representation attribute has been set.

representationIsDirty

private boolean representationIsDirty

Whether or not the representation attribute has changed.

representation

private java.lang.String representation

The representation of the enumerated type.

enumeratorsHandle

private AttributeHandle enumeratorsHandle

The handle of the enumerators attribute.

enumeratorsIsValid

private boolean enumeratorsIsValid

Whether or not the enumerators attribute has been set.

enumeratorsIsDirty

private boolean enumeratorsIsDirty

Whether or not the enumerators attribute has changed.

enumerators

private HLAenumerator[] enumerators

The enumerators of the enumerated type.

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 enumerated type.

Constructor Detail

HLAenumeratedDataTypeProxy

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

HLAenumeratedDataTypeProxy

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

HLAenumeratedDataTypeProxy

protected HLAenumeratedDataTypeProxy(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 HLAdataTypeProxy

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 HLAdataTypeProxy

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 HLAdataTypeProxy

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

addHLAenumeratedDataTypeListener

public void addHLAenumeratedDataTypeListener(HLAenumeratedDataTypeListener l)

Adds a listener for attributes associated with the HLAenumeratedDataType class.

Specified by:

addHLAenumeratedDataTypeListener in interface HLAenumeratedDataType

Parameters:

l - the listener to remove

removeHLAenumeratedDataTypeListener

public void removeHLAenumeratedDataTypeListener(HLAenumeratedDataTypeListener l)

Removes a listener for attributes associated with the HLAenumeratedDataType class.

Specified by:

removeHLAenumeratedDataTypeListener in interface HLAenumeratedDataType

Parameters:

l - the listener to remove

setRepresentation

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

Sets the value of the representation attribute.

Specified by:

setRepresentation in interface HLAenumeratedDataType

Parameters:

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

getRepresentation

public java.lang.String getRepresentation()

Returns the value of the representation attribute.

Specified by:

getRepresentation in interface HLAenumeratedDataType

Returns:

the current attribute value

setEnumerators

public void setEnumerators(HLAenumerator[] pEnumerators,
                           byte[] userSuppliedTag)
                    throws ObjectInstanceNotKnown,
                           AttributeNotDefined,
                           AttributeNotOwned,
                           FederateNotExecutionMember,
                           SaveInProgress,
                           RestoreInProgress,
                           RTIinternalError

Sets the value of the enumerators attribute.

Specified by:

setEnumerators in interface HLAenumeratedDataType

Parameters:

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

getEnumerators

public HLAenumerator[] getEnumerators()

Returns the value of the enumerators attribute.

Specified by:

getEnumerators in interface HLAenumeratedDataType

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 HLAenumeratedDataType

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 HLAenumeratedDataType

Returns:

the current attribute value