MAK RTIspy API Documentation for HLA 1.3
Classes | Typedefs | Enumerations | Functions | Variables

The namespace defined by the HLA Evolved Interface Specification which holds the C++ API. More...

Classes

class  DataElement
class  EncoderException
class  HLAfixedArray
class  HLAfixedRecord
class  HLAopaqueData
class  HLAvariableArray
class  HLAvariantRecord
class  Exception
class  FederateAmbassador
 An abstract base class which must be implemented, and used by a federate. More...
class  LogicalTime
class  LogicalTimeFactory
class  HLAlogicalTimeFactoryFactory
class  LogicalTimeFactoryFactory
class  LogicalTimeInterval
class  NullFederateAmbassador
class  RangeBounds
class  RTIambassador
 A class provided by the HLA C++ Interface Specification which federates use to communicate with the RTI. More...
class  RTIambassadorFactory
 A simple class used to create an instance of an rti1516e::RTIambassador. More...
class  HLAfloat64Interval
class  HLAfloat64Time
class  HLAfloat64TimeFactory
class  HLAinteger64Interval
class  HLAinteger64Time
class  HLAinteger64TimeFactory
class  FederateRestoreStatus
class  FederationExecutionInformation
class  SupplementalReflectInfo
class  SupplementalReceiveInfo
class  SupplementalRemoveInfo
class  VariableLengthData

Typedefs

typedef char Integer8
typedef short Integer16
typedef int Integer32
typedef long long Integer64
typedef Integer8 Octet
typedef std::pair< Octet, OctetOctetPair
typedef std::set< AttributeHandleAttributeHandleSet
typedef std::set< ParameterHandleParameterHandleSet
typedef std::set< FederateHandleFederateHandleSet
typedef std::set< DimensionHandleDimensionHandleSet
typedef std::set< RegionHandle > RegionHandleSet
typedef std::map
< AttributeHandle,
VariableLengthData
AttributeHandleValueMap
typedef std::map
< ParameterHandle,
VariableLengthData
ParameterHandleValueMap
typedef std::pair
< AttributeHandleSet,
RegionHandleSet
AttributeHandleSetRegionHandleSetPair
typedef std::vector
< AttributeHandleSetRegionHandleSetPair
AttributeHandleSetRegionHandleSetPairVector
typedef std::pair
< FederateHandle, SaveStatus
FederateHandleSaveStatusPair
typedef std::vector
< FederateHandleSaveStatusPair
FederateHandleSaveStatusPairVector
typedef std::vector
< FederateRestoreStatus
FederateRestoreStatusVector
typedef std::vector
< FederationExecutionInformation
FederationExecutionInformationVector
typedef void(* VariableLengthDataDeleteFunction )(void *data)

Enumerations

enum  CallbackModel { HLA_IMMEDIATE, HLA_EVOKED }
enum  OrderType { RECEIVE = 1, TIMESTAMP = 2 }
enum  ResignAction {
  UNCONDITIONALLY_DIVEST_ATTRIBUTES, DELETE_OBJECTS, CANCEL_PENDING_OWNERSHIP_ACQUISITIONS, DELETE_OBJECTS_THEN_DIVEST,
  CANCEL_THEN_DELETE_THEN_DIVEST, NO_ACTION
}
enum  RestoreFailureReason {
  RTI_UNABLE_TO_RESTORE, FEDERATE_REPORTED_FAILURE_DURING_RESTORE, FEDERATE_RESIGNED_DURING_RESTORE, RTI_DETECTED_FAILURE_DURING_RESTORE,
  RESTORE_ABORTED
}
enum  RestoreStatus {
  NO_RESTORE_IN_PROGRESS, FEDERATE_RESTORE_REQUEST_PENDING, FEDERATE_WAITING_FOR_RESTORE_TO_BEGIN, FEDERATE_PREPARED_TO_RESTORE,
  FEDERATE_RESTORING, FEDERATE_WAITING_FOR_FEDERATION_TO_RESTORE
}
enum  SaveFailureReason {
  RTI_UNABLE_TO_SAVE, FEDERATE_REPORTED_FAILURE_DURING_SAVE, FEDERATE_RESIGNED_DURING_SAVE, RTI_DETECTED_FAILURE_DURING_SAVE,
  SAVE_TIME_CANNOT_BE_HONORED, SAVE_ABORTED
}
enum  SaveStatus { NO_SAVE_IN_PROGRESS, FEDERATE_INSTRUCTED_TO_SAVE, FEDERATE_SAVING, FEDERATE_WAITING_FOR_FEDERATION_TO_SAVE }
enum  ServiceGroup {
  FEDERATION_MANAGEMENT, DECLARATION_MANAGEMENT, OBJECT_MANAGEMENT, OWNERSHIP_MANAGEMENT,
  TIME_MANAGEMENT, DATA_DISTRIBUTION_MANAGEMENT, SUPPORT_SERVICES
}
enum  SynchronizationPointFailureReason { SYNCHRONIZATION_POINT_LABEL_NOT_UNIQUE, SYNCHRONIZATION_SET_MEMBER_NOT_JOINED }
enum  TransportationType { RELIABLE = 1, BEST_EFFORT = 2 }

Functions

void swapByteArray (char *byteArray, int theSize)
 Swap the byte array in memory.
unsigned short endianSwap16Bit (unsigned short rhs)
 swap 16 bits
unsigned int endianSwap32Bit (unsigned int rhs)
 swap 32 bits
Integer64 endianSwap64Bit (Integer64 rhs)
 swap 64 bits
float endianSwap32BitFloat (float rhs)
 swap 32 bit float
double endianSwap64BitDouble (double rhs)
void appendBytes (std::vector< Octet > &wrapper, const char *bytes, size_t length)
 append to a octet vector
unsigned int paddingSizeInBytes (unsigned int bufferLength, unsigned int elementOctetBoundary)
 Get the padding for this element.
void insertBytes (std::vector< Octet > &wrapper, size_t length)
 Insert bytes into the octet buffer.
std::wostream RTI_EXPORToperator<< (std::wostream &, Exception const &)
std::wostream RTI_EXPORToperator<< (std::wostream &, LogicalTime const &)
std::wostream RTI_EXPORToperator<< (std::wostream &, LogicalTimeInterval const &)
std::wstring RTI_EXPORT rtiName ()
std::wstring RTI_EXPORT rtiVersion ()
const std::wstring HLAfloat64TimeName (L"HLAfloat64Time")
const std::wstring HLAinteger64TimeName (L"HLAinteger64Time")

Variables

const int endianChecker = 1
 This checks whether the machine is Big Endian or Little Endian.

Detailed Description

The namespace defined by the HLA Evolved Interface Specification which holds the C++ API.

Typedef Documentation

typedef short rti1516e::Integer16
typedef int rti1516e::Integer32
typedef long long rti1516e::Integer64
typedef char rti1516e::Integer8
typedef std::pair< Octet, Octet > rti1516e::OctetPair
typedef std::set< RegionHandle > rti1516e::RegionHandleSet
typedef void(* rti1516e::VariableLengthDataDeleteFunction)(void *data)

Enumeration Type Documentation

Enumerator:
HLA_IMMEDIATE 
HLA_EVOKED 
Enumerator:
RECEIVE 
TIMESTAMP 
Enumerator:
UNCONDITIONALLY_DIVEST_ATTRIBUTES 
DELETE_OBJECTS 
CANCEL_PENDING_OWNERSHIP_ACQUISITIONS 
DELETE_OBJECTS_THEN_DIVEST 
CANCEL_THEN_DELETE_THEN_DIVEST 
NO_ACTION 
Enumerator:
RTI_UNABLE_TO_RESTORE 
FEDERATE_REPORTED_FAILURE_DURING_RESTORE 
FEDERATE_RESIGNED_DURING_RESTORE 
RTI_DETECTED_FAILURE_DURING_RESTORE 
RESTORE_ABORTED 
Enumerator:
NO_RESTORE_IN_PROGRESS 
FEDERATE_RESTORE_REQUEST_PENDING 
FEDERATE_WAITING_FOR_RESTORE_TO_BEGIN 
FEDERATE_PREPARED_TO_RESTORE 
FEDERATE_RESTORING 
FEDERATE_WAITING_FOR_FEDERATION_TO_RESTORE 
Enumerator:
RTI_UNABLE_TO_SAVE 
FEDERATE_REPORTED_FAILURE_DURING_SAVE 
FEDERATE_RESIGNED_DURING_SAVE 
RTI_DETECTED_FAILURE_DURING_SAVE 
SAVE_TIME_CANNOT_BE_HONORED 
SAVE_ABORTED 
Enumerator:
NO_SAVE_IN_PROGRESS 
FEDERATE_INSTRUCTED_TO_SAVE 
FEDERATE_SAVING 
FEDERATE_WAITING_FOR_FEDERATION_TO_SAVE 
Enumerator:
FEDERATION_MANAGEMENT 
DECLARATION_MANAGEMENT 
OBJECT_MANAGEMENT 
OWNERSHIP_MANAGEMENT 
TIME_MANAGEMENT 
DATA_DISTRIBUTION_MANAGEMENT 
SUPPORT_SERVICES 
Enumerator:
SYNCHRONIZATION_POINT_LABEL_NOT_UNIQUE 
SYNCHRONIZATION_SET_MEMBER_NOT_JOINED 
Enumerator:
RELIABLE 
BEST_EFFORT 

Function Documentation

void rti1516e::appendBytes ( std::vector< Octet > &  wrapper,
const char *  bytes,
size_t  length 
)
inline

append to a octet vector

unsigned short rti1516e::endianSwap16Bit ( unsigned short  rhs)
inline

swap 16 bits

Referenced by endianSwap32Bit().

unsigned int rti1516e::endianSwap32Bit ( unsigned int  rhs)
inline

swap 32 bits

References endianSwap16Bit().

Referenced by endianSwap32BitFloat(), and endianSwap64Bit().

float rti1516e::endianSwap32BitFloat ( float  rhs)
inline

swap 32 bit float

References endianSwap32Bit().

Integer64 rti1516e::endianSwap64Bit ( Integer64  rhs)
inline

swap 64 bits

References endianSwap32Bit().

Referenced by endianSwap64BitDouble().

double rti1516e::endianSwap64BitDouble ( double  rhs)
inline

References endianSwap64Bit().

const std::wstring rti1516e::HLAfloat64TimeName ( L"HLAfloat64Time"  )
const std::wstring rti1516e::HLAinteger64TimeName ( L"HLAinteger64Time"  )
void rti1516e::insertBytes ( std::vector< Octet > &  wrapper,
size_t  length 
)
inline

Insert bytes into the octet buffer.

Referenced by DtAssistantMsg::adjustBytes(), DtRtiMsg::adjustBytes(), DtReportFederationsMsg::set(), DtJoinLightWeightMsg::set(), DtFomModuleRequestMsg::set(), DtCreateMsg::set(), DtJoinMsg::set(), DtJoinResponseMsg::set(), DtAssistantConnQueryMsg::setAdditionalForwarderConnectionAddr(), DtAssistantPopupMsg::setAdvancedText(), DtAssistantExecStateMsg::setAllData(), DtAssistantForwarderStateMsg::setAllData(), DtWwwControlMsg::setCommand(), DtWwwControlRspMsg::setCommand(), DtConnectConfirmMsg::setCommandArgs(), DtAssistantLrcCompInfoMsg::setCommandArgs(), DtAssistantStartRtiexecMsg::setConnectionName(), DtCreateMsg::setCrcsOfFedFiles(), DtJoinMsg::setCrcsOfFedFiles(), DtAssistantConnMsg::setDisplay(), DtCreateResponseMsg::setErrorString(), DtJoinResponseMsg::setErrorString(), DtJoinLightWeightMsg::setFederateHostName(), DtJoinMsg::setFederateHostName(), DtAssistantFederateStateMsg::setFederateHostName(), DtJoinLightWeightMsg::setFederateName(), DtJoinMsg::setFederateName(), DtJoinResponseMsg::setFederateName(), DtAssistantLrcCompInfoMsg::setFederateName(), DtAssistantFederateStateMsg::setFederateName(), DtJoinResponseMsg::setFederateNamesAndHandles(), DtSyncPointMsg::setFederates(), DtAssistantFederationStateMsg::setFederateStates(), DtAssistantTimeStateMsg::setFederateTimeStates(), DtJoinLightWeightMsg::setFederateType(), DtJoinMsg::setFederateType(), DtAssistantFederateStateMsg::setFederateType(), DtAssistantRidParamsMsg::setFederation(), DtAssistantTimeStateMsg::setFederationName(), DtAssistantSyncPtUpdateMsg::setFederationName(), DtAssistantFederationStateMsg::setFederationName(), DtAssistantFederateStateMsg::setFederationName(), DtAssistantLrcCompInfoMsg::setFederationName(), DtReportFederationsMsg::setFederationNames(), DtAssistantFederationStateMsg::setFedFileName(), DtFomModuleDistributionMsg::setFomModuleName(), DtFomModuleRequestMsg::setFomModuleNames(), DtCreateMsg::setFomModuleNames(), DtJoinMsg::setFomModuleNames(), DtJoinResponseMsg::setfomModuleNames(), DtAssistantFederationStateMsg::setFomModules(), DtForwarderNodeInfoMsg::setForwarderHostName(), DtForwarderNodeInfoMsg::setForwarderName(), DtAssistantAwaitingForwardersMsg::setForwarders(), DtFomModuleDistributionMsg::setFullFedExName(), DtJoinLightWeightMsg::setFullFedExName(), DtFomModuleRequestMsg::setFullFedExName(), DtCreateMsg::setFullFedExName(), DtJoinMsg::setFullFedExName(), DtJoinResponseMsg::setFullFedExName(), DtRtiExecConnectMsg::setHostName(), DtAssistantRtiForwarderCompInfoMsg::setHostName(), DtAssistantRtiexecCompInfoMsg::setHostName(), DtForwarderNodeInfoMsg::setKnownForwarderNodes(), DtSaveMsg::setLabel(), DtRestoreReplyMsg::setLabel(), DtRestoreBegunMsg::setLabel(), DtSaveResponseMsg::setLabel(), DtAssistantLicQueryMsg::setLicenseServerName(), DtAssistantLicServerInfoMsg::setLicenseServers(), DtAssistantRtiexecCompInfoMsg::setLicServer(), DtAssistantLrcCompInfoMsg::setLicServer(), DtAssistantLightweightInfoMsg::setLightweightConns(), DtAssistantLogMsg::setLog(), DtAssistantShmCompInfoMsg::setLogFilename(), DtAssistantWwwCompInfoMsg::setLogFilename(), DtAssistantRtiForwarderCompInfoMsg::setLogFilename(), DtAssistantRtiexecCompInfoMsg::setLogFilename(), DtAssistantLrcCompInfoMsg::setLogFilename(), DtAssistantCommandMsg::setMessageString(), DtCreateMsg::setMOMModuleName(), DtJoinResponseMsg::setMomModuleName(), DtAssistantLrcCompInfoMsg::setName(), DtReleaseMultiNameMsg::setObjectNames(), DtReserveMultiNameMsg::setObjectNames(), DtMultiNameReservedMsg::setObjectNames(), DtDiscObjMsg::setObjHandles(), DtRegObjMsg::setObjName(), DtWwwStateRspMsg::setPayload(), DtNetworkMapRspMsg::setPayload(), DtWwwFederateStateRspMsg::setPayload(), DtAssistantSyncPtUpdateMsg::setPendingAndAchieved(), DtConnectConfirmMsg::setProcessName(), DtAssistantLrcCompInfoMsg::setProcessName(), DtAssistantRidParamsMsg::setRidFilename(), DtAssistantRidParamsMsg::setRidParams(), DtAssistantInfoMsg::setRtiexecsAndForwarders(), DtAssistantMsg::setSourceHost(), DtRtiExecHandshakeMsg::setSourceHostName(), DtAssistantNotifyMsg::setSourceName(), DtSyncPointMsg::setSyncPointName(), DtAssistantSyncPtUpdateMsg::setSyncPtName(), DtSyncPointMsg::setTag(), DtOwnershipMsg::setTag(), DtAssistantNotifyMsg::setText(), DtAssistantPopupMsg::setText(), DtReportFederationsMsg::setTimeImplementationNames(), DtCreateMsg::setTimeImplName(), DtJoinResponseMsg::setTimeImplName(), DtSyncPointMsg::setUnsuccessfulFederates(), DtFomModuleDistributionMsg::writeFomModuleBlock(), and DtTransferRidParamsMsg::writeRidTestBlock().

std::wostream RTI_EXPORT& rti1516e::operator<< ( std::wostream &  ,
Exception const &   
)
std::wostream RTI_EXPORT& rti1516e::operator<< ( std::wostream &  ,
LogicalTime const &   
)
std::wostream RTI_EXPORT& rti1516e::operator<< ( std::wostream &  ,
LogicalTimeInterval const &   
)
unsigned int rti1516e::paddingSizeInBytes ( unsigned int  bufferLength,
unsigned int  elementOctetBoundary 
)
inline

Get the padding for this element.

std::wstring RTI_EXPORT rti1516e::rtiName ( )

Referenced by main().

std::wstring RTI_EXPORT rti1516e::rtiVersion ( )

Referenced by main().

void rti1516e::swapByteArray ( char *  byteArray,
int  theSize 
)
inline

Swap the byte array in memory.

Variable Documentation

const int rti1516e::endianChecker = 1

This checks whether the machine is Big Endian or Little Endian.


Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)