VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Attributes
DtLaserDetectorOutputPort 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 DtLaserDetectorOutputPort:
Inheritance graph
[legend]

Public Member Functions

 DtLaserDetectorOutputPort (const DtString &portName)
virtual ~DtLaserDetectorOutputPort ()
virtual const DtString type () const
 returns DtLaserSpotPortDatatype
virtual void createPortData ()
 Creates a DtEntityListPortData.
virtual void emptyList ()
 Call this to remove all entities from the list.
virtual void addSpotReport (const DtLaserSpotData &spot)
 Call this to add an entity identifier to the list with discovery time of 0.
virtual void removeSpotReport (const DtLaserSpotData &spot)
 Call this to remove an entity from the list.
virtual const DtLaserSpotListvalue () const
- Public Member Functions inherited from DtOutputPort
 DtOutputPort (const DtString &portName)
 Constructor.
virtual ~DtOutputPort ()
 Destructor.
virtual bool init ()
 Call after the constructor.
virtual const DtStringname () 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 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 DtPortDatadata ()
 Returns a pointer to the underlying port.
virtual const DtPortDatadata () 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

DtLaserSpotList mySpotReportList
- Protected Attributes inherited from DtOutputPort
DtString myName
bool myEnabled
DtPortDatamyData
 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

DtLaserDetectorOutputPort::DtLaserDetectorOutputPort ( const DtString portName)
virtual DtLaserDetectorOutputPort::~DtLaserDetectorOutputPort ( )
virtual

Member Function Documentation

virtual const DtString DtLaserDetectorOutputPort::type ( ) const
virtual

returns DtLaserSpotPortDatatype

Implements DtOutputPort.

virtual void DtLaserDetectorOutputPort::createPortData ( )
virtual

Creates a DtEntityListPortData.

Implements DtOutputPort.

virtual void DtLaserDetectorOutputPort::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 DtLaserDetectorOutputPort::addSpotReport ( const DtLaserSpotData spot)
virtual

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

virtual void DtLaserDetectorOutputPort::removeSpotReport ( const DtLaserSpotData spot)
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 DtLaserSpotList* DtLaserDetectorOutputPort::value ( ) const
virtual

Member Data Documentation

DtLaserSpotList DtLaserDetectorOutputPort::mySpotReportList
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)