DtGlobalEnvironmentLocalNetInterface Class Reference

Local network interface for global environment state objects. More...

Inheritance diagram for DtGlobalEnvironmentLocalNetInterface:

List of all members.

Public Member Functions
	DtGlobalEnvironmentLocalNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtGlobalEnvironmentLocalNetInterface (const DtGlobalEnvironmentLocalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor; NOTE: The publisher is not copied, because VR-Link does not provide a copy constructor (or clone or assignment function) for a publisher.
const DtGlobalEnvironmentLocalNetInterface &	operator= (const DtGlobalEnvironmentLocalNetInterface &orig)
	assignment operator; see note on copy constructor above.
virtual	~DtGlobalEnvironmentLocalNetInterface ()
	destructor; calls destroyPublisher()
virtual bool	init ()
	Override of base class init(), calls createPublisher().
virtual void	updatePublisher ()
	Update this publisher's contents.
virtual DtString	type () const
	Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h")
Static Public Member Functions
static DtSimObjectNetInterface *	creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)
Protected Member Functions
	DtGlobalEnvironmentLocalNetInterface ()
	default constructor
virtual DtEnvironmentProcessRepository *	epsr () const
	Shortcut for accessing the network repository.
virtual void	setupRecords ()
	Creates and sets the records to the VRL state repository.
virtual void	updateGeometryRecord (DtGlobalEnvironmentStateRepository *localState)
virtual void	updateStateRecord (DtGlobalEnvironmentStateRepository *localState)
virtual DtEnvironmentProcessPublisher *	_createPublisher () const
	Override this functions to use a subclass of DtEnvironmentProcessPublisher.
Protected Attributes
DtVrfEnvironmentalWeatherStateRecord *	myEnvironmentalStateRecord

---

Detailed Description

Local network interface for global environment state objects.

These objects must have a DtGlobalEnvironmentStateRepository to work with this net interface.

---

Constructor & Destructor Documentation

DtGlobalEnvironmentLocalNetInterface::DtGlobalEnvironmentLocalNetInterface

(

)

[protected]

default constructor

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

read/writable contructor

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

copy constructor; NOTE: The publisher is not copied, because VR-Link does not provide a copy constructor (or clone or assignment function) for a publisher.

Therefore, you must call init() on the copy after construction, or call setPublisher() with a user constructed publisher.

virtual DtGlobalEnvironmentLocalNetInterface::~DtGlobalEnvironmentLocalNetInterface

(

)

[virtual]

destructor; calls destroyPublisher()

---

Member Function Documentation

const DtGlobalEnvironmentLocalNetInterface& DtGlobalEnvironmentLocalNetInterface::operator=

(

const DtGlobalEnvironmentLocalNetInterface &

orig

)

assignment operator; see note on copy constructor above.

virtual bool DtGlobalEnvironmentLocalNetInterface::init

(

)

[virtual]

Override of base class init(), calls createPublisher().

Reimplemented from DtSimLocalEnvironmentalNetInterface.

virtual void DtGlobalEnvironmentLocalNetInterface::updatePublisher

(

)

[virtual]

Update this publisher's contents.

Implements DtSimLocalEnvironmentalNetInterface.

virtual DtString DtGlobalEnvironmentLocalNetInterface::type

(

)

const [virtual]

Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h")

Implements DtSimLocalEnvironmentalNetInterface.

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

virtual DtEnvironmentProcessRepository* DtGlobalEnvironmentLocalNetInterface::epsr

(

)

const [protected, virtual]

Shortcut for accessing the network repository.

virtual void DtGlobalEnvironmentLocalNetInterface::setupRecords

(

)

[protected, virtual]

Creates and sets the records to the VRL state repository.

virtual void DtGlobalEnvironmentLocalNetInterface::updateGeometryRecord

(

DtGlobalEnvironmentStateRepository *

localState

)

[protected, virtual]

virtual void DtGlobalEnvironmentLocalNetInterface::updateStateRecord

(

DtGlobalEnvironmentStateRepository *

localState

)

[protected, virtual]

virtual DtEnvironmentProcessPublisher* DtGlobalEnvironmentLocalNetInterface::_createPublisher

(

)

const [protected, virtual]

Override this functions to use a subclass of DtEnvironmentProcessPublisher.

Reimplemented from DtSimLocalEnvironmentalNetInterface.

---

Member Data Documentation

DtVrfEnvironmentalWeatherStateRecord* DtGlobalEnvironmentLocalNetInterface::myEnvironmentalStateRecord [protected]

---

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

• include/vrfobjcore/globalEnvironmentLocalNetIf.h