DtConstrainedAnalogInputPort Class Reference

Contains class declarations for DtConstrainedAnalogInputPort and DtConstrainedAnalogOutputPort. More...

Inheritance diagram for DtConstrainedAnalogInputPort:

Public Member Functions
	DtConstrainedAnalogInputPort (const DtString &portName)
virtual	~DtConstrainedAnalogInputPort ()
virtual void	receiveData (DtPortData *data)
	Overridden from base class to constrain data as it arrives to within min and max.
virtual void	setMinValue (double minVal)
	If you forget to set min and max, all values will be constrained to 0.
virtual double	minValue () const
virtual void	setMaxValue (double maxVal)
virtual double	maxValue () const
Public Member Functions inherited from DtAnalogInputPort
	DtAnalogInputPort (const DtString &portName)
virtual	~DtAnalogInputPort ()
virtual bool	acceptType (const DtString &type) const
	Accepts DtAnalogPortDataType.
virtual double	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)

Protected Attributes
double	myMaxValue
double	myMinValue

Detailed Description

Contains class declarations for DtConstrainedAnalogInputPort and DtConstrainedAnalogOutputPort.

Instances of DtConstrianedAnalogInputPort are input ports that accept DtAnalogPortData as the data type, but will allow values only within the specified min max range. The default minimum and maximum values are 0.0.

Note

It is possible to connect an unconstrained analog output port to this port.

Constructor & Destructor Documentation

DtConstrainedAnalogInputPort::DtConstrainedAnalogInputPort

(

const DtString &

portName

)

virtual DtConstrainedAnalogInputPort::~DtConstrainedAnalogInputPort ( )

virtual

Member Function Documentation

virtual void DtConstrainedAnalogInputPort::receiveData ( DtPortData *  data )

virtual

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

Reimplemented from DtAnalogInputPort.

virtual void DtConstrainedAnalogInputPort::setMinValue ( double  minVal )

virtual

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

virtual double DtConstrainedAnalogInputPort::minValue ( ) const

virtual

virtual void DtConstrainedAnalogInputPort::setMaxValue ( double  maxVal )

virtual

virtual double DtConstrainedAnalogInputPort::maxValue ( ) const

virtual

Member Data Documentation

double DtConstrainedAnalogInputPort::myMaxValue

protected

double DtConstrainedAnalogInputPort::myMinValue

protected

---

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

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