VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
DtBooleanOutputPort Class Reference

Instances of DtBooleanOutputPort are output ports through which data producers can send boolean data. More...

Inheritance diagram for DtBooleanOutputPort:
Inheritance graph
[legend]

Public Member Functions

 DtBooleanOutputPort (const DtString &portName)
virtual ~DtBooleanOutputPort ()
virtual const DtString type () const
 returns DtBooleanPortDataType
virtual void createPortData ()
 Creates a DtBooleanPortData.
virtual void setValue (bool value)
 Sets a value to the port, and sends the data if it is different from the current value.
virtual bool value () const
 Return the current value.
- 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 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 DtPortDatadata ()
 Returns a pointer to the underlying port.
virtual const DtPortDatadata () const
virtual bool enabled () const
 Enables/disables the port.
virtual void setEnabled (bool flag)

Additional Inherited Members

- Protected Attributes inherited from DtOutputPort
DtString myName
bool myEnabled
DtPortDatamyData
 locally instantiated.
DtList myConnectionList
 List of outgoing connections.

Detailed Description

Instances of DtBooleanOutputPort are output ports through which data producers can send boolean data.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual const DtString DtBooleanOutputPort::type ( ) const
virtual

returns DtBooleanPortDataType

Implements DtOutputPort.

virtual void DtBooleanOutputPort::createPortData ( )
virtual

Creates a DtBooleanPortData.

Implements DtOutputPort.

virtual void DtBooleanOutputPort::setValue ( bool  value)
virtual

Sets a value to the port, and sends the data if it is different from the current value.

virtual bool DtBooleanOutputPort::value ( ) const
virtual

Return the current value.


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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)