VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
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:
Inheritance graph
[legend]

List of all members.

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

Protected Attributes

DtEntityTargetList myEntityList

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


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:

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)