org.npsnet.xrti.proxies
Interface HLAfederation

All Superinterfaces:

HLAmanager, HLAobjectRoot

All Known Implementing Classes:

HLAfederationProxy

public interface HLAfederation

extends HLAmanager

Autogenerated object instance interface.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Method Summary

void	addHLAfederationListener(HLAfederationListener l) Adds a listener for the attributes associated with the HLAfederation class.
HLAswitch	getHLAautoProvide() Returns the value of the HLAautoProvide attribute.
HLAswitch	getHLAconveyRegionDesignatorSets() Returns the value of the HLAconveyRegionDesignatorSets attribute.
java.lang.String	getHLAFDDID() Returns the value of the HLAFDDID attribute.
byte[][]	getHLAfederatesinFederation() Returns the value of the HLAfederatesinFederation attribute.
java.lang.String	getHLAfederationName() Returns the value of the HLAfederationName attribute.
java.lang.String	getHLAlastSaveName() Returns the value of the HLAlastSaveName attribute.
byte[]	getHLAlastSaveTime() Returns the value of the HLAlastSaveTime attribute.
java.lang.String	getHLAnextSaveName() Returns the value of the HLAnextSaveName attribute.
byte[]	getHLAnextSaveTime() Returns the value of the HLAnextSaveTime attribute.
java.lang.String	getHLARTIversion() Returns the value of the HLARTIversion attribute.
void	removeHLAfederationListener(HLAfederationListener l) Removes a listener for the attributes associated with the HLAfederation class.
void	setHLAautoProvide(HLAswitch pHLAautoProvide, byte[] userSuppliedTag) Sets the value of the HLAautoProvide attribute.
void	setHLAconveyRegionDesignatorSets(HLAswitch pHLAconveyRegionDesignatorSets, byte[] userSuppliedTag) Sets the value of the HLAconveyRegionDesignatorSets attribute.
void	setHLAFDDID(java.lang.String pHLAFDDID, byte[] userSuppliedTag) Sets the value of the HLAFDDID attribute.
void	setHLAfederatesinFederation(byte[][] pHLAfederatesinFederation, byte[] userSuppliedTag) Sets the value of the HLAfederatesinFederation attribute.
void	setHLAfederationName(java.lang.String pHLAfederationName, byte[] userSuppliedTag) Sets the value of the HLAfederationName attribute.
void	setHLAlastSaveName(java.lang.String pHLAlastSaveName, byte[] userSuppliedTag) Sets the value of the HLAlastSaveName attribute.
void	setHLAlastSaveTime(byte[] pHLAlastSaveTime, byte[] userSuppliedTag) Sets the value of the HLAlastSaveTime attribute.
void	setHLAnextSaveName(java.lang.String pHLAnextSaveName, byte[] userSuppliedTag) Sets the value of the HLAnextSaveName attribute.
void	setHLAnextSaveTime(byte[] pHLAnextSaveTime, byte[] userSuppliedTag) Sets the value of the HLAnextSaveTime attribute.
void	setHLARTIversion(java.lang.String pHLARTIversion, byte[] userSuppliedTag) Sets the value of the HLARTIversion attribute.

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

addHLAmanagerListener, removeHLAmanagerListener

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

addHLAobjectRootListener, removeHLAobjectRootListener

Method Detail

addHLAfederationListener

public void addHLAfederationListener(HLAfederationListener l)

Adds a listener for the attributes associated with the HLAfederation class.

Parameters:

l - the listener to add

removeHLAfederationListener

public void removeHLAfederationListener(HLAfederationListener l)

Removes a listener for the attributes associated with the HLAfederation class.

Parameters:

l - the listener to remove

setHLAfederationName

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

Sets the value of the HLAfederationName attribute.

Parameters:

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

getHLAfederationName

public java.lang.String getHLAfederationName()

Returns the value of the HLAfederationName attribute.

Returns:

the current attribute value

setHLAfederatesinFederation

public void setHLAfederatesinFederation(byte[][] pHLAfederatesinFederation,
                                        byte[] userSuppliedTag)
                                 throws ObjectInstanceNotKnown,
                                        AttributeNotDefined,
                                        AttributeNotOwned,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Sets the value of the HLAfederatesinFederation attribute.

Parameters:

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

getHLAfederatesinFederation

public byte[][] getHLAfederatesinFederation()

Returns the value of the HLAfederatesinFederation attribute.

Returns:

the current attribute value

setHLARTIversion

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

Sets the value of the HLARTIversion attribute.

Parameters:

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

getHLARTIversion

public java.lang.String getHLARTIversion()

Returns the value of the HLARTIversion attribute.

Returns:

the current attribute value

setHLAFDDID

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

Sets the value of the HLAFDDID attribute.

Parameters:

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

getHLAFDDID

public java.lang.String getHLAFDDID()

Returns the value of the HLAFDDID attribute.

Returns:

the current attribute value

setHLAlastSaveName

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

Sets the value of the HLAlastSaveName attribute.

Parameters:

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

getHLAlastSaveName

public java.lang.String getHLAlastSaveName()

Returns the value of the HLAlastSaveName attribute.

Returns:

the current attribute value

setHLAlastSaveTime

public void setHLAlastSaveTime(byte[] pHLAlastSaveTime,
                               byte[] userSuppliedTag)
                        throws ObjectInstanceNotKnown,
                               AttributeNotDefined,
                               AttributeNotOwned,
                               FederateNotExecutionMember,
                               SaveInProgress,
                               RestoreInProgress,
                               RTIinternalError

Sets the value of the HLAlastSaveTime attribute.

Parameters:

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

getHLAlastSaveTime

public byte[] getHLAlastSaveTime()

Returns the value of the HLAlastSaveTime attribute.

Returns:

the current attribute value

setHLAnextSaveName

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

Sets the value of the HLAnextSaveName attribute.

Parameters:

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

getHLAnextSaveName

public java.lang.String getHLAnextSaveName()

Returns the value of the HLAnextSaveName attribute.

Returns:

the current attribute value

setHLAnextSaveTime

public void setHLAnextSaveTime(byte[] pHLAnextSaveTime,
                               byte[] userSuppliedTag)
                        throws ObjectInstanceNotKnown,
                               AttributeNotDefined,
                               AttributeNotOwned,
                               FederateNotExecutionMember,
                               SaveInProgress,
                               RestoreInProgress,
                               RTIinternalError

Sets the value of the HLAnextSaveTime attribute.

Parameters:

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

getHLAnextSaveTime

public byte[] getHLAnextSaveTime()

Returns the value of the HLAnextSaveTime attribute.

Returns:

the current attribute value

setHLAautoProvide

public void setHLAautoProvide(HLAswitch pHLAautoProvide,
                              byte[] userSuppliedTag)
                       throws ObjectInstanceNotKnown,
                              AttributeNotDefined,
                              AttributeNotOwned,
                              FederateNotExecutionMember,
                              SaveInProgress,
                              RestoreInProgress,
                              RTIinternalError

Sets the value of the HLAautoProvide attribute.

Parameters:

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

getHLAautoProvide

public HLAswitch getHLAautoProvide()

Returns the value of the HLAautoProvide attribute.

Returns:

the current attribute value

setHLAconveyRegionDesignatorSets

public void setHLAconveyRegionDesignatorSets(HLAswitch pHLAconveyRegionDesignatorSets,
                                             byte[] userSuppliedTag)
                                      throws ObjectInstanceNotKnown,
                                             AttributeNotDefined,
                                             AttributeNotOwned,
                                             FederateNotExecutionMember,
                                             SaveInProgress,
                                             RestoreInProgress,
                                             RTIinternalError

Sets the value of the HLAconveyRegionDesignatorSets attribute.

Parameters:

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

getHLAconveyRegionDesignatorSets

public HLAswitch getHLAconveyRegionDesignatorSets()

Returns the value of the HLAconveyRegionDesignatorSets attribute.

Returns:

the current attribute value