parameter to choose values from a list More...

#include <coColormapChoiceParam.h>

Inheritance diagram for covise::coColormapChoiceParam:

Collaboration diagram for covise::coColormapChoiceParam:

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

virtual	~coColormapChoiceParam ()
	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 (int numChoices, int actChoice, TColormapChoice *list)
	set/update the value: return 0 on error More...

int	setValue (int actChoice)
	set/update the value: return 0 on error More...

int	getValue () const
	get the value More...

TColormapChoice	getValue (int i) const
	get material info More...

const string	getActLabel () const
	the the name of the label of the current selection More...

const string	getLabel (int i) const
	get label on number given number [1...numChoices] More...

int	getNumChoices () const
	get number of choices 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 Types
enum	{ MAX_CHOICE_LABELS = 256 }

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

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

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

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

int	d_activeChoice

TColormapChoice *	colormaps

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

static const char *	s_type = "COLORMAPCHOICE"

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

parameter to choose values from a list

Member Enumeration Documentation

anonymous enum

private

Enumerator
MAX_CHOICE_LABELS

Constructor & Destructor Documentation

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

Constructor.

Constructor

coColormapChoiceParam::~coColormapChoiceParam ( )

virtual

Destructor : virtual in case we derive objects.

Destructor : virtual in case we derive objects

covise::coColormapChoiceParam::coColormapChoiceParam ( const coColormapChoiceParam & )

private

Copy-Constructor: NOT IMPLEMENTED.

covise::coColormapChoiceParam::coColormapChoiceParam ( )

private

Default constructor: NOT IMPLEMENTED.

Member Function Documentation

const string coColormapChoiceParam::getActLabel ( ) const

the the name of the label of the current selection

const string coColormapChoiceParam::getLabel ( int i ) const

get label on number given number [1...numChoices]

get label on number given number

read out the choice labels

int coColormapChoiceParam::getNumChoices ( ) const

get number of choices

coUifPara::Typeinfo coColormapChoiceParam::getType ( )

static

get my type

const char * coColormapChoiceParam::getTypeString ( ) const

virtual

get the type string of this parameter

Implements covise::coUifPara.

const char * coColormapChoiceParam::getValString ( ) const

virtual

get the value of this parameter as a string

Implements covise::coUifPara.

int coColormapChoiceParam::getValue ( ) const

get the value

TColormapChoice coColormapChoiceParam::getValue ( int i ) const

get material info

void coColormapChoiceParam::initialize ( )

virtual

give dafault values to Covise -> automatically called !

Implements covise::coUifPara.

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

virtual

Check the type.

Check the type

Implements covise::coUifPara.

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

private

Assignment operator: NOT IMPLEMENTED.

int coColormapChoiceParam::paramChange ( )

virtual

handle parameter changes: called by paramCB

Implements covise::coUifPara.

void coColormapChoiceParam::print ( ostream & str ) const

virtual

print this to a stream

Reimplemented from covise::coUifPara.

void coColormapChoiceParam::setValString ( const char * str )

virtual

set the value of this parameter from a string

Implements covise::coUifPara.

int coColormapChoiceParam::setValue	(	int	numChoices,
		int	actChoice,
		TColormapChoice *	list
	)

set/update the value: return 0 on error

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

int coColormapChoiceParam::setValue ( int actChoice )

set/update the value: return 0 on error

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

Member Data Documentation

TColormapChoice* covise::coColormapChoiceParam::colormaps

private

int covise::coColormapChoiceParam::d_activeChoice

private

int covise::coColormapChoiceParam::d_numChoices

private

Port data fields.

coUifPara::Typeinfo coColormapChoiceParam::s_paraType = coUifPara::numericType("COLORMAPCHOICE")

staticprivate

my type info

const char * coColormapChoiceParam::s_type = "COLORMAPCHOICE"

staticprivate

Static data

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

api/coColormapChoiceParam.h
api/coColormapChoiceParam.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation