#include <coUifPara.h>

Inheritance diagram for covise::coUifPara:

Collaboration diagram for covise::coUifPara:

Public Types
typedef int	Typeinfo

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

Public Member Functions
	coUifPara (const char name, const char desc)

virtual	~coUifPara ()
	Destructor. More...

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

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

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

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

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

virtual void	initialize ()=0
	give all necessary info to Covise -> automatically called ! More...

virtual void	print (ostream &str) const
	print this to a stream: overloaded, but called by derived classes More...

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

virtual int	isOfType (coUifPara::Typeinfo type)=0
	check whether this parameter port has a certain type More...

virtual void	enable ()
	enable More...

virtual void	disable ()
	disable 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...

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

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

virtual void	setValString (const char *str)=0
	set the value of this parameter from a string 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 Protected Member Functions
static Typeinfo	numericType (const char *typeStr)

Protected Attributes
int	d_active

Protected Attributes inherited from covise::coPort
char *	d_name

char *	d_desc

char *	d_defString

int	d_init

Private Member Functions
coUifPara &	operator= (const coUifPara &)
	Assignment operator: NOT IMPLEMENTED. More...

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

	coUifPara (const coUifPara &old)
	Copy-constructor: NOT IMPLEMENTED. More...

Additional Inherited Members
Protected Types inherited from covise::coPort
typedef int	Typeinfo

Member Typedef Documentation

typedef int covise::coUifPara::Typeinfo

Constructor & Destructor Documentation

covise::coUifPara::coUifPara ( )

private

Default constructor: NOT IMPLEMENTED.

covise::coUifPara::coUifPara ( const coUifPara & old )

private

Copy-constructor: NOT IMPLEMENTED.

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

Create a parameter with a certain type

Parameters

name	Port name
desc	Port description

coUifPara::~coUifPara ( )

virtual

Destructor.

Member Function Documentation

void coUifPara::disable ( )

virtual

disable

Reimplemented in covise::coTimerParam.

void coUifPara::enable ( )

virtual

enable

Reimplemented in covise::coTimerParam.

virtual const char* covise::coUifPara::getTypeString ( ) const

pure virtual

get the type string of this parameter

Implemented in covise::coChoiceParam, covise::coColormapParam, covise::coTimerParam, covise::coFloatVectorParam, covise::coIntVectorParam, covise::coFloatSliderParam, covise::coIntSliderParam, covise::coFileBrowserParam, covise::coBooleanParam, covise::coFloatParam, covise::coIntScalarParam, covise::coStringParam, covise::coColorParam, covise::coColormapChoiceParam, and covise::coMaterialParam.

virtual const char* covise::coUifPara::getValString ( ) const

pure virtual

get the value of this parameter as a string

Implemented in covise::coChoiceParam, covise::coColormapParam, covise::coTimerParam, covise::coFloatVectorParam, covise::coIntVectorParam, covise::coFloatSliderParam, covise::coIntSliderParam, covise::coFileBrowserParam, covise::coBooleanParam, covise::coFloatParam, covise::coIntScalarParam, covise::coStringParam, covise::coColorParam, covise::coColormapChoiceParam, and covise::coMaterialParam.

void coUifPara::hide ( )

virtual

Hide this port.

Reimplemented from covise::coUifElem.

Reimplemented in covise::coTimerParam.

virtual void covise::coUifPara::initialize ( )

pure virtual

give all necessary info to Covise -> automatically called !

Implements covise::coPort.

Implemented in covise::coColormapParam, covise::coChoiceParam, covise::coFloatVectorParam, covise::coIntVectorParam, covise::coFileBrowserParam, covise::coBooleanParam, covise::coFloatParam, covise::coFloatSliderParam, covise::coIntScalarParam, covise::coIntSliderParam, covise::coStringParam, covise::coTimerParam, covise::coColorParam, covise::coColormapChoiceParam, and covise::coMaterialParam.

int coUifPara::isActive ( ) const

check whether this port is active

virtual int covise::coUifPara::isOfType ( coUifPara::Typeinfo type )

pure virtual

check whether this parameter port has a certain type

Implemented in covise::coColormapParam, covise::coChoiceParam, covise::coFloatVectorParam, covise::coIntVectorParam, covise::coFileBrowserParam, covise::coBooleanParam, covise::coFloatParam, covise::coFloatSliderParam, covise::coIntScalarParam, covise::coIntSliderParam, covise::coStringParam, covise::coTimerParam, covise::coColorParam, covise::coColormapChoiceParam, and covise::coMaterialParam.

coUifElem::Kind coUifPara::kind ( ) const

virtual

return my type of element: returns coUifElem::PARAM

return my type of element

Implements covise::coPort.

coUifPara::Typeinfo coUifPara::numericType ( const char * typeStr )

staticprotected

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

private

Assignment operator: NOT IMPLEMENTED.

void coUifPara::para_error ( const char * what )

send an error message strarting with "Parameter '<name>' "

virtual int covise::coUifPara::paramChange ( )

pure virtual

handle parameter changes: called by paramCB

Reimplemented from covise::coUifElem.

Implemented in covise::coColormapParam, covise::coChoiceParam, covise::coFloatVectorParam, covise::coIntVectorParam, covise::coFileBrowserParam, covise::coBooleanParam, covise::coFloatParam, covise::coFloatSliderParam, covise::coIntScalarParam, covise::coIntSliderParam, covise::coStringParam, covise::coTimerParam, covise::coColorParam, covise::coColormapChoiceParam, and covise::coMaterialParam.

virtual int covise::coUifPara::preCompute ( )

inlinevirtual

do whatever needed before compute CB : enforce that all parameters do sth.

Reimplemented from covise::coUifElem.

void coUifPara::print ( ostream & str ) const

virtual

print this to a stream: overloaded, but called by derived classes

print this to a stream

Implements covise::coPort.

Reimplemented in covise::coColormapParam, covise::coChoiceParam, covise::coFloatVectorParam, covise::coIntVectorParam, covise::coFileBrowserParam, covise::coBooleanParam, covise::coFloatParam, covise::coFloatSliderParam, covise::coIntScalarParam, covise::coIntSliderParam, covise::coStringParam, covise::coTimerParam, covise::coColorParam, covise::coColormapChoiceParam, and covise::coMaterialParam.

void coUifPara::setActive ( int isActive )

virtual

activate / de_activate the parameter

Reimplemented in covise::coTimerParam.

virtual void covise::coUifPara::setValString ( const char * str )

pure virtual

set the value of this parameter from a string

Implemented in covise::coChoiceParam, covise::coColormapParam, covise::coTimerParam, covise::coFloatVectorParam, covise::coIntVectorParam, covise::coFloatSliderParam, covise::coIntSliderParam, covise::coFileBrowserParam, covise::coBooleanParam, covise::coFloatParam, covise::coIntScalarParam, covise::coStringParam, covise::coColorParam, covise::coColormapChoiceParam, and covise::coMaterialParam.

void coUifPara::show ( )

virtual

Show this port.

Show everything below.

Reimplemented from covise::coUifElem.

Reimplemented in covise::coTimerParam.

int coUifPara::switchable ( ) const

virtual

whether this port can be switched: default is true, overload for false

whether this port can be switched : default is true

Reimplemented from covise::coUifElem.

Member Data Documentation

int covise::coUifPara::d_active

protected

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

api/coUifPara.h
api/coUifPara.cpp

Public Types

Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation