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). More...

Inheritance diagram for DtEntityListOutputPort:

Public Member Functions
	DtEntityListOutputPort (const DtString &portName)
virtual	~DtEntityListOutputPort ()
virtual const DtString	type () const
	returns DtEntityListPortDataType
virtual void	createPortData ()
	Creates a DtEntityListPortData.
virtual void	emptyList ()
	Call this to remove all entities from the list.
virtual void	addEntity (const DtEntityIdentifier &id)
	Call this to add an entity identifier to the list with discovery time of 0.
virtual void	addEntity (const DtEntityTargetInformation &info)
	Call this to add an entity information block to the list.
virtual void	removeEntity (const DtEntityIdentifier &id)
	Call this to remove an entity from the list.
virtual const DtEntityTargetList *	value () const
Public Member Functions inherited from DtOutputPort
	DtOutputPort (const DtString &portName)
	Constructor.
virtual	~DtOutputPort ()
	Destructor.
virtual bool	init ()
	Call after the constructor.
virtual const DtString &	name () const
	Returns the string name of this port.
virtual void	sendData ()
	Sends the contents of myData to all connections.
virtual void	addConnection (DtPortConnection *conn)
	Add a connection to the outgoing connection list.
virtual void	removeConnection (DtPortConnection *conn)
	Remove a connection from the outgoing connection list.
virtual bool	attemptToActivate ()
	Calls attemptToActivate on all connections in the connection list and returns true if any one of them was able to activate.
virtual bool	attemptToActivateAtLowestPriority ()
	Calls attemptToActivate on all connections in the connection list and returns true if any one of them was able to activate, but will not override data from any others and will allow deactivation in the case another wants to provide data.
virtual bool	canActivate () const
	Calls canActivate on all connections in the connection list and returns true if any one of them can be activated.
virtual void	deactivate ()
	Calls deactivate on all connections in the connection list.
virtual void	allowDeactivation ()
	Calls allowDeactivation on all connections in the connection list.
virtual bool	active () const
	Returns true if any one of the outgoing connection are active.
virtual const DtList *	connectionList () const
	Returns the list of output connections to this port.
virtual void	setConnectionPriority (int priority)
	Sets the priority of all existing outgoing connections from this port to the new priority.
virtual DtPortData *	data ()
	Returns a pointer to the underlying port.
virtual const DtPortData *	data () const
	Returns a pointer to the underlying port.
virtual bool	enabled () const
	Enables/disables the port.
virtual void	setEnabled (bool flag)
	Enables/disables the port.

Protected Attributes
DtEntityTargetList	myEntityList
Protected Attributes inherited from DtOutputPort
DtString	myName
bool	myEnabled
DtPortData *	myData
	locally instantiated.
DtList	myConnectionList
	List of outgoing connections.

Detailed Description

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

Constructor & Destructor Documentation

DtEntityListOutputPort::DtEntityListOutputPort

(

const DtString &

portName

)

virtual DtEntityListOutputPort::~DtEntityListOutputPort ( )

virtual

Member Function Documentation

virtual const DtString DtEntityListOutputPort::type ( ) const

virtual

returns DtEntityListPortDataType

Implements DtOutputPort.

virtual void DtEntityListOutputPort::createPortData ( )

virtual

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.

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfobjcore/entListIOPort.h