DtVrfIndividualRemoteEntityNetInterface Class Reference

Class Description: DtVrfIndividualRemoteEntityNetInterfacee. More...

Inheritance diagram for DtVrfIndividualRemoteEntityNetInterface:

List of all members.

Public Member Functions
	DtVrfIndividualRemoteEntityNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtVrfIndividualRemoteEntityNetInterface (const DtVrfIndividualRemoteEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtVrfIndividualRemoteEntityNetInterface &	operator= (const DtVrfIndividualRemoteEntityNetInterface &orig)
	assignment operator
virtual	~DtVrfIndividualRemoteEntityNetInterface ()
	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	updateFromReflectedObject ()
	Override to update DI-Guy Information.
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
	DtVrfIndividualRemoteEntityNetInterface ()
	default constructor; not implemented
Protected Attributes
DtInterfaceMessageExecutive *	myMessageExec
DtSimManager *	mySimManager
	Obtained from our DtVrfObject.
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime

---

Detailed Description

Class Description: DtVrfIndividualRemoteEntityNetInterfacee.

Derived from DtSimIndividualRemoteEntityNetInterface, DtVrfIndividualRemoteEntityNetInterface overrides the tick() function so that it can wait for a valid reflected entity to arrive after creation time, since remote vrf objects are created based on receipt of object created messages, not reflected emtity discoveries.

Examples

• Remote Net Interface

---

Constructor & Destructor Documentation

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

read/writable contructor

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

copy constructor

virtual DtVrfIndividualRemoteEntityNetInterface::~DtVrfIndividualRemoteEntityNetInterface

(

)

[virtual]

destructor

DtVrfIndividualRemoteEntityNetInterface::DtVrfIndividualRemoteEntityNetInterface

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

const DtVrfIndividualRemoteEntityNetInterface& DtVrfIndividualRemoteEntityNetInterface::operator=

(

const DtVrfIndividualRemoteEntityNetInterface &

orig

)

assignment operator

virtual DtString DtVrfIndividualRemoteEntityNetInterface::type

(

)

const [virtual]

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Reimplemented from DtSimIndividualRemoteEntityNetInterface.

Reimplemented in MyIndividualRemoteEntityNetInterface.

virtual bool DtVrfIndividualRemoteEntityNetInterface::init

(

)

[virtual]

override of base class init().

Reimplemented from DtSimRemoteEntityNetInterface.

virtual void DtVrfIndividualRemoteEntityNetInterface::onTick

(

)

[virtual]

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

Reimplemented from DtSimRemoteEntityNetInterface.

virtual void DtVrfIndividualRemoteEntityNetInterface::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 DtVrfIndividualRemoteEntityNetInterface::updateFromReflectedObject

(

)

[virtual]

Override to update DI-Guy Information.

Reimplemented from DtSimIndividualRemoteEntityNetInterface.

Reimplemented in MyIndividualRemoteEntityNetInterface.

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

(

)

const [virtual]

access the minimum tick period

virtual void DtVrfIndividualRemoteEntityNetInterface::setMinTickPeriodVariance

(

double

minTickPeriodVariance

)

[virtual]

set the variance in the minimum tick time

virtual double DtVrfIndividualRemoteEntityNetInterface::minTickPeriodVariance

(

)

const [virtual]

access the variance in the minimum tick period

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

(

)

const [virtual]

access the next tick time

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

(

)

const

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

Reimplemented from DtSimIndividualRemoteEntityNetInterface.

Reimplemented in MyIndividualRemoteEntityNetInterface.

---

Member Data Documentation

DtInterfaceMessageExecutive* DtVrfIndividualRemoteEntityNetInterface::myMessageExec [protected]

DtSimManager* DtVrfIndividualRemoteEntityNetInterface::mySimManager [protected]

Obtained from our DtVrfObject.

double DtVrfIndividualRemoteEntityNetInterface::myMinTickPeriod [protected]

double DtVrfIndividualRemoteEntityNetInterface::myMinTickPeriodVariance [protected]

double DtVrfIndividualRemoteEntityNetInterface::myNextTickTime [protected]

---

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

• include/vrfobjcore/vrfIndRemNetIf.h