Input ports are data ports owned by data consumers. They receive data from a DtPortConnection, and make that data available to the user of the input port. Users of the port should call newData() to check if new data has arrived on this port, and then call dataReceived() to signal that they have received and processed the data currently on the port.

DtSinleConnectionInputPorts allow only a single active connection at a time. If a connection with a better priority attempts to activate, other connections will be deactivated.

This is an abstract base class. Derived types must provide an acceptType method that specifies which DtPortData types this port is capable if receiving, and accessors for the values within the DtPortData types it is accepting.

Inheritance diagram for DtMultiConnectionInputPort:

[legend]

Public Member Functions
	DtMultiConnectionInputPort (const DtString &portName)

virtual	~DtMultiConnectionInputPort () override

virtual void	receiveData (DtPortData data, const DtPortConnection conn) override

virtual bool	attemptToActivateConnection (DtPortConnection *conn, int connectionPriority) override

virtual bool	canActivate (const DtPortConnection *conn, int connectionPriority) const override

virtual void	deactivateConnection (DtPortConnection *conn) override

virtual bool	activeConnection () const override

virtual bool	connectionActive (const DtPortConnection *connection) const override

virtual int	connectionPriority () const override

virtual void	updateImgui () override

virtual void	updateImguiValue () override

Public Member Functions inherited from DtInputPort
	DtInputPort (const DtString &portName)

virtual	~DtInputPort ()

virtual const DtString &	name () const

virtual bool	acceptType (const DtString &type) const =0

virtual void	addConnection (DtPortConnection *conn)

virtual void	removeConnection (DtPortConnection *conn)

virtual const DtList *	connectionList () const

virtual bool	newData () const

virtual void	dataReceived ()

virtual bool	enabled () const

virtual void	setEnabled (bool flag)

Protected Attributes
DtMultiConnectionInputPortConnectionMap	myCurrentConnections

Protected Attributes inherited from DtInputPort
DtString	myName

bool	myNewDataFlag

bool	myEnabled

DtList	myConnectionList

Private Member Functions
	DtMultiConnectionInputPort ()

	DtMultiConnectionInputPort (const DtMultiConnectionInputPort &)

DtMultiConnectionInputPort &	operator= (const DtMultiConnectionInputPort &)

Constructor & Destructor Documentation

DtMultiConnectionInputPort::DtMultiConnectionInputPort ( const DtString & portName )

Constructor.

virtual DtMultiConnectionInputPort::~DtMultiConnectionInputPort ( )

overridevirtual

Destructor.

DtMultiConnectionInputPort::DtMultiConnectionInputPort ( )

private

Not implemented.

DtMultiConnectionInputPort::DtMultiConnectionInputPort ( const DtMultiConnectionInputPort & )

private

Not implemented.

Member Function Documentation

DtMultiConnectionInputPort& DtMultiConnectionInputPort::operator= ( const DtMultiConnectionInputPort & )

private

Not implemented.

virtual void DtMultiConnectionInputPort::receiveData	(	DtPortData *	data,
		const DtPortConnection *	conn
	)

overridevirtual

clones the specified DtPortData into the connection slot corresponding to the connection. conn must be an active connection for the data to be received.

Implements DtInputPort.

virtual bool DtMultiConnectionInputPort::attemptToActivateConnection	(	DtPortConnection *	conn,
		int	connectionPriority
	)

overridevirtual

Activated this connection by adding an entry for it in the myCurrentConnections list.

Implements DtInputPort.

virtual bool DtMultiConnectionInputPort::canActivate	(	const DtPortConnection *	conn,
		int	connectionPriority
	)		const

overridevirtual

Checks if this connection can be the active connection.

Implements DtInputPort.

virtual void DtMultiConnectionInputPort::deactivateConnection ( DtPortConnection * conn )

overridevirtual

If conn is the currently active connection, it is deactivated and this port has no active input connection.

Implements DtInputPort.

virtual bool DtMultiConnectionInputPort::activeConnection ( ) const

overridevirtual

Returns true if there is an active connection into this port.

Implements DtInputPort.

virtual bool DtMultiConnectionInputPort::connectionActive ( const DtPortConnection * connection ) const

overridevirtual

Returns true if the specified connection is currently active.

Implements DtInputPort.

virtual int DtMultiConnectionInputPort::connectionPriority ( ) const

overridevirtual

Always returns -1, since any number of active input conenctions are always allowed.

Implements DtInputPort.

virtual void DtMultiConnectionInputPort::updateImgui ( )

overridevirtual

Reimplemented from DtInputPort.

virtual void DtMultiConnectionInputPort::updateImguiValue ( )

overridevirtual

Override this function in subclasses to render an ImGui representation of the current value of the port.

Implements DtInputPort.

Member Data Documentation

DtMultiConnectionInputPortConnectionMap DtMultiConnectionInputPort::myCurrentConnections

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/multiConnectionInputPort.h

Public Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation