VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
DtOutputPortGroup Class Reference

DtOutputPortGroup is a data port group of a data provider. It may contain any number of DtOutputPorts and other DtOutputPortGroups. Calls made to the output port group make associated calls on all the groups and ports contained within it.

Related Examples

Inheritance diagram for DtOutputPortGroup:
Inheritance graph
[legend]

Public Member Functions

 DtOutputPortGroup (const DtString &name)
 
virtual ~DtOutputPortGroup ()
 
virtual const DtStringname () const
 
virtual bool anyPortsActive () const
 
virtual bool allPortsActive () const
 
virtual bool attemptToActivate ()
 
virtual bool canActivate ()
 
virtual bool attemptToActivateAllPorts ()
 
virtual bool canActivateAllPorts ()
 
virtual void deactivate ()
 
virtual void allowDeactivation ()
 
virtual void sendData ()
 
virtual void addPort (DtOutputPort *port)
 
virtual void removePort (DtOutputPort *port)
 
virtual const DtList * ports () const
 
virtual const DtOutputPortport (const DtString &portName) const
 
virtual DtOutputPortport (const DtString &portName)
 
virtual void addConnection (DtPortGroupConnection *conn)
 
virtual void removeConnection (DtPortGroupConnection *conn)
 
virtual const DtList * connectionList () const
 
virtual void setConnectionPriority (int priority)
 
virtual bool anyPortsEnabled () const
 
virtual bool allPortsEnabled () const
 
virtual void disableAllPorts ()
 
virtual void enableAllPorts ()
 

Protected Attributes

DtString myName
 
DtHashlist * myPortList
 
DtList myConnectionList
 

Private Member Functions

 DtOutputPortGroup (const DtOutputPortGroup &)
 
DtOutputPortGroupoperator= (const DtOutputPortGroup &)
 

Constructor & Destructor Documentation

DtOutputPortGroup::DtOutputPortGroup ( const DtString name)

Constructor.

virtual DtOutputPortGroup::~DtOutputPortGroup ( )
virtual

Destructor.

DtOutputPortGroup::DtOutputPortGroup ( const DtOutputPortGroup )
private

Not Implemented.

Member Function Documentation

DtOutputPortGroup& DtOutputPortGroup::operator= ( const DtOutputPortGroup )
private

Not Implemented.

virtual const DtString& DtOutputPortGroup::name ( ) const
virtual

Returns the name of this group.

virtual bool DtOutputPortGroup::anyPortsActive ( ) const
virtual

Returns true if any of the contained ports have an active connection.

virtual bool DtOutputPortGroup::allPortsActive ( ) const
virtual

Returns true only if ALL of the contained ports have an active connection.

virtual bool DtOutputPortGroup::attemptToActivate ( )
virtual

Calls attemptToActivate() on all contained ports. Returns true if ANY of the contained ports were able to activate.

virtual bool DtOutputPortGroup::canActivate ( )
virtual

Calls canActivate() on all contained ports. Returns true if ANY of the contained ports can activate.

virtual bool DtOutputPortGroup::attemptToActivateAllPorts ( )
virtual

Calls attemptToActivate() on all contained ports. Returns true if ALL of the contained ports were able to activate. If any ports fail to activate, deactivate() will be called.

virtual bool DtOutputPortGroup::canActivateAllPorts ( )
virtual

Calls canActivate() on all contained ports. Returns true if ALL of the contained ports can be activated.

virtual void DtOutputPortGroup::deactivate ( )
virtual

Calls deactivate() on all contained ports. Call this when you have no data to supply.

virtual void DtOutputPortGroup::allowDeactivation ( )
virtual

Calls allowDeactivation on all contained ports. Call this when you have data to supply, but will allow your data to be overridden by others.

virtual void DtOutputPortGroup::sendData ( )
virtual

Calls sendData() on all contained ports.

virtual void DtOutputPortGroup::addPort ( DtOutputPort port)
virtual

Add a new port to the group.

virtual void DtOutputPortGroup::removePort ( DtOutputPort port)
virtual

Remove a port from the group.

virtual const DtList* DtOutputPortGroup::ports ( ) const
virtual

Returns the list of input ports in the group.

virtual const DtOutputPort* DtOutputPortGroup::port ( const DtString portName) const
virtual

Returns a pointer to the named port in this group.

virtual DtOutputPort* DtOutputPortGroup::port ( const DtString portName)
virtual

Non-const version of named port return.

virtual void DtOutputPortGroup::addConnection ( DtPortGroupConnection conn)
virtual

Add an incomming connection to this port.

virtual void DtOutputPortGroup::removeConnection ( DtPortGroupConnection conn)
virtual

Remove an incomming connection to this port.

virtual const DtList* DtOutputPortGroup::connectionList ( ) const
virtual

Returns the list of DtPortGroupConnection objects associated with this port group.

virtual void DtOutputPortGroup::setConnectionPriority ( int  priority)
virtual

Sets the priority of all existing outgoing connections from this port group to the new priority.

virtual bool DtOutputPortGroup::anyPortsEnabled ( ) const
virtual

Returns true if any of the contained ports is enabled.

virtual bool DtOutputPortGroup::allPortsEnabled ( ) const
virtual

Returns true if all of the contained ports are enabled.

virtual void DtOutputPortGroup::disableAllPorts ( )
virtual

Enables/disables the port group.

virtual void DtOutputPortGroup::enableAllPorts ( )
virtual

Member Data Documentation

DtString DtOutputPortGroup::myName
protected
DtHashlist* DtOutputPortGroup::myPortList
protected

List of output ports.

DtList DtOutputPortGroup::myConnectionList
protected

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

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)