VR-Link API Documentation for HLA 1.3
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtActiveSonarBeamEncoder Class Reference

class DtActiveSonarBeamEncoder More...

+ Inheritance diagram for DtActiveSonarBeamEncoder:
+ Collaboration diagram for DtActiveSonarBeamEncoder:

Public Member Functions

 DtActiveSonarBeamEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Constructor.
virtual ~DtActiveSonarBeamEncoder ()
 Destructor.
 DtActiveSonarBeamEncoder (const DtActiveSonarBeamEncoder &orig)
 Copy constructor.
DtActiveSonarBeamEncoderoperator= (const DtActiveSonarBeamEncoder &orig)
 Assignment operator.
- Public Member Functions inherited from DtHlaStateEncoder
 DtHlaStateEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 constructor
virtual ~DtHlaStateEncoder ()
 destructor
 DtHlaStateEncoder (const DtHlaStateEncoder &orig)
 copy constructor
DtHlaStateEncoderoperator= (const DtHlaStateEncoder &orig)
 assignment operator
DtAttributeEncoder addEncoder (RTI::AttributeHandle hand, DtAttributeEncoder func)
 Add/Remove an encoding function for the attribute specified by handle.
DtAttributeEncoder removeEncoder (RTI::AttributeHandle hand)
DtAttributeEncoder addEncoder (char *name, DtAttributeEncoder func, bool complain=true)
 Add/Remove an encoding function for the attribute specified by name.
DtAttributeEncoder removeEncoder (char *name, bool complain=true)
DtAttributeChecker addChecker (RTI::AttributeHandle hand, DtAttributeChecker func)
 Add/Remove a checker function for the attribute specified by handle.
DtAttributeChecker removeChecker (RTI::AttributeHandle hand)
DtAttributeChecker addChecker (char *name, DtAttributeChecker func, bool complain=true)
 Add/Remove a checker function for the attribute specified by name.
DtAttributeChecker removeChecker (char *name, bool complain=true)
virtual DtAttributeEncoder encoder (const RTI::AttributeHandle &handle)
 Get the attribute encoder for the specified handle.
virtual DtAttributeChecker checker (const RTI::AttributeHandle &handle)
 Get the attribute checker for the specified handle.
virtual void encode (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, const RTI::AttributeHandleSet &neededAttrs, const RTI::AttributeHandleSet &includeThese, DtStateMsg *msg)
 Encode necessary values from the state repository.
virtual RTI::ObjectClassHandle objectClassHandle ()
 Get the object's class handle.
virtual DtHlaStateEncoderclone (DtObjClassDesc *classDesc) const
 Returns a new-ed clone of this object which corresponds to the class description classDesc.
virtual DtHlaStateEncoderclone () const
 Returns a new-ed clone of this object.

Static Public Member Functions

static DtHlaStateEncodercreate (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
 Static method creates a new encoder.
- Static Public Member Functions inherited from DtHlaStateEncoder
static bool trueChecker (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 A checker function that always returns 1, meaning that the attribute for which it is being used will be deemed necessary to send on every tick.
static bool falseChecker (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 A checker function that always returns 0, meaning that the attribute for which it is being used will never be deemed necessary to send.

Protected Member Functions

 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (ActiveEmissionParameterIndex)
 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (ActiveSonarIdentifier)
 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (AzimuthBeamwidth)
 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (AzimuthCenter)
 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (BeamIdentifier)
 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (ElevationBeamwidth)
 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (ElevationCenter)
 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (EventIdentifier)
 DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER (ScanPattern)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (ActiveEmissionParameterIndex)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (ActiveSonarIdentifier)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (AzimuthBeamwidth)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (AzimuthCenter)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (BeamIdentifier)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (ElevationBeamwidth)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (ElevationCenter)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (EventIdentifier)
 DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER (ScanPattern)

Additional Inherited Members

- Public Types inherited from DtHlaStateEncoder
typedef void(* DtAttributeEncoder )(const DtStateRepository &stateRep, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle handle)
 Attribute encoding function declaration.
typedef bool(* DtAttributeChecker )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 Attribute checking function declaration.
- Protected Attributes inherited from DtHlaStateEncoder
DtExerciseConnmyExConn
DtObjClassDescmyClassDesc
RTI::ObjectClassHandle myHandle
std::map< RTI::AttributeHandle,
DtAttributeEncoder
myEncoderList
 myEncoderList and myCheckerList are arrays of classDesc->maxAttrHandle() items.
std::map< RTI::AttributeHandle,
DtAttributeChecker
myCheckerList
std::map< RTI::AttributeHandle,
bool > 
myReportedWarning
 myReportedWarning is an array for keeping track of which warnings have already been reported

Detailed Description

class DtActiveSonarBeamEncoder

Instances of DtActiveSonarBeamEncoder are used to encode an active sonar beam object from a state repository in an HLA environment

Constructor & Destructor Documentation

DtActiveSonarBeamEncoder::DtActiveSonarBeamEncoder ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)

Constructor.

virtual DtActiveSonarBeamEncoder::~DtActiveSonarBeamEncoder ( )
virtual

Destructor.

DtActiveSonarBeamEncoder::DtActiveSonarBeamEncoder ( const DtActiveSonarBeamEncoder orig)

Copy constructor.

Member Function Documentation

static DtHlaStateEncoder* DtActiveSonarBeamEncoder::create ( DtExerciseConn exConn,
DtObjClassDesc classDesc 
)
static

Static method creates a new encoder.

Caller is responsible for deletion.

DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( ActiveEmissionParameterIndex  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( ActiveSonarIdentifier  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( AzimuthBeamwidth  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( AzimuthCenter  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( BeamIdentifier  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( ElevationBeamwidth  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( ElevationCenter  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( EventIdentifier  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_CHECKER ( ScanPattern  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( ActiveEmissionParameterIndex  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( ActiveSonarIdentifier  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( AzimuthBeamwidth  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( AzimuthCenter  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( BeamIdentifier  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( ElevationBeamwidth  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( ElevationCenter  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( EventIdentifier  )
protected
DtActiveSonarBeamEncoder::DtDECLARE_ACTIVE_SONAR_ATTR_ENCODER ( ScanPattern  )
protected
DtActiveSonarBeamEncoder& DtActiveSonarBeamEncoder::operator= ( const DtActiveSonarBeamEncoder orig)

Assignment operator.


The documentation for this class was generated from the following file:

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)