DtInputPortGroup Class Reference

DtInputPortGroup is a data port group of a data consumer. More...

Inheritance diagram for DtInputPortGroup:

Public Member Functions
	DtInputPortGroup (const DtString &name)
	Constructor.
virtual	~DtInputPortGroup ()
	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	newData () const
	Returns true if any of the contained ports have new data.
virtual void	dataReceived ()
	Calls dataReceived() on all contained ports.
virtual void	addPort (DtInputPort *port)
	Add a new port to the group.
virtual void	removePort (DtInputPort *port)
	Remove a port from the group.
virtual const DtList *	ports () const
	Returns the list of input ports in the group.
virtual const DtInputPort *	port (const DtString &portName) const
	Returns a pointer to the named port in this group.
virtual DtInputPort *	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 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 input ports.
DtList	myConnectionList
	List of DtPortGroupConnection.

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

Detailed Description

DtInputPortGroup is a data port group of a data consumer.

It may contain any number of DtInputPorts and other DtInputPortGroups. Calls made to the input port group make associated calls on all the groups and ports contained within it. It can be connected to a DtOutputPortGroup, which results in a connection between the individual ports and groups which are contained in each.

Constructor & Destructor Documentation

DtInputPortGroup::DtInputPortGroup

(

const DtString &

name

)

Constructor.

virtual DtInputPortGroup::~DtInputPortGroup ( )

virtual

Destructor.

DtInputPortGroup::DtInputPortGroup ( const DtInputPortGroup &  )

private

Not Implemented.

Member Function Documentation

DtInputPortGroup& DtInputPortGroup::operator= ( const DtInputPortGroup &  )

private

Not Implemented.

virtual const DtString& DtInputPortGroup::name ( ) const

virtual

Returns the name of this group.

virtual bool DtInputPortGroup::anyPortsActive ( ) const

virtual

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

virtual bool DtInputPortGroup::allPortsActive ( ) const

virtual

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

virtual bool DtInputPortGroup::newData ( ) const

virtual

Returns true if any of the contained ports have new data.

virtual void DtInputPortGroup::dataReceived ( )

virtual

Calls dataReceived() on all contained ports.

Call this from the consumer component to indicate that the data on the port has been processed.

virtual void DtInputPortGroup::addPort ( DtInputPort *  port )

virtual

Add a new port to the group.

virtual void DtInputPortGroup::removePort ( DtInputPort *  port )

virtual

Remove a port from the group.

virtual const DtList* DtInputPortGroup::ports ( ) const

virtual

Returns the list of input ports in the group.

virtual const DtInputPort* DtInputPortGroup::port ( const DtString &  portName ) const

virtual

Returns a pointer to the named port in this group.

virtual DtInputPort* DtInputPortGroup::port ( const DtString &  portName )

virtual

Non-const version of named port return.

virtual void DtInputPortGroup::addConnection ( DtPortGroupConnection *  conn )

virtual

Add an incomming connection to this port.

virtual void DtInputPortGroup::removeConnection ( DtPortGroupConnection *  conn )

virtual

Remove an incomming connection to this port.

virtual const DtList* DtInputPortGroup::connectionList ( ) const

virtual

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

virtual bool DtInputPortGroup::anyPortsEnabled ( ) const

virtual

Returns true if any of the contained ports is enabled.

virtual bool DtInputPortGroup::allPortsEnabled ( ) const

virtual

Returns true if all of the contained ports are enabled.

virtual void DtInputPortGroup::disableAllPorts ( )

virtual

Enables/disables the port group.

virtual void DtInputPortGroup::enableAllPorts ( )

virtual

Member Data Documentation

DtString DtInputPortGroup::myName

protected

DtHashlist* DtInputPortGroup::myPortList

protected

List of input ports.

DtList DtInputPortGroup::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/inputPortGroup.h