DtSensorContactListOutputPort Class Reference

Inheritance diagram for DtSensorContactListOutputPort:

Public Member Functions
	DtSensorContactListOutputPort (const DtString &portName)
virtual	~DtSensorContactListOutputPort ()
virtual bool	init ()
	Creates the internal contact list.
virtual const DtString	type () const
	returns DtSensorContactListPortDataType
virtual void	createPortData ()
	Creates a DtSensorContactListPortData.
virtual const DtSensorContactInfoList *	value () const
virtual DtSensorContactInfoList *	value ()
virtual void	useExternalContactList (DtSensorContactInfoList *contactList)
	Sets the supplied list as the list used, and sets myUsingExternalContactList to true.
Public Member Functions inherited from DtOutputPort
	DtOutputPort (const DtString &portName)
	Constructor.
virtual	~DtOutputPort ()
	Destructor.
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	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
	Returns a pointer to the underlying port.
virtual bool	enabled () const
	Enables/disables the port.
virtual void	setEnabled (bool flag)
	Enables/disables the port.

Protected Attributes
DtSensorContactInfoList *	myContactList
bool	myUsingExternalContactList
	True if myContactList was created outside this class.
Protected Attributes inherited from DtOutputPort
DtString	myName
bool	myEnabled
DtPortData *	myData
	locally instantiated.
DtList	myConnectionList
	List of outgoing connections.

Constructor & Destructor Documentation

DtSensorContactListOutputPort::DtSensorContactListOutputPort

(

const DtString &

portName

)

virtual DtSensorContactListOutputPort::~DtSensorContactListOutputPort ( )

virtual

Member Function Documentation

virtual bool DtSensorContactListOutputPort::init ( )

virtual

Creates the internal contact list.

Reimplemented from DtOutputPort.

virtual const DtString DtSensorContactListOutputPort::type ( ) const

virtual

returns DtSensorContactListPortDataType

Implements DtOutputPort.

virtual void DtSensorContactListOutputPort::createPortData ( )

virtual

Creates a DtSensorContactListPortData.

Implements DtOutputPort.

virtual const DtSensorContactInfoList* DtSensorContactListOutputPort::value ( ) const

virtual

virtual DtSensorContactInfoList* DtSensorContactListOutputPort::value ( )

virtual

virtual void DtSensorContactListOutputPort::useExternalContactList ( DtSensorContactInfoList *  contactList )

virtual

Sets the supplied list as the list used, and sets myUsingExternalContactList to true.

Warning: Calling this method will potentially invalidate any data on input ports connected to this port, since they may have pointers to the old contact list.

Member Data Documentation

DtSensorContactInfoList* DtSensorContactListOutputPort::myContactList

protected

bool DtSensorContactListOutputPort::myUsingExternalContactList

protected

True if myContactList was created outside this class.

---

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

• include/vrfobjcore/sensorContactListIOPort.h