|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.npsnet.xrti.XRTIAmbassador
org.npsnet.xrti.FederationExecutionAmbassador
A special version of the XRTIAmbassador that the
XRTIExecutive uses to address federation
executions.
| Field Summary |
| Constructor Summary | |
protected |
FederationExecutionAmbassador(org.npsnet.xrti.XRTIExecutive pExecutive,
HLAfederationExecutionProxy pExecutionProxy,
java.lang.String pExecutionName,
long pExecutionHandle)
Constructor. |
| Method Summary | |
protected boolean |
allZeroLookaheadFederatesRestricted(ExecutiveClientAmbassador eca)
Returns true if all zero lookahead federates in current federation execution are subject of zero lookahead restriction, false otherwise. |
void |
createReflectionObjects(org.w3c.dom.Document fdd)
Creates reflection objects corresponding to the elements of the specifed federation description document. |
void |
deleteObjectInstance(ExecutiveClientAmbassador eca,
ObjectInstanceHandle oih,
byte[] userSuppliedTag)
Deletes the object instance with the specified handle. |
void |
deregisterExecutiveClientAmbassador(ExecutiveClientAmbassador eca)
Removes an executive client ambassador from this federation execution. |
HLAfederationExecutionProxy |
getExecutionProxy()
Returns a reference to the federation execution proxy in the meta-federation. |
protected java.util.Vector |
getExecutiveClientAmbassadors()
Returns the list of registered executive client ambassadors. |
protected void |
handleTimeRequest(ExecutiveClientAmbassador eca)
Handles time request received from a federate. |
boolean |
hasExecutiveClientAmbassadors()
Checks whether or not this federation execution has any executive client ambassadors registered. |
void |
publishInteractionClass(InteractionClassHandle theInteraction)
Publishes the specified interaction class. |
void |
publishObjectClassAttributes(ObjectClassHandle theClass,
AttributeHandleSet attributeList)
Publishes the specified object class attributes. |
void |
registerExecutiveClientAmbassador(ExecutiveClientAmbassador eca)
Adds an executive client ambassador to this federation execution. |
boolean |
registerFederationSynchronizationPoint(ExecutiveClientAmbassador eca,
java.lang.String synchronizationPointLabel,
byte[] userSuppliedTag,
FederateHandleSet synchronizationSet)
Registers a federation synchronization point. |
void |
registerObjectInstance(ExecutiveClientAmbassador eca,
ObjectInstanceDescriptor oid,
byte[] userSuppliedTag)
Registers an object instance created by a federate. |
void |
registerObjectInstances(ExecutiveClientAmbassador eca,
ObjectClassHandle och)
Registers all instances of a particular class. |
void |
requestAttributeValueUpdate(ObjectInstanceHandle theObject,
AttributeHandleSet theAttributes,
byte[] userSuppliedTag)
Requests an attribute value update. |
void |
sendInteraction(ExecutiveClientAmbassador eca,
InteractionClassHandle theInteraction,
ParameterHandleValueMap theParameters,
byte[] userSuppliedTag,
TransportationType theTransport,
OrderType sentOrdering,
LogicalTime theTime)
Sends an interaction received from a federate. |
void |
sendInteraction(InteractionClassHandle theInteraction,
ParameterHandleValueMap theParameters,
byte[] userSuppliedTag)
Sends an interaction. |
void |
subscribeInteractionClass(InteractionClassHandle theClass)
Subscribes to the specified interaction class. |
void |
subscribeObjectClassAttributes(ObjectClassHandle theClass,
AttributeHandleSet attributeList)
Subscribes to a set of object class attributes. |
void |
synchronizationPointAchieved(ExecutiveClientAmbassador eca,
java.lang.String synchronizationPointLabel)
Notifies the run-time infrastructure that a synchronization point has been achieved. |
java.lang.String |
toString()
Returns a string representation of the FederationExecutionAmbassador. |
void |
updateAttributeValuesBestEffort(ExecutiveClientAmbassador eca,
XRTIObjectInstanceHandle xoih,
HLAattributeHandleValuePair[] attributeHandleValuePairList,
byte[] userSuppliedTag)
Updates a set of attributes with best-effort transportation. |
void |
updateAttributeValuesReliable(ExecutiveClientAmbassador eca,
XRTIObjectInstanceHandle xoih,
HLAattributeHandleValuePair[] attributeHandleValuePairList,
byte[] userSuppliedTag)
Updates a set of attributes with reliable transportation. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
protected FederationExecutionAmbassador(org.npsnet.xrti.XRTIExecutive pExecutive,
HLAfederationExecutionProxy pExecutionProxy,
java.lang.String pExecutionName,
long pExecutionHandle)
pExecutive - the owning XRTIExecutivepExecutionProxy - the federation execution proxy in the meta-federation (or
null for none)pExecutionName - the name of the federation executionpExecutionHandle - the handle of the federation execution| Method Detail |
public HLAfederationExecutionProxy getExecutionProxy()
null
for nonepublic void registerExecutiveClientAmbassador(ExecutiveClientAmbassador eca)
eca - the executive client ambassador to register
public void registerObjectInstances(ExecutiveClientAmbassador eca,
ObjectClassHandle och)
eca - the executive client ambassador to register the instances withoch - the handle of the class of objects to registerpublic void deregisterExecutiveClientAmbassador(ExecutiveClientAmbassador eca)
eca - the executive client ambassador to deregisterpublic boolean hasExecutiveClientAmbassadors()
true if there are executive client ambassadors
registered, false otherwise
public void createReflectionObjects(org.w3c.dom.Document fdd)
throws RTIexception
fdd - the federation description document to read
RTIexception
public void registerObjectInstance(ExecutiveClientAmbassador eca,
ObjectInstanceDescriptor oid,
byte[] userSuppliedTag)
eca - the executive client ambassador of the creating federateoid - the object instance descriptor describing the objectuserSuppliedTag - the user-supplied tag associated with the event
public void deleteObjectInstance(ExecutiveClientAmbassador eca,
ObjectInstanceHandle oih,
byte[] userSuppliedTag)
eca - the executive client ambassador of the deleting federateoih - the object instance handleuserSuppliedTag - the user-supplied tag associated with the event
public void updateAttributeValuesBestEffort(ExecutiveClientAmbassador eca,
XRTIObjectInstanceHandle xoih,
HLAattributeHandleValuePair[] attributeHandleValuePairList,
byte[] userSuppliedTag)
eca - the executive client ambassador of the sending federatexoih - the object instance handle of the object being updatedattributeHandleValuePairList - the attribute handle/value pairsuserSuppliedTag - the user-supplied tag associated with the event
public void updateAttributeValuesReliable(ExecutiveClientAmbassador eca,
XRTIObjectInstanceHandle xoih,
HLAattributeHandleValuePair[] attributeHandleValuePairList,
byte[] userSuppliedTag)
eca - the executive client ambassador of the sending federatexoih - the object instance handle of the object being updatedattributeHandleValuePairList - the attribute handle/value pairsuserSuppliedTag - the user-supplied tag associated with the event
public void publishObjectClassAttributes(ObjectClassHandle theClass,
AttributeHandleSet attributeList)
throws ObjectClassNotDefined,
AttributeNotDefined,
FederateNotExecutionMember,
SaveInProgress,
RestoreInProgress,
RTIinternalError
publishObjectClassAttributes in interface RTIambassadorpublishObjectClassAttributes in class XRTIAmbassadortheClass - the object class associated with the attributes to be
publishedattributeList - the list of attributes to publish
ObjectClassNotDefined - if the specified object class is not defined
AttributeNotDefined - if one of the specified attributes is not defined
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
public void publishInteractionClass(InteractionClassHandle theInteraction)
throws InteractionClassNotDefined,
FederateNotExecutionMember,
SaveInProgress,
RestoreInProgress,
RTIinternalError
publishInteractionClass in interface RTIambassadorpublishInteractionClass in class XRTIAmbassadortheInteraction - the interaction class to publish
InteractionClassNotDefined - if the specified interaction class is not defined
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
public void subscribeObjectClassAttributes(ObjectClassHandle theClass,
AttributeHandleSet attributeList)
throws ObjectClassNotDefined,
AttributeNotDefined,
FederateNotExecutionMember,
SaveInProgress,
RestoreInProgress,
RTIinternalError
subscribeObjectClassAttributes in interface RTIambassadorsubscribeObjectClassAttributes in class XRTIAmbassadortheClass - the object class associated with the attributes to subscribe toattributeList - the set of attributes to subscribe to
ObjectClassNotDefined - if the specified object class is not defined
AttributeNotDefined - if one of the specified attributes is not defined
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
public void subscribeInteractionClass(InteractionClassHandle theClass)
throws InteractionClassNotDefined,
FederateServiceInvocationsAreBeingReportedViaMOM,
FederateNotExecutionMember,
SaveInProgress,
RestoreInProgress,
RTIinternalError
subscribeInteractionClass in interface RTIambassadorsubscribeInteractionClass in class XRTIAmbassadortheClass - the interaction class to subscribe to
InteractionClassNotDefined - if the interaction class is not defined
FederateServiceInvocationsAreBeingReportedViaMOM - if federate service
invocations are being reported via the management object model
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
public void sendInteraction(InteractionClassHandle theInteraction,
ParameterHandleValueMap theParameters,
byte[] userSuppliedTag)
throws InteractionClassNotPublished,
InteractionClassNotDefined,
InteractionParameterNotDefined,
FederateNotExecutionMember,
SaveInProgress,
RestoreInProgress,
RTIinternalError
sendInteraction in interface RTIambassadorsendInteraction in class XRTIAmbassadortheInteraction - the class of interaction to sendtheParameters - the parameters of the interactionuserSuppliedTag - a user-supplied tag to associate with the interaction
InteractionClassNotPublished - if the interaction class is not published
InteractionClassNotDefined - if the interaction class is undefined
InteractionParameterNotDefined - if one of the parameters is undefined
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
public void sendInteraction(ExecutiveClientAmbassador eca,
InteractionClassHandle theInteraction,
ParameterHandleValueMap theParameters,
byte[] userSuppliedTag,
TransportationType theTransport,
OrderType sentOrdering,
LogicalTime theTime)
throws InteractionClassNotPublished,
InteractionClassNotDefined,
InteractionParameterNotDefined,
FederateNotExecutionMember,
SaveInProgress,
RestoreInProgress,
RTIinternalError
eca - the executive client ambassador of the connected federatetheInteraction - the interaction class handletheParameters - the parameters of the interactionuserSuppliedTag - the user-supplied tag associated with the eventtheTransport - the transportation type with which the interaction
was sentsentOrdering - the type of ordering with which the interaction was senttheTime - the logical time associated with the interaction
InteractionClassNotPublished
InteractionClassNotDefined
InteractionParameterNotDefined
FederateNotExecutionMember
SaveInProgress
RestoreInProgress
RTIinternalError
public void requestAttributeValueUpdate(ObjectInstanceHandle theObject,
AttributeHandleSet theAttributes,
byte[] userSuppliedTag)
throws ObjectInstanceNotKnown,
AttributeNotDefined,
FederateNotExecutionMember,
SaveInProgress,
RestoreInProgress,
RTIinternalError
requestAttributeValueUpdate in interface RTIambassadorrequestAttributeValueUpdate in class XRTIAmbassadortheObject - the object with which the attributes are associatedtheAttributes - the set of attributes to be updateduserSuppliedTag - a user-supplied tag to associated with the request
ObjectInstanceNotKnown - if the object instance is unknown
AttributeNotDefined - if one of the attributes is undefined
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 infrastructurepublic java.lang.String toString()
protected java.util.Vector getExecutiveClientAmbassadors()
protected boolean allZeroLookaheadFederatesRestricted(ExecutiveClientAmbassador eca)
eca - the executive client ambassador of the requesting federate
protected void handleTimeRequest(ExecutiveClientAmbassador eca)
throws FederateInternalError
eca - the executive client ambassador of the requesting federate
FederateInternalError
public boolean registerFederationSynchronizationPoint(ExecutiveClientAmbassador eca,
java.lang.String synchronizationPointLabel,
byte[] userSuppliedTag,
FederateHandleSet synchronizationSet)
eca - the executive client ambassadorsynchronizationPointLabel - the label of the synchronization pointuserSuppliedTag - a user-supplied tag to associate with the operationsynchronizationSet - the set of federates to synchronize
public void synchronizationPointAchieved(ExecutiveClientAmbassador eca,
java.lang.String synchronizationPointLabel)
eca - the executive client ambassadorsynchronizationPointLabel - the label of the synchronization point
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||