DtConstrainedIntegerInputPort Class Reference

Contains class declarations for DtConstrainedIntegerInputPort and DtConstrainedIntegerOutputPort. More...

Inheritance diagram for DtConstrainedIntegerInputPort:

Public Member Functions
	DtConstrainedIntegerInputPort (const DtString &portName)
virtual	~DtConstrainedIntegerInputPort ()
virtual void	receiveData (DtPortData *data)
	Overridden from base class to constrain data as it arrives to within min and max.
virtual void	setMinValue (int minVal)
	If you forget to set min and max, all values will be constrained to 0.
virtual int	minValue () const
virtual void	setMaxValue (int maxVal)
virtual int	maxValue () const
Public Member Functions inherited from DtIntegerInputPort
	DtIntegerInputPort (const DtString &portName)
virtual	~DtIntegerInputPort ()
virtual bool	acceptType (const DtString &type) const
	Accepts DtIntegerPortDataType.
virtual int	value () const
	Return the current value.
Public Member Functions inherited from DtSingleConnectionInputPort
	DtSingleConnectionInputPort (const DtString &portName)
	Constructor.
virtual	~DtSingleConnectionInputPort ()
	Destructor.
virtual void	receiveData (DtPortData *data, const DtPortConnection *conn=0)
	clones the specified DtPortData into myData, and sets the newDataFlag to true.
virtual const DtPortData *	data () const
	Returns the current pointer to a port data.
virtual bool	attemptToActivateConnection (DtPortConnection *conn, int connectionPriority)
	Attempt to make this connection the active connection providing data to this port with the specified priority.
virtual bool	canActivate (const DtPortConnection *conn, int connectionPriority) const
	Checks if this connection can be the active connection.
virtual void	deactivateConnection (DtPortConnection *conn)
	If conn is the currently active connection, it is deactivated and this port has no active input connection.
virtual bool	activeConnection () const
	Returns true if there is an active connection into this port.
virtual bool	connectionActive (const DtPortConnection *connection) const
	Returns true if the specified connection is currently active.
virtual int	connectionPriority () const
	Returns the current connection priority.
Public Member Functions inherited from DtInputPort
	DtInputPort (const DtString &portName)
	Constructor.
virtual	~DtInputPort ()
	Destructor.
virtual const DtString &	name () const
	Returns the name string of this port.
virtual void	addConnection (DtPortConnection *conn)
	Add an incomming connection to this port.
virtual void	removeConnection (DtPortConnection *conn)
	Remove an incomming connection to this port.
virtual const DtList *	connectionList () const
	Returns the list of input connections to this port.
virtual bool	newData () const
	Returns true if there is new data on this port that has not been received.
virtual void	dataReceived ()
	Clears the newData flag on this port.
virtual bool	enabled () const
	Enables/disables the port.
virtual void	setEnabled (bool flag)
	Enables/disables the port.

Protected Attributes
int	myMaxValue
int	myMinValue

Detailed Description

Contains class declarations for DtConstrainedIntegerInputPort and DtConstrainedIntegerOutputPort.

Instances of DtConstrainedIntegerInputPort are input ports that accept DtIntegerPortData as its data type, but will return values only within the specified min max range. It is possible to connect an unconstrained integer output port to this port.

Constructor & Destructor Documentation

DtConstrainedIntegerInputPort::DtConstrainedIntegerInputPort

(

const DtString &

portName

)

virtual DtConstrainedIntegerInputPort::~DtConstrainedIntegerInputPort ( )

virtual

Member Function Documentation

virtual void DtConstrainedIntegerInputPort::receiveData ( DtPortData *  data )

virtual

Overridden from base class to constrain data as it arrives to within min and max.

Reimplemented from DtIntegerInputPort.

virtual void DtConstrainedIntegerInputPort::setMinValue ( int  minVal )

virtual

If you forget to set min and max, all values will be constrained to 0.

virtual int DtConstrainedIntegerInputPort::minValue ( ) const

virtual

virtual void DtConstrainedIntegerInputPort::setMaxValue ( int  maxVal )

virtual

virtual int DtConstrainedIntegerInputPort::maxValue ( ) const

virtual

Member Data Documentation

int DtConstrainedIntegerInputPort::myMaxValue

protected

int DtConstrainedIntegerInputPort::myMinValue

protected

---

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

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