DtSubsurfaceLayerEncoder Class Reference

Instances of DtSubsurfaceLayerEncoder encode data from DtSubsurfaceLayerStateRepository objects to the net structures to be sent to the network. More...

Inheritance diagram for DtSubsurfaceLayerEncoder:

Collaboration diagram for DtSubsurfaceLayerEncoder:

Public Member Functions
	DtSubsurfaceLayerEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Default constructor. More...
virtual	~DtSubsurfaceLayerEncoder ()
	Destructor. More...
	DtSubsurfaceLayerEncoder (const DtSubsurfaceLayerEncoder &orig)
	Copy constructor. More...
DtSubsurfaceLayerEncoder &	operator= (const DtSubsurfaceLayerEncoder &orig)
	Assignment operator. More...
Public Member Functions inherited from DtEnvironmentConditionEncoder
	DtEnvironmentConditionEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Default constructor. More...
virtual	~DtEnvironmentConditionEncoder ()
	Destructor. More...
	DtEnvironmentConditionEncoder (const DtEnvironmentConditionEncoder &orig)
	Copy constructor. More...
DtEnvironmentConditionEncoder &	operator= (const DtEnvironmentConditionEncoder &orig)
	Assignment operator. More...
Public Member Functions inherited from DtMetocRootEncoder
	DtMetocRootEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Default constructor. More...
virtual	~DtMetocRootEncoder ()
	Destructor. More...
	DtMetocRootEncoder (const DtMetocRootEncoder &orig)
	Copy constructor. More...
DtMetocRootEncoder &	operator= (const DtMetocRootEncoder &orig)
	Assignment operator. More...
Public Member Functions inherited from DtHlaStateEncoder
	DtHlaStateEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	constructor More...
virtual	~DtHlaStateEncoder ()
	destructor More...
	DtHlaStateEncoder (const DtHlaStateEncoder &orig)
	copy constructor More...
DtHlaStateEncoder &	operator= (const DtHlaStateEncoder &orig)
	assignment operator More...
DtAttributeEncoder	addEncoder (RTI::AttributeHandle hand, DtAttributeEncoder func)
	Add/Remove an encoding function for the attribute specified by handle. More...
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. More...
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. More...
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. More...
DtAttributeChecker	removeChecker (char *name, bool complain=true)
DtAttributeEncoder	encoder (const RTI::AttributeHandle &handle)
	Get the attribute encoder for the specified handle. More...
DtAttributeChecker	checker (const RTI::AttributeHandle &handle)
	Get the attribute checker for the specified handle. More...
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. More...
virtual RTI::ObjectClassHandle	objectClassHandle ()
	Get the object's class handle. More...
virtual DtHlaStateEncoder *	clone (DtObjClassDesc *classDesc) const
	Returns a new-ed clone of this object which corresponds to the class description classDesc. More...
virtual DtHlaStateEncoder *	clone () const
	Returns a new-ed clone of this object. More...
virtual void	preCalculateEligible (const RTI::AttributeHandleSet &neededAttrs)

Static Public Member Functions
static DtHlaStateEncoder *	create (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Function that creates a DtSubsurfaceLayerEncoder. More...
Static Public Member Functions inherited from DtEnvironmentConditionEncoder
static DtHlaStateEncoder *	create (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Function that creates a DtEnvironmentConditionEncoder. More...
Static Public Member Functions inherited from DtMetocRootEncoder
static DtHlaStateEncoder *	create (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Function that creates a DtMetocRootEncoder. More...
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. More...
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. More...
static void	wideStringToHlaUnicodeString (const std::wstring &wideString, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle attrHandle)
	Puts a unicode widestring into a buffer of the appropriate size and adds it to the attribute value list with it's attribute handle. More...

Static Protected Member Functions
static bool	needTemperature (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if Temperature needs to be sent to the network, false otherwise. More...
static void	encodeTemperature (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes Temperature from rep into attrs. More...
static bool	needLayer (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if Layer needs to be sent to the network, false otherwise. More...
static void	encodeLayer (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes Layer from rep into attrs. More...
static bool	needCurrent (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if Current needs to be sent to the network, false otherwise. More...
static void	encodeCurrent (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes Current from rep into attrs. More...
static bool	needSalinity (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if Salinity needs to be sent to the network, false otherwise. More...
static void	encodeSalinity (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes Salinity from rep into attrs. More...
static bool	needBottomType (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if BottomType needs to be sent to the network, false otherwise. More...
static void	encodeBottomType (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes BottomType from rep into attrs. More...
static bool	needVisibilityRange (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if VisibilityRange needs to be sent to the network, false otherwise. More...
static void	encodeVisibilityRange (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes VisibilityRange from rep into attrs. More...
static bool	needPermeability (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if Permeability needs to be sent to the network, false otherwise. More...
static void	encodePermeability (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes Permeability from rep into attrs. More...
static bool	needPriority (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if Priority needs to be sent to the network, false otherwise. More...
static void	encodePriority (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes Priority from rep into attrs. More...
static bool	needVrfWeatherAreaIdentifier (const DtSubsurfaceLayerStateRepository &stateRep, const DtSubsurfaceLayerStateRepository &asSeenByRemote)
	Return true if VrfWeatherAreaIdentifier needs to be sent to the network, false otherwise. More...
static void	encodeVrfWeatherAreaIdentifier (const DtSubsurfaceLayerStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes VrfWeatherAreaIdentifier from rep into attrs. More...
Static Protected Member Functions inherited from DtEnvironmentConditionEncoder
static bool	needServiceId (const DtEnvironmentConditionStateRepository &stateRep, const DtEnvironmentConditionStateRepository &asSeenByRemote)
	Return true if ServiceId needs to be sent to the network, false otherwise. More...
static void	encodeServiceId (const DtEnvironmentConditionStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes ServiceId from rep into attrs. More...
static bool	needGeoReference (const DtEnvironmentConditionStateRepository &stateRep, const DtEnvironmentConditionStateRepository &asSeenByRemote)
	Return true if GeoReference needs to be sent to the network, false otherwise. More...
static void	encodeGeoReference (const DtEnvironmentConditionStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes GeoReference from rep into attrs. More...
Static Protected Member Functions inherited from DtMetocRootEncoder
static bool	needUniqueId (const DtMetocRootStateRepository &stateRep, const DtMetocRootStateRepository &asSeenByRemote)
	Return true if UniqueId needs to be sent to the network, false otherwise. More...
static void	encodeUniqueId (const DtMetocRootStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes UniqueId from rep into attrs. More...
static bool	needName (const DtMetocRootStateRepository &stateRep, const DtMetocRootStateRepository &asSeenByRemote)
	Return true if Name needs to be sent to the network, false otherwise. More...
static void	encodeName (const DtMetocRootStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes Name from rep into attrs. More...

Additional Inherited Members
Public Types inherited from DtHlaStateEncoder
typedef void(*	DtAttributeEncoder )(const DtStateRepository &stateRep, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle handle)
	Attribute encoding function declaration. More...
typedef bool(*	DtAttributeChecker )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
	Attribute checking function declaration. More...
typedef bool(*	DtAttributeCheckerWithHandle )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, RTI::AttributeHandle handle)
	Attribute checking function declaration that takes a handle and checks the specific attribute pointed to by that handle. More...
Protected Attributes inherited from DtHlaStateEncoder
DtExerciseConn *	myExConn
DtObjClassDesc *	myClassDesc
RTI::ObjectClassHandle	myHandle
std::map< RTI::AttributeHandle, DtAttributeEncoder >	myEncoderList
	myEncoderList and myCheckerList are arrays of classDesc->maxAttrHandle() items. More...
std::map< RTI::AttributeHandle, DtAttributeChecker >	myCheckerList
std::vector< DtAttributeChecker >	myCheckerCache
	This is a helper variable that pre-lookups decoder functions in order to avoid making map calls on every update. More...
const RTI::AttributeHandleSet *	myCachedSet
std::map< RTI::AttributeHandle, bool >	myReportedWarning
	myReportedWarning is an array for keeping track of which warnings have already been reported More...

Detailed Description

Instances of DtSubsurfaceLayerEncoder encode data from DtSubsurfaceLayerStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

DtSubsurfaceLayerEncoder::DtSubsurfaceLayerEncoder	(	DtExerciseConn *	exConn,
		DtObjClassDesc *	classDesc
	)

Default constructor.

virtual DtSubsurfaceLayerEncoder::~DtSubsurfaceLayerEncoder ( )

virtual

Destructor.

DtSubsurfaceLayerEncoder::DtSubsurfaceLayerEncoder

(

const DtSubsurfaceLayerEncoder &

orig

)

Copy constructor.

Member Function Documentation

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

static

Function that creates a DtSubsurfaceLayerEncoder.

static void DtSubsurfaceLayerEncoder::encodeBottomType ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes BottomType from rep into attrs.

static void DtSubsurfaceLayerEncoder::encodeCurrent ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes Current from rep into attrs.

static void DtSubsurfaceLayerEncoder::encodeLayer ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes Layer from rep into attrs.

static void DtSubsurfaceLayerEncoder::encodePermeability ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes Permeability from rep into attrs.

static void DtSubsurfaceLayerEncoder::encodePriority ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes Priority from rep into attrs.

static void DtSubsurfaceLayerEncoder::encodeSalinity ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes Salinity from rep into attrs.

static void DtSubsurfaceLayerEncoder::encodeTemperature ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes Temperature from rep into attrs.

static void DtSubsurfaceLayerEncoder::encodeVisibilityRange ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes VisibilityRange from rep into attrs.

static void DtSubsurfaceLayerEncoder::encodeVrfWeatherAreaIdentifier ( const DtSubsurfaceLayerStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes VrfWeatherAreaIdentifier from rep into attrs.

static bool DtSubsurfaceLayerEncoder::needBottomType ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if BottomType needs to be sent to the network, false otherwise.

static bool DtSubsurfaceLayerEncoder::needCurrent ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if Current needs to be sent to the network, false otherwise.

static bool DtSubsurfaceLayerEncoder::needLayer ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if Layer needs to be sent to the network, false otherwise.

static bool DtSubsurfaceLayerEncoder::needPermeability ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if Permeability needs to be sent to the network, false otherwise.

static bool DtSubsurfaceLayerEncoder::needPriority ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if Priority needs to be sent to the network, false otherwise.

static bool DtSubsurfaceLayerEncoder::needSalinity ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if Salinity needs to be sent to the network, false otherwise.

static bool DtSubsurfaceLayerEncoder::needTemperature ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if Temperature needs to be sent to the network, false otherwise.

static bool DtSubsurfaceLayerEncoder::needVisibilityRange ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if VisibilityRange needs to be sent to the network, false otherwise.

static bool DtSubsurfaceLayerEncoder::needVrfWeatherAreaIdentifier ( const DtSubsurfaceLayerStateRepository &  stateRep, const DtSubsurfaceLayerStateRepository &  asSeenByRemote  )

staticprotected

Return true if VrfWeatherAreaIdentifier needs to be sent to the network, false otherwise.

DtSubsurfaceLayerEncoder& DtSubsurfaceLayerEncoder::operator=

(

const DtSubsurfaceLayerEncoder &

orig

)

Assignment operator.

---

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

• subsurfaceLayerEncoderHLA.h