DtOutputPortGroup Class Reference

DtOutputPortGroup is a data port group of a data provider. More...

Inheritance diagram for DtOutputPortGroup:

Public Member Functions
	DtOutputPortGroup (const DtString &name)
	Constructor.
virtual	~DtOutputPortGroup ()
	Destructor.
virtual const DtString &	name () const
	Returns the name of this group.
virtual bool	anyPortsActive () const
	Returns true if any of the contained ports have an active connection.
virtual bool	allPortsActive () const
	Returns true only if ALL of the contained ports have an active connection.
virtual bool	attemptToActivate ()
	Calls attemptToActivate() on all contained ports.
virtual bool	canActivate ()
	Calls canActivate() on all contained ports.
virtual bool	attemptToActivateAllPorts ()
	Calls attemptToActivate() on all contained ports.
virtual bool	canActivateAllPorts ()
	Calls canActivate() on all contained ports.
virtual void	deactivate ()
	Calls deactivate() on all contained ports.
virtual void	allowDeactivation ()
	Calls allowDeactivation on all contained ports.
virtual void	sendData ()
	Calls sendData() on all contained ports.
virtual void	addPort (DtOutputPort *port)
	Add a new port to the group.
virtual void	removePort (DtOutputPort *port)
	Remove a port from the group.
virtual const DtList *	ports () const
	Returns the list of input ports in the group.
virtual const DtOutputPort *	port (const DtString &portName) const
	Returns a pointer to the named port in this group.
virtual DtOutputPort *	port (const DtString &portName)
	Non-const version of named port return.
virtual void	addConnection (DtPortGroupConnection *conn)
	Add an incomming connection to this port.
virtual void	removeConnection (DtPortGroupConnection *conn)
	Remove an incomming connection to this port.
virtual const DtList *	connectionList () const
	Returns the list of DtPortGroupConnection objects associated with this port group.
virtual void	setConnectionPriority (int priority)
	Sets the priority of all existing outgoing connections from this port group to the new priority.
virtual bool	anyPortsEnabled () const
	Returns true if any of the contained ports is enabled.
virtual bool	allPortsEnabled () const
	Returns true if all of the contained ports are enabled.
virtual void	disableAllPorts ()
	Enables/disables the port group.
virtual void	enableAllPorts ()

Protected Attributes
DtString	myName
DtHashlist *	myPortList
	List of output ports.
DtList	myConnectionList
	List of DtPortGroupConnection.

Private Member Functions
	DtOutputPortGroup (const DtOutputPortGroup &)
	Not Implemented.
DtOutputPortGroup &	operator= (const DtOutputPortGroup &)
	Not Implemented.

Detailed Description

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.

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

List of DtPortGroupConnection.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/outputPortGroup.h