VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions
DtBooleanInputPort Class Reference

Contains class declarations for DtBooleanInputPort, DtBooleanOutputPort, and DtBooleanPortData. More...

Inheritance diagram for DtBooleanInputPort:
Inheritance graph
[legend]

Public Member Functions

 DtBooleanInputPort (const DtString &portName)
virtual ~DtBooleanInputPort ()
virtual bool acceptType (const DtString &type) const
 Accepts DtBooleanPortDataType.
virtual void receiveData (DtPortData *data)
 Overridden for optimization.
virtual bool value () const
 Return the current value.
- Public Member Functions inherited from DtSingleConnectionInputPort
 DtSingleConnectionInputPort (const DtString &portName)
 Constructor.
virtual ~DtSingleConnectionInputPort ()
 Destructor.
virtual void receiveData (DtPortData *data, const DtPortConnection *conn=0)
 clones the specified DtPortData into myData, and sets the newDataFlag to true.
virtual const DtPortDatadata () const
 Returns the current pointer to a port data.
virtual bool attemptToActivateConnection (DtPortConnection *conn, int connectionPriority)
 Attempt to make this connection the active connection providing data to this port with the specified priority.
virtual bool canActivate (const DtPortConnection *conn, int connectionPriority) const
 Checks if this connection can be the active connection.
virtual void deactivateConnection (DtPortConnection *conn)
 If conn is the currently active connection, it is deactivated and this port has no active input connection.
virtual bool activeConnection () const
 Returns true if there is an active connection into this port.
virtual bool connectionActive (const DtPortConnection *connection) const
 Returns true if the specified connection is currently active.
virtual int connectionPriority () const
 Returns the current connection priority.
- Public Member Functions inherited from DtInputPort
 DtInputPort (const DtString &portName)
 Constructor.
virtual ~DtInputPort ()
 Destructor.
virtual const DtStringname () const
 Returns the name string of this port.
virtual void addConnection (DtPortConnection *conn)
 Add an incomming connection to this port.
virtual void removeConnection (DtPortConnection *conn)
 Remove an incomming connection to this port.
virtual const DtList * connectionList () const
 Returns the list of input connections to this port.
virtual bool newData () const
 Returns true if there is new data on this port that has not been received.
virtual void dataReceived ()
 Clears the newData flag on this port.
virtual bool enabled () const
 Enables/disables the port.
virtual void setEnabled (bool flag)
 Enables/disables the port.

Additional Inherited Members

- Protected Attributes inherited from DtSingleConnectionInputPort
DtPortDatamyData
int myConnectionPriority
DtPortConnectionmyActiveConnection

Detailed Description

Contains class declarations for DtBooleanInputPort, DtBooleanOutputPort, and DtBooleanPortData.

Instances of DtBooleanInputPort are input ports through which data consumers can receive boolean data.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual bool DtBooleanInputPort::acceptType ( const DtString type) const
virtual

Accepts DtBooleanPortDataType.

Implements DtInputPort.

virtual void DtBooleanInputPort::receiveData ( DtPortData data)
virtual

Overridden for optimization.

Instead of cloning the data, this class copied the boolean from the incoming data to a local instance of port data.

virtual bool DtBooleanInputPort::value ( ) const
virtual

Return the current value.


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)