Boolean value parameter. More...

#include <coBooleanParam.h>

Inheritance diagram for covise::coBooleanParam:

Collaboration diagram for covise::coBooleanParam:

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

virtual	~coBooleanParam ()
	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 (bool value)
	set/update the value: return 0 on error More...

bool	getValue () const
	get the value 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 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	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 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...

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
	coBooleanParam (const coBooleanParam &)
	Copy-Constructor: NOT IMPLEMENTED. More...

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

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

Private Attributes
int	d_value
	Port data fields. More...

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

static const char *	s_type = "BOOL"

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

Boolean value parameter.

Constructor & Destructor Documentation

covise::coBooleanParam::coBooleanParam ( const coBooleanParam & )

private

Copy-Constructor: NOT IMPLEMENTED.

covise::coBooleanParam::coBooleanParam ( )

private

Default constructor: NOT IMPLEMENTED.

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

Constructor.

Constructor: needs coModule pointer to link in list

coBooleanParam::~coBooleanParam ( )

virtual

Destructor : virtual in case we derive objects.

Destructor : virtual in case we derive objects

Member Function Documentation

coUifPara::Typeinfo coBooleanParam::getType ( )

static

get my type

const char * coBooleanParam::getTypeString ( ) const

virtual

get the type string of this parameter

Implements covise::coUifPara.

const char * coBooleanParam::getValString ( ) const

virtual

get the value of this parameter as a string

Implements covise::coUifPara.

bool coBooleanParam::getValue ( ) const

get the value

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

void coBooleanParam::initialize ( )

virtual

give dafault values to Covise -> automatically called !

Implements covise::coUifPara.

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

virtual

Check the type.

Check the type

Implements covise::coUifPara.

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

private

Assignment operator: NOT IMPLEMENTED.

int coBooleanParam::paramChange ( )

virtual

handle parameter changes: called by paramCB

Implements covise::coUifPara.

void coBooleanParam::print ( ostream & str ) const

virtual

print this to a stream

Reimplemented from covise::coUifPara.

void coBooleanParam::setValString ( const char * str )

virtual

set the value of this parameter from a string

Implements covise::coUifPara.

int coBooleanParam::setValue ( bool 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

Member Data Documentation

int covise::coBooleanParam::d_value

private

Port data fields.

coUifPara::Typeinfo coBooleanParam::s_paraType = coUifPara::numericType("BOOL")

staticprivate

my type info

const char * coBooleanParam::s_type = "BOOL"

staticprivate

Static data

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

api/coBooleanParam.h
api/coBooleanParam.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