DtVrfAggregateRemoteEntityNetInterface Class Reference

Class Description: DtVrfAggregateRemoteEntityNetInterface. More...

Inheritance diagram for DtVrfAggregateRemoteEntityNetInterface:

List of all members.

Public Member Functions
	DtVrfAggregateRemoteEntityNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtVrfAggregateRemoteEntityNetInterface (const DtVrfAggregateRemoteEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtVrfAggregateRemoteEntityNetInterface &	operator= (const DtVrfAggregateRemoteEntityNetInterface &orig)
	assignment operator
virtual	~DtVrfAggregateRemoteEntityNetInterface ()
	destructor
virtual DtString	type () const
	Returns the type of net interface object.
virtual bool	init ()
	override of base class init()
virtual void	onTick ()
	Override to check for a valid reflected aggregate before using, since remote VR-Forces objects are created based on object-created messages, not reflected aggregate discoveries.
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 *simObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)
Protected Member Functions
	DtVrfAggregateRemoteEntityNetInterface ()
	default constructor
Protected Attributes
DtInterfaceMessageExecutive *	myMessageExec
DtSimManager *	mySimManager
	Obtained from our DtVrfObject.
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime

---

Detailed Description

Class Description: DtVrfAggregateRemoteEntityNetInterface.

Derived from DtSimAggregateRemoteEntityNetInterface, DtVrfAggregateRemoteEntityNetInterface provides an interface between the local representation of a Vr-Forces' remote aggregate entity and its network (VR-Link) representation (DtReflectedExtAggregate and DtAggregateStateRepository).

---

Constructor & Destructor Documentation

DtVrfAggregateRemoteEntityNetInterface::DtVrfAggregateRemoteEntityNetInterface

(

)

[protected]

default constructor

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

read/writable contructor

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

copy constructor

virtual DtVrfAggregateRemoteEntityNetInterface::~DtVrfAggregateRemoteEntityNetInterface

(

)

[virtual]

destructor

---

Member Function Documentation

const DtVrfAggregateRemoteEntityNetInterface& DtVrfAggregateRemoteEntityNetInterface::operator=

(

const DtVrfAggregateRemoteEntityNetInterface &

orig

)

assignment operator

virtual DtString DtVrfAggregateRemoteEntityNetInterface::type

(

)

const [virtual]

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Reimplemented from DtSimAggregateRemoteEntityNetInterface.

virtual bool DtVrfAggregateRemoteEntityNetInterface::init

(

)

[virtual]

override of base class init()

Reimplemented from DtSimRemoteEntityNetInterface.

virtual void DtVrfAggregateRemoteEntityNetInterface::onTick

(

)

[virtual]

Override to check for a valid reflected aggregate before using, since remote VR-Forces objects are created based on object-created messages, not reflected aggregate discoveries.

Reimplemented from DtSimRemoteEntityNetInterface.

virtual void DtVrfAggregateRemoteEntityNetInterface::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 DtVrfAggregateRemoteEntityNetInterface::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 DtVrfAggregateRemoteEntityNetInterface::minTickPeriod

(

)

const [virtual]

access the minimum tick period

virtual void DtVrfAggregateRemoteEntityNetInterface::setMinTickPeriodVariance

(

double

minTickPeriodVariance

)

[virtual]

set the variance in the minimum tick time

virtual double DtVrfAggregateRemoteEntityNetInterface::minTickPeriodVariance

(

)

const [virtual]

access the variance in the minimum tick period

virtual void DtVrfAggregateRemoteEntityNetInterface::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 DtVrfAggregateRemoteEntityNetInterface::nextTickTime

(

)

const [virtual]

access the next tick time

virtual double DtVrfAggregateRemoteEntityNetInterface::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* DtVrfAggregateRemoteEntityNetInterface::vrfObject

(

)

const

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

Reimplemented from DtSimAggregateRemoteEntityNetInterface.

---

Member Data Documentation

DtInterfaceMessageExecutive* DtVrfAggregateRemoteEntityNetInterface::myMessageExec [protected]

DtSimManager* DtVrfAggregateRemoteEntityNetInterface::mySimManager [protected]

Obtained from our DtVrfObject.

double DtVrfAggregateRemoteEntityNetInterface::myMinTickPeriod [protected]

double DtVrfAggregateRemoteEntityNetInterface::myMinTickPeriodVariance [protected]

double DtVrfAggregateRemoteEntityNetInterface::myNextTickTime [protected]

---

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

• include/vrfobjcore/vrfAggRemNetIf.h