org.npsnet.xrti.proxies
Class HLAsynchronizationProxy

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

All Implemented Interfaces:

HLAobjectRoot, HLAreflection, HLAsynchronization

public class HLAsynchronizationProxy

extends HLAreflectionProxy

implements HLAsynchronization

Represents an HLA synchronization.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Field Summary

private HLAcapabilityType	capability The capability of the synchronization.
private AttributeHandle	capabilityHandle The handle of the capability attribute.
private boolean	capabilityIsDirty Whether or not the capability attribute has changed.
private boolean	capabilityIsValid Whether or not the capability attribute has been set.
private java.lang.String	dataType The data type of the synchronization.
private AttributeHandle	dataTypeHandle The handle of the dataType attribute.
private boolean	dataTypeIsDirty Whether or not the dataType attribute has changed.
private boolean	dataTypeIsValid Whether or not the dataType attribute has been set.
private java.util.Vector	HLAsynchronizationListeners Listeners for attributes associated with the HLAsynchronization class.
private java.lang.String	label The label of the synchronization.
private AttributeHandle	labelHandle The handle of the label attribute.
private boolean	labelIsDirty Whether or not the label attribute has changed.
private boolean	labelIsValid Whether or not the label attribute has been set.
private java.lang.String	semantics The semantics of the synchronization.
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.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	HLAsynchronizationProxy(RTIambassador pRTIAmbassador, ObjectClassHandle pClassHandle) Constructor for object instance proxies created to represent new locally owned objects.
protected	HLAsynchronizationProxy(RTIambassador pRTIAmbassador, ObjectClassHandle pClassHandle, java.lang.String pName) Constructor for object instance proxies created to represent new locally owned objects.
protected	HLAsynchronizationProxy(RTIambassador pRTIAmbassador, ObjectInstanceHandle pInstanceHandle, ObjectClassHandle pClassHandle, java.lang.String pName) Constructor for object instance proxies created in response to discovered objects.

Method Summary

void	addHLAsynchronizationListener(HLAsynchronizationListener l) Adds a listener for attributes associated with the HLAsynchronization class.
protected void	getAttributeValuesToFlush(AttributeHandleValueMap ahvm, boolean superFlush) Places the attribute values to flush into the specified map.
HLAcapabilityType	getCapability() Returns the value of the capability attribute.
java.lang.String	getDataType() Returns the value of the dataType attribute.
java.lang.String	getLabel() Returns the value of the label 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	removeHLAsynchronizationListener(HLAsynchronizationListener l) Removes a listener for attributes associated with the HLAsynchronization class.
void	setCapability(HLAcapabilityType pCapability, byte[] userSuppliedTag) Sets the value of the capability attribute.
void	setDataType(java.lang.String pDataType, byte[] userSuppliedTag) Sets the value of the dataType attribute.
void	setLabel(java.lang.String pLabel, byte[] userSuppliedTag) Sets the value of the label attribute.
void	setSemantics(java.lang.String pSemantics, byte[] userSuppliedTag) Sets the value of the semantics 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

HLAsynchronizationListeners

private java.util.Vector HLAsynchronizationListeners

Listeners for attributes associated with the HLAsynchronization class.

labelHandle

private AttributeHandle labelHandle

The handle of the label attribute.

labelIsValid

private boolean labelIsValid

Whether or not the label attribute has been set.

labelIsDirty

private boolean labelIsDirty

Whether or not the label attribute has changed.

label

private java.lang.String label

The label of the synchronization.

dataTypeHandle

private AttributeHandle dataTypeHandle

The handle of the dataType attribute.

dataTypeIsValid

private boolean dataTypeIsValid

Whether or not the dataType attribute has been set.

dataTypeIsDirty

private boolean dataTypeIsDirty

Whether or not the dataType attribute has changed.

dataType

private java.lang.String dataType

The data type of the synchronization.

capabilityHandle

private AttributeHandle capabilityHandle

The handle of the capability attribute.

capabilityIsValid

private boolean capabilityIsValid

Whether or not the capability attribute has been set.

capabilityIsDirty

private boolean capabilityIsDirty

Whether or not the capability attribute has changed.

capability

private HLAcapabilityType capability

The capability of the synchronization.

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

Constructor Detail

HLAsynchronizationProxy

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

HLAsynchronizationProxy

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

HLAsynchronizationProxy

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

addHLAsynchronizationListener

public void addHLAsynchronizationListener(HLAsynchronizationListener l)

Adds a listener for attributes associated with the HLAsynchronization class.

Specified by:

addHLAsynchronizationListener in interface HLAsynchronization

Parameters:

l - the listener to remove

removeHLAsynchronizationListener

public void removeHLAsynchronizationListener(HLAsynchronizationListener l)

Removes a listener for attributes associated with the HLAsynchronization class.

Specified by:

removeHLAsynchronizationListener in interface HLAsynchronization

Parameters:

l - the listener to remove

setLabel

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

Sets the value of the label attribute.

Specified by:

setLabel in interface HLAsynchronization

Parameters:

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

getLabel

public java.lang.String getLabel()

Returns the value of the label attribute.

Specified by:

getLabel in interface HLAsynchronization

Returns:

the current attribute value

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 HLAsynchronization

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 HLAsynchronization

Returns:

the current attribute value

setCapability

public void setCapability(HLAcapabilityType pCapability,
                          byte[] userSuppliedTag)
                   throws ObjectInstanceNotKnown,
                          AttributeNotDefined,
                          AttributeNotOwned,
                          FederateNotExecutionMember,
                          SaveInProgress,
                          RestoreInProgress,
                          RTIinternalError

Sets the value of the capability attribute.

Specified by:

setCapability in interface HLAsynchronization

Parameters:

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

getCapability

public HLAcapabilityType getCapability()

Returns the value of the capability attribute.

Specified by:

getCapability in interface HLAsynchronization

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 HLAsynchronization

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 HLAsynchronization

Returns:

the current attribute value