Integer slider parameter. More...

#include <coTimerParam.h>

Inheritance diagram for covise::coTimerParam:

Collaboration diagram for covise::coTimerParam:

Public Member Functions
	coTimerParam (const char name, const char desc)
	Constructor. More...

virtual	~coTimerParam ()
	Destructor : virtual in case we derive objects. More...

virtual int	isOfType (coUifPara::Typeinfo type)
	Check the type. More...

virtual int	paramChange ()
	handle parameter changes: called by paramCB More...

virtual void	initialize ()
	give dafault values to Covise -> automatically called ! More...

virtual void	print (ostream &str) const
	print this to a stream More...

int	setValue (long start, long delta, long state)
	set/update the value: return 0 on error More...

int	setStart (long start)

int	setDelta (long delta)

int	setState (long state)

void	getValue (long &start, long &delta, long &state) const
	get the value More...

long	getStart () const

long	getDelta () const

long	getState () const

virtual void	setImmediate (int isImmediate)
	The Timer is special: all these are not supported. More...

virtual void	setActive (int isActive)
	activate / de_activate the parameter More...

virtual void	enable ()
	enable More...

virtual void	disable ()
	disable More...

virtual void	hide ()
	Hide this port. More...

virtual void	show ()
	Show this port. More...

virtual const char *	getTypeString () const
	get the type string of this parameter More...

virtual const char *	getValString () const
	get the value of this parameter as a string More...

virtual void	setValString (const char *str)
	set the value of this parameter from a string More...

Public Member Functions inherited from covise::coUifPara
	coUifPara (const char name, const char desc)

virtual	~coUifPara ()
	Destructor. More...

virtual int	preCompute ()
	do whatever needed before compute CB : enforce that all parameters do sth. More...

virtual int	switchable () const
	whether this port can be switched: default is true, overload for false More...

virtual Kind	kind () const
	return my type of element: returns coUifElem::PARAM More...

int	isActive () const
	check whether this port is active More...

void	para_error (const char *what)
	send an error message strarting with "Parameter '<name>' " More...

Public Member Functions inherited from covise::coPort
	coPort (const char name, const char desc)

virtual	~coPort ()
	Destructor : virtual in case we derive objects. More...

virtual const char *	getName () const
	get the name of this object More...

virtual const char *	getDesc () const
	get the description of this object More...

int	isConnected () const
	Return whether this port is connected -> valid only in compute() More...

void	setInfo (const char *value) const
	Set the info Popup text. More...

Public Member Functions inherited from covise::coUifElem
virtual	~coUifElem ()
	Destructor : virtual because we derive objects. More...

virtual int	postCompute ()
	do whatever is needed after compute CB : pre-set to do nothing More...

Static Public Member Functions
static coUifPara::Typeinfo	getType ()
	get my type More...

Private Member Functions
	coTimerParam (const coTimerParam &)
	Copy-Constructor: NOT IMPLEMENTED. More...

coTimerParam &	operator= (const coTimerParam &)
	Assignment operator: NOT IMPLEMENTED. More...

	coTimerParam ()
	Default constructor: NOT IMPLEMENTED. More...

Private Attributes
long	d_start
	Port data fields. More...

long	d_delta

long	d_state

Static Private Attributes
static coUifPara::Typeinfo	s_paraType = coUifPara::numericType("TIMERP")
	my type info More...

static const char *	s_type = "TIMERP"

Additional Inherited Members
Public Types inherited from covise::coUifPara
typedef int	Typeinfo

Public Types inherited from covise::coUifElem
enum	Kind { SWITCH, PARAM, INPORT, OUTPORT }
	enum Kind: SWITCH, PARAM, INPORT, OUTPORT More...

Protected Types inherited from covise::coPort
typedef int	Typeinfo

Static Protected Member Functions inherited from covise::coUifPara
static Typeinfo	numericType (const char *typeStr)

Protected Attributes inherited from covise::coUifPara
int	d_active

Protected Attributes inherited from covise::coPort
char *	d_name

char *	d_desc

char *	d_defString

int	d_init

Detailed Description

Integer slider parameter.

Constructor & Destructor Documentation

covise::coTimerParam::coTimerParam ( const coTimerParam & )

private

Copy-Constructor: NOT IMPLEMENTED.

covise::coTimerParam::coTimerParam ( )

private

Default constructor: NOT IMPLEMENTED.

coTimerParam::coTimerParam	(	const char *	name,
		const char *	desc
	)

Constructor.

Constructor

coTimerParam::~coTimerParam ( )

virtual

Destructor : virtual in case we derive objects.

Destructor : virtual in case we derive objects

Member Function Documentation

void coTimerParam::disable ( )

virtual

disable

Reimplemented from covise::coUifPara.

void coTimerParam::enable ( )

virtual

enable

Reimplemented from covise::coUifPara.

long coTimerParam::getDelta ( ) const

long coTimerParam::getStart ( ) const

long coTimerParam::getState ( ) const

coUifPara::Typeinfo coTimerParam::getType ( )

static

get my type

const char * coTimerParam::getTypeString ( ) const

virtual

get the type string of this parameter

Implements covise::coUifPara.

const char * coTimerParam::getValString ( ) const

virtual

get the value of this parameter as a string

Implements covise::coUifPara.

void coTimerParam::getValue	(	long &	start,
		long &	delta,
		long &	state
	)		const

get the value

void coTimerParam::hide ( )

virtual

Hide this port.

Reimplemented from covise::coUifPara.

void coTimerParam::initialize ( )

virtual

give dafault values to Covise -> automatically called !

Implements covise::coUifPara.

int coTimerParam::isOfType ( coUifPara::Typeinfo type )

virtual

Check the type.

Check the type

Implements covise::coUifPara.

coTimerParam& covise::coTimerParam::operator= ( const coTimerParam & )

private

Assignment operator: NOT IMPLEMENTED.

int coTimerParam::paramChange ( )

virtual

handle parameter changes: called by paramCB

Implements covise::coUifPara.

void coTimerParam::print ( ostream & str ) const

virtual

print this to a stream

Reimplemented from covise::coUifPara.

void coTimerParam::setActive ( int isActive )

virtual

activate / de_activate the parameter

Reimplemented from covise::coUifPara.

int coTimerParam::setDelta ( long delta )

If we have been initialized, update the map

void coTimerParam::setImmediate ( int isImmediate )

virtual

The Timer is special: all these are not supported.

prohibit some functions

int coTimerParam::setStart ( long start )

If we have been initialized, update the map

int coTimerParam::setState ( long state )

If we have been initialized, update the map

void coTimerParam::setValString ( const char * str )

virtual

set the value of this parameter from a string

Implements covise::coUifPara.

int coTimerParam::setValue	(	long	min,
		long	max,
		long	value
	)

set/update the value: return 0 on error

set the value: if called after init() : update on map

If we have been initialized, update the map

void coTimerParam::show ( )

virtual

Show this port.

Show everything below.

Reimplemented from covise::coUifPara.

Member Data Documentation

long covise::coTimerParam::d_delta

private

long covise::coTimerParam::d_start

private

Port data fields.

long covise::coTimerParam::d_state

private

coUifPara::Typeinfo coTimerParam::s_paraType = coUifPara::numericType("TIMERP")

staticprivate

my type info

const char * coTimerParam::s_type = "TIMERP"

staticprivate

Static data

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

api/coTimerParam.h
api/coTimerParam.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation