DtSimEnvironmentalNetInterface Class Reference

Class Description: DtSimEnvironmentalNetInterface. More...

Inheritance diagram for DtSimEnvironmentalNetInterface:

List of all members.

Public Member Functions
	DtSimEnvironmentalNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtSimEnvironmentalNetInterface (const DtSimEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimEnvironmentalNetInterface &	operator= (const DtSimEnvironmentalNetInterface &orig)
	assignment operator
virtual	~DtSimEnvironmentalNetInterface ()
	destructor
virtual bool	init ()
	override of base class init(), calls create<...>Record() functions
virtual DtControlObjectRepository *	environmentalNetworkState () const
virtual bool	isEntity () const
	Is this network interface for a local (true) or remote (false) object? Deriving network interfaces should implement this function to return the appropriate value.
virtual bool	isEnvironmental () const
Static Public Member Functions
static DtSimEnvironmentalNetInterface *	isEnvironmentalNetInterface (const DtSimObjectNetInterface *objNetInterface)
	This function will return the objNetInterface passed in, cast to a DtSimEntityNetInterface*, provided the objNetInterface is indeed an entity network interface.
Protected Member Functions
	DtSimEnvironmentalNetInterface ()
	default constructor

---

Detailed Description

Class Description: DtSimEnvironmentalNetInterface.

DtSimEnvironmentalNetInterface is an abstract base class that represents the interface between an environmental process objects local representation and its network (VR-Link) representation

---

Constructor & Destructor Documentation

DtSimEnvironmentalNetInterface::DtSimEnvironmentalNetInterface

(

)

[protected]

default constructor

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

read/writable contructor

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

copy constructor

virtual DtSimEnvironmentalNetInterface::~DtSimEnvironmentalNetInterface

(

)

[virtual]

destructor

---

Member Function Documentation

const DtSimEnvironmentalNetInterface& DtSimEnvironmentalNetInterface::operator=

(

const DtSimEnvironmentalNetInterface &

orig

)

assignment operator

virtual bool DtSimEnvironmentalNetInterface::init

(

)

[virtual]

override of base class init(), calls create<...>Record() functions

Reimplemented from DtSimObjectNetInterface.

Reimplemented in DtSimLocalEnvironmentalNetInterface, DtVrfRemoteEnvironmentalNetInterface, DtSimRemoteEnvironmentalNetInterface, and DtGlobalEnvironmentLocalNetInterface.

virtual DtControlObjectRepository* DtSimEnvironmentalNetInterface::environmentalNetworkState

(

)

const [virtual]

virtual bool DtSimEnvironmentalNetInterface::isEntity

(

)

const [inline, virtual]

Is this network interface for a local (true) or remote (false) object? Deriving network interfaces should implement this function to return the appropriate value.

Implements DtSimObjectNetInterface.

virtual bool DtSimEnvironmentalNetInterface::isEnvironmental

(

)

const [inline, virtual]

Implements DtSimObjectNetInterface.

Reimplemented in DtSimLocalEnvironmentalNetInterface.

static DtSimEnvironmentalNetInterface* DtSimEnvironmentalNetInterface::isEnvironmentalNetInterface

(

const DtSimObjectNetInterface *

objNetInterface

)

[static]

This function will return the objNetInterface passed in, cast to a DtSimEntityNetInterface*, provided the objNetInterface is indeed an entity network interface.

---

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

• include/vrfobjcore/envNetIface.h