DtEntityListOutputPort Class Reference

Instances of DtEntityListOutputPort are output ports through which data producers can send a list of object IDs of simulated entities (local and/or remote).

Inheritance diagram for DtEntityListOutputPort:

Public Member Functions
	DtEntityListOutputPort (const DtString &portName)
virtual	~DtEntityListOutputPort () override
virtual const DtString	type () const override
virtual void	createPortData () override
virtual void	emptyList ()
virtual void	addEntity (const DtEntityIdentifier &id)
virtual void	addEntity (const DtEntityTargetInformation &info)
virtual void	removeEntity (const DtEntityIdentifier &id)
bool	hasEntity (const DtEntityIdentifier &id) const
virtual const DtEntityTargetList *	value () const
Public Member Functions inherited from DtOutputPort
	DtOutputPort (const DtString &portName)
virtual	~DtOutputPort ()
virtual bool	init ()
virtual const DtString &	name () const
virtual void	sendData ()
virtual void	addConnection (DtPortConnection *conn)
virtual void	removeConnection (DtPortConnection *conn)
virtual bool	attemptToActivate ()
virtual bool	attemptToActivateAtLowestPriority ()
virtual bool	canActivate () const
virtual void	deactivate ()
virtual void	allowDeactivation ()
virtual bool	active () const
virtual const DtList *	connectionList () const
virtual void	setConnectionPriority (int priority)
virtual void	updateImgui ()
virtual void	updateImguiValue ()
virtual DtPortData *	data ()
virtual const DtPortData *	data () const
virtual bool	enabled () const
virtual void	setEnabled (bool flag)

Protected Attributes
DtEntityTargetList	myEntityList
Protected Attributes inherited from DtOutputPort
DtString	myName
bool	myEnabled
DtPortData *	myData
DtList	myConnectionList

Constructor & Destructor Documentation

DtEntityListOutputPort::DtEntityListOutputPort

(

const DtString &

portName

)

virtual DtEntityListOutputPort::~DtEntityListOutputPort ( )

overridevirtual

Member Function Documentation

virtual const DtString DtEntityListOutputPort::type ( ) const

overridevirtual

returns DtEntityListPortDataType

Implements DtOutputPort.

virtual void DtEntityListOutputPort::createPortData ( )

overridevirtual

Creates a DtEntityListPortData.

Implements DtOutputPort.

virtual void DtEntityListOutputPort::emptyList ( )

virtual

Call this to remove all entities from the list. It does not delete the entities, just the local object id that it stores.

virtual void DtEntityListOutputPort::addEntity ( const DtEntityIdentifier &  id )

virtual

Call this to add an entity identifier to the list with discovery time of 0.

virtual void DtEntityListOutputPort::addEntity ( const DtEntityTargetInformation &  info )

virtual

Call this to add an entity information block to the list. Keyed on identifier.

virtual void DtEntityListOutputPort::removeEntity ( const DtEntityIdentifier &  id )

virtual

Call this to remove an entity from the list. It does not delete the entity, just the local object id that it stores.

bool DtEntityListOutputPort::hasEntity

(

const DtEntityIdentifier &

id

)

const

Returns true if the list contains the specified entity.

virtual const DtEntityTargetList* DtEntityListOutputPort::value ( ) const

virtual

Member Data Documentation

DtEntityTargetList DtEntityListOutputPort::myEntityList

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/entListIOPort.h