DtDesignatorEncoder Class Reference

Instances of DtDesignatorEncoder are used to take state information from a DtDesignatorRepository and place it into a designator PDU. More...

Inheritance diagram for DtDesignatorEncoder:

Collaboration diagram for DtDesignatorEncoder:

Public Member Functions
	DtDesignatorEncoder (double _relPosThreshold=1.0, double _absPosThreshold=1.0, double _accelThreshold=0.2)
	Constructor.
virtual	~DtDesignatorEncoder ()
	Destructor.
	DtDesignatorEncoder (const DtDesignatorEncoder &orig)
	Copy constructor.
DtDesignatorEncoder &	operator= (const DtDesignatorEncoder &orig)
	Assignment operator.
virtual DtDesignatorPdu *	stateMsg (const DtDesignatorRepository &stateRep, const DtDesignatorRepository &asSeenByRemote)
	Constructs a PDU from the state repository.
virtual void	setRelPosThreshold (double val)
	Set/Query the value of the "Relative Position" Update Threshold.
virtual double	relPosThreshold () const
	Set/Query the value of the "Relative Position" Update Threshold.
virtual void	setAbsPosThreshold (double val)
	Set/Query the value of the "Absolute Position" Update Threshold.
virtual double	absPosThreshold () const
	Set/Query the value of the "Absolute Position" Update Threshold.
virtual void	setAccelThreshold (double val)
	Set/Query the value of the "Acceleration" Update Threshold.
virtual double	accelThreshold () const
	Set/Query the value of the "Acceleration" Update Threshold.
Public Member Functions inherited from DtStateEncoder
	DtStateEncoder ()
	Default constructor.
virtual	~DtStateEncoder ()
	Destructor.
	DtStateEncoder (const DtStateEncoder &orig)
	Copy constructor.
DtStateEncoder &	operator= (const DtStateEncoder &orig)
	Assignment operator.
void	setSendNeeded ()
	Sets myForceSendNeeded to true.

Protected Member Functions
virtual bool	sendNeeded (const DtDesignatorRepository &stateRep, const DtDesignatorRepository &asSeenByRemote)
	Determine if a state message needs to be sent.

Protected Attributes
double	myRelPosThreshold
double	myAbsPosThreshold
double	myAccelThreshold
DtDesignatorPdu	myPdu
Protected Attributes inherited from DtStateEncoder
bool	myForceSendNeeded

Detailed Description

Instances of DtDesignatorEncoder are used to take state information from a DtDesignatorRepository and place it into a designator PDU.

Constructor & Destructor Documentation

DtDesignatorEncoder::DtDesignatorEncoder	(	double	_relPosThreshold = 1.0,
		double	_absPosThreshold = 1.0,
		double	_accelThreshold = 0.2
	)

Constructor.

virtual DtDesignatorEncoder::~DtDesignatorEncoder ( )

virtual

Destructor.

DtDesignatorEncoder::DtDesignatorEncoder

(

const DtDesignatorEncoder &

orig

)

Copy constructor.

Member Function Documentation

double DtDesignatorEncoder::absPosThreshold ( ) const

inlinevirtual

Set/Query the value of the "Absolute Position" Update Threshold.

References myAbsPosThreshold.

double DtDesignatorEncoder::accelThreshold ( ) const

inlinevirtual

Set/Query the value of the "Acceleration" Update Threshold.

References myAccelThreshold.

DtDesignatorEncoder& DtDesignatorEncoder::operator=

(

const DtDesignatorEncoder &

orig

)

Assignment operator.

double DtDesignatorEncoder::relPosThreshold ( ) const

inlinevirtual

Set/Query the value of the "Relative Position" Update Threshold.

References myRelPosThreshold.

virtual bool DtDesignatorEncoder::sendNeeded ( const DtDesignatorRepository &  stateRep, const DtDesignatorRepository &  asSeenByRemote  )

protectedvirtual

Determine if a state message needs to be sent.

void DtDesignatorEncoder::setAbsPosThreshold ( double  val )

inlinevirtual

Set/Query the value of the "Absolute Position" Update Threshold.

References myAbsPosThreshold.

void DtDesignatorEncoder::setAccelThreshold ( double  val )

inlinevirtual

Set/Query the value of the "Acceleration" Update Threshold.

References myAccelThreshold.

void DtDesignatorEncoder::setRelPosThreshold ( double  val )

inlinevirtual

Set/Query the value of the "Relative Position" Update Threshold.

References myRelPosThreshold.

virtual DtDesignatorPdu* DtDesignatorEncoder::stateMsg ( const DtDesignatorRepository &  stateRep, const DtDesignatorRepository &  asSeenByRemote  )

virtual

Constructs a PDU from the state repository.

stateMsg determines whether a Designator PDU needs to be sent and constructs one of it does.

Returns

PDU if send is needed, and NULL if not

Member Data Documentation

double DtDesignatorEncoder::myAbsPosThreshold

protected

Referenced by absPosThreshold(), and setAbsPosThreshold().

double DtDesignatorEncoder::myAccelThreshold

protected

Referenced by accelThreshold(), and setAccelThreshold().

DtDesignatorPdu DtDesignatorEncoder::myPdu

protected

double DtDesignatorEncoder::myRelPosThreshold

protected

Referenced by relPosThreshold(), and setRelPosThreshold().

---

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

• dDesignatrEnc.h