DtVrfRemoteEnvironmentalNetInterface Class Reference

Class Description: DtVrfRemoteEnvironmentalNetInterface. More...

Inheritance diagram for DtVrfRemoteEnvironmentalNetInterface:

List of all members.

Public Member Functions
	DtVrfRemoteEnvironmentalNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtVrfRemoteEnvironmentalNetInterface (const DtVrfRemoteEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtVrfRemoteEnvironmentalNetInterface &	operator= (const DtVrfRemoteEnvironmentalNetInterface &orig)
	assignment operator
virtual	~DtVrfRemoteEnvironmentalNetInterface ()
	destructor
virtual DtString	type () const
	Returns the type of net interface object.
virtual bool	init ()
	override of base class init().
virtual void	onTick ()
	onTick is being overriden so the net interface isn't ticked before the reflected object has been setup.
virtual void	tick ()
	Override base class tick.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
DtVrfObject *	vrfObject () const
Static Public Member Functions
static DtSimObjectNetInterface *	creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)
Protected Member Functions
	DtVrfRemoteEnvironmentalNetInterface ()
	default constructor
Protected Attributes
DtInterfaceMessageExecutive *	myMessageExec
DtSimManager *	mySimManager
	Obtained from our DtVrfObject.
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime

---

Detailed Description

Class Description: DtVrfRemoteEnvironmentalNetInterface.

Derived from DtSimRemoteEnvironmentalNetInterface, DtVrfRemoteEnvironmentalNetInterface overrides updateGeometry() to flag the object geometry that conversion to local coords needs to be redone.

---

Constructor & Destructor Documentation

DtVrfRemoteEnvironmentalNetInterface::DtVrfRemoteEnvironmentalNetInterface

(

)

[protected]

default constructor

DtVrfRemoteEnvironmentalNetInterface::DtVrfRemoteEnvironmentalNetInterface	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry = 0,
		bool	publishObject = true
	)

read/writable contructor

DtVrfRemoteEnvironmentalNetInterface::DtVrfRemoteEnvironmentalNetInterface	(	const DtVrfRemoteEnvironmentalNetInterface &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtVrfRemoteEnvironmentalNetInterface::~DtVrfRemoteEnvironmentalNetInterface

(

)

[virtual]

destructor

---

Member Function Documentation

const DtVrfRemoteEnvironmentalNetInterface& DtVrfRemoteEnvironmentalNetInterface::operator=

(

const DtVrfRemoteEnvironmentalNetInterface &

orig

)

assignment operator

virtual DtString DtVrfRemoteEnvironmentalNetInterface::type

(

)

const [virtual]

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

Reimplemented in DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual bool DtVrfRemoteEnvironmentalNetInterface::init

(

)

[virtual]

override of base class init().

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

virtual void DtVrfRemoteEnvironmentalNetInterface::onTick

(

)

[virtual]

onTick is being overriden so the net interface isn't ticked before the reflected object has been setup.

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

Reimplemented in DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtVrfRemoteEnvironmentalNetInterface::tick

(

)

[virtual]

Override base class tick.

This version of tick checks to see if the time to tick has arrived (myNextTickTime <= exerciseClock()-> approximateElapsedRealTime()). If it has, it will then call the base class tick (which in turn calls onTick()), and recalculate the next tick time

Reimplemented from DtSimObjectNetInterface.

virtual void DtVrfRemoteEnvironmentalNetInterface::setMinTickPeriod

(

double

minTickPeriod

)

[virtual]

specifies a minimum tick period (which can also be thought of as

1. / maximum tick rate). This is specified in seconds.

virtual double DtVrfRemoteEnvironmentalNetInterface::minTickPeriod

(

)

const [virtual]

access the minimum tick period

virtual void DtVrfRemoteEnvironmentalNetInterface::setMinTickPeriodVariance

(

double

minTickPeriodVariance

)

[virtual]

set the variance in the minimum tick time

virtual double DtVrfRemoteEnvironmentalNetInterface::minTickPeriodVariance

(

)

const [virtual]

access the variance in the minimum tick period

virtual void DtVrfRemoteEnvironmentalNetInterface::setNextTickTime

(

double

nextTickTime

)

[virtual]

The next tick time is normally calculated internally.

setNextTickTime can be used to force a tick (set nextTickTime to exerciseClock()-> approximateElapsedRealTime())

virtual double DtVrfRemoteEnvironmentalNetInterface::nextTickTime

(

)

const [virtual]

access the next tick time

virtual double DtVrfRemoteEnvironmentalNetInterface::calculateNextTickTime

(

)

const [virtual]

The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.

and +myMinTickPeriodVariance/2. If the exercise clock is paused, the variance is always set to zero to insure that the extra calls to DtFRand() don't prevent repeatability.

DtVrfObject* DtVrfRemoteEnvironmentalNetInterface::vrfObject

(

)

const

static DtSimObjectNetInterface* DtVrfRemoteEnvironmentalNetInterface::creator	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry,
		bool	publishObject
	)		[static]

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

Reimplemented in DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

---

Member Data Documentation

DtInterfaceMessageExecutive* DtVrfRemoteEnvironmentalNetInterface::myMessageExec [protected]

DtSimManager* DtVrfRemoteEnvironmentalNetInterface::mySimManager [protected]

Obtained from our DtVrfObject.

double DtVrfRemoteEnvironmentalNetInterface::myMinTickPeriod [protected]

double DtVrfRemoteEnvironmentalNetInterface::myMinTickPeriodVariance [protected]

double DtVrfRemoteEnvironmentalNetInterface::myNextTickTime [protected]

---

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

• include/vrfobjcore/vrfRmEnvNetIf.h