DtObjectIdOutputPort Class Reference

Instances of DtObjectIdOutputPort are output ports through which data producers can send DtEntityIdentifier data. More...

Inheritance diagram for DtObjectIdOutputPort:

Public Member Functions
	DtObjectIdOutputPort (const DtString &portName)
virtual	~DtObjectIdOutputPort ()
virtual const DtString	type () const
	returns DtObjectIdPortDataType
virtual void	createPortData ()
	Creates a DtObjectIdPortData.
virtual void	setValue (const DtEntityIdentifier &id)
	Sets a value to the port, and sends the data if it is different from the current value.
virtual const DtEntityIdentifier	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 DtString &	name () 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 DtPortData *	data ()
	Returns a pointer to the underlying port.
virtual const DtPortData *	data () 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
DtPortData *	myData
	locally instantiated.
DtList	myConnectionList
	List of outgoing connections.

Detailed Description

Instances of DtObjectIdOutputPort are output ports through which data producers can send DtEntityIdentifier data.

Constructor & Destructor Documentation

DtObjectIdOutputPort::DtObjectIdOutputPort

(

const DtString &

portName

)

virtual DtObjectIdOutputPort::~DtObjectIdOutputPort ( )

virtual

Member Function Documentation

virtual const DtString DtObjectIdOutputPort::type ( ) const

virtual

returns DtObjectIdPortDataType

Implements DtOutputPort.

virtual void DtObjectIdOutputPort::createPortData ( )

virtual

Creates a DtObjectIdPortData.

Implements DtOutputPort.

virtual void DtObjectIdOutputPort::setValue ( const DtEntityIdentifier &  id )

virtual

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

virtual const DtEntityIdentifier DtObjectIdOutputPort::value ( ) const

virtual

Return the current value.

---

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

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