covise::coUifSwitch Class Reference

#include <coUifSwitch.h>

Inheritance diagram for covise::coUifSwitch:

Collaboration diagram for covise::coUifSwitch:

Public Member Functions
	coUifSwitch (const char *name, const char *label, int toplevel)
	Constructor: give a name for the switch and a descriptive label. More...
virtual	~coUifSwitch ()
	Destructor. More...
coUifSwitchCase *	addCase (const char *name)
int	finish ()
	finalize switch : returns number of switch entries More...
virtual void	hide ()
	Hide everything below. More...
virtual void	show ()
	Show everything below. More...
virtual Kind	kind () const
	return my type of element More...
virtual const char *	getName () const
	get the name of this object More...
virtual int	paramChange ()
	handle parameter changes: called by paramCB More...
virtual int	setNonImmediateValue ()
	retrieve the values from an EXEC call in compute CB More...
virtual void	initialize ()
	give all necessary info to Covise -> automatically called by coModule in init() More...
virtual int	switchable () const
	whether this can be a part-object of a switch More...
int	isTopLevel () const
	whether this switch is on top-level More...
void	startUp ()
	performs one show() and hide() on all my sub-objects More...
coChoiceParam *	getMasterChoice ()
	get a pointer to my choice More...
Public Member Functions inherited from covise::coUifElem
virtual	~coUifElem ()
	Destructor : virtual because we derive objects. More...
virtual int	preCompute ()
	do whatever is needed before compute CB : pre-set to do nothing More...
virtual int	postCompute ()
	do whatever is needed after compute CB : pre-set to do nothing More...

Private Types
enum	{ MAX_CASES = 64 }

Private Member Functions
	coUifSwitch (const coUifSwitch &)
	Copy-Constructor: NOT IMPLEMENTED. More...
coUifSwitch &	operator= (const coUifSwitch &)
	Assignment operator: NOT IMPLEMENTED. More...
	coUifSwitch ()
	Default constructor: NOT IMPLEMENTED. More...

Private Attributes
coUifSwitchCase *	d_swCase [MAX_CASES]
int	d_valid [MAX_CASES]
int	d_numCases
char *	d_name
char *	d_desc
int	d_actCase
int	d_toplevel
coChoiceParam *	d_masterChoice

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

Detailed Description

Switch level of parameter switching

Member Enumeration Documentation

anonymous enum

private

Enumerator
MAX_CASES

Constructor & Destructor Documentation

coUifSwitch::coUifSwitch ( const coUifSwitch &  )

private

Copy-Constructor: NOT IMPLEMENTED.

coUifSwitch::coUifSwitch ( )

private

Default constructor: NOT IMPLEMENTED.

coUifSwitch::coUifSwitch	(	const char *	name,
		const char *	label,
		int	toplevel
	)

Constructor: give a name for the switch and a descriptive label.

coUifSwitch::~coUifSwitch ( )

virtual

Destructor.

--— Never forget the Destructor !! ----—

Member Function Documentation

coUifSwitchCase * coUifSwitch::addCase

(

const char *

name

)

int coUifSwitch::finish

(

)

finalize switch : returns number of switch entries

coChoiceParam * coUifSwitch::getMasterChoice

(

)

get a pointer to my choice

const char * coUifSwitch::getName ( ) const

virtual

get the name of this object

Implements covise::coUifElem.

void coUifSwitch::hide ( )

virtual

Hide everything below.

Hide me and everything below.

Reimplemented from covise::coUifElem.

void coUifSwitch::initialize ( )

virtual

give all necessary info to Covise -> automatically called by coModule in init()

Implements covise::coUifElem.

int coUifSwitch::isTopLevel

(

)

const

whether this switch is on top-level

coUifElem::Kind coUifSwitch::kind ( ) const

virtual

return my type of element

Implements covise::coUifElem.

coUifSwitch & coUifSwitch::operator= ( const coUifSwitch &  )

private

Assignment operator: NOT IMPLEMENTED.

int coUifSwitch::paramChange ( )

virtual

handle parameter changes: called by paramCB

Reimplemented from covise::coUifElem.

int coUifSwitch::setNonImmediateValue ( )

virtual

retrieve the values from an EXEC call in compute CB

we should never get here

void coUifSwitch::show ( )

virtual

Show everything below.

Show me and currently active switch.

Reimplemented from covise::coUifElem.

void coUifSwitch::startUp

(

)

performs one show() and hide() on all my sub-objects

int coUifSwitch::switchable ( ) const

virtual

whether this can be a part-object of a switch

Reimplemented from covise::coUifElem.

Member Data Documentation

int covise::coUifSwitch::d_actCase

private

char* covise::coUifSwitch::d_desc

private

coChoiceParam* covise::coUifSwitch::d_masterChoice

private

char* covise::coUifSwitch::d_name

private

int covise::coUifSwitch::d_numCases

private

coUifSwitchCase* covise::coUifSwitch::d_swCase[MAX_CASES]

private

int covise::coUifSwitch::d_toplevel

private

int covise::coUifSwitch::d_valid[MAX_CASES]

private

---

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

• api/coUifSwitch.h
• api/coUifSwitch.cpp