COVISE Core
|
parameter to choose values from a list More...
#include <coChoiceParam.h>
Public Types | |
enum | cmpMode { CASE_SENSITIVE, CASE_INSENSITIVE, ALPHA } |
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... | |
Public Member Functions | |
coChoiceParam (const char *name, const char *desc) | |
Constructor. More... | |
virtual | ~coChoiceParam () |
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 | updateValue (int numChoices, const char *const *choice, int actChoice, cmpMode cmp=CASE_INSENSITIVE) |
int | setValue (int numChoices, const char *const *choice, int actChoice) |
set/update the value: return 0 on error More... | |
int | setValue (int numChoices, const std::vector< string > &list, int actChoice) |
int | setValue (int actChoice) |
set/update the value: return 0 on error More... | |
int | setValue (const char *choiceLabel) |
set/update the value by giving choice label: return 0 on error More... | |
int | getValue () const |
get the value More... | |
const char * | getActLabel () const |
the the name of the label of the current selection More... | |
const char * | 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 | |
coChoiceParam (const coChoiceParam &) | |
Copy-Constructor: NOT IMPLEMENTED. More... | |
coChoiceParam & | operator= (const coChoiceParam &) |
Assignment operator: NOT IMPLEMENTED. More... | |
coChoiceParam () | |
Default constructor: NOT IMPLEMENTED. More... | |
Private Attributes | |
int | d_numChoices |
Port data fields. More... | |
int | d_activeChoice |
char ** | d_choice |
Static Private Attributes | |
static coUifPara::Typeinfo | s_paraType = coUifPara::numericType("CHOICE") |
my type info More... | |
static const char * | s_type = "CHOICE" |
Additional Inherited Members | |
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 |
parameter to choose values from a list
|
private |
Copy-Constructor: NOT IMPLEMENTED.
|
private |
Default constructor: NOT IMPLEMENTED.
coChoiceParam::coChoiceParam | ( | const char * | name, |
const char * | desc | ||
) |
Constructor.
Constructor
|
virtual |
Destructor : virtual in case we derive objects.
Destructor : virtual in case we derive objects
const char * coChoiceParam::getActLabel | ( | ) | const |
the the name of the label of the current selection
const char * coChoiceParam::getLabel | ( | int | i | ) | const |
get label on number given number [1...numChoices]
get label on number given number
read out the choice labels
int coChoiceParam::getNumChoices | ( | ) | const |
get number of choices
|
static |
get my type
get my type
|
virtual |
get the type string of this parameter
get the type string of this parameter
Implements covise::coUifPara.
|
virtual |
get the value of this parameter as a string
get the value of this parameter as a string
Implements covise::coUifPara.
int coChoiceParam::getValue | ( | ) | const |
get the value
get the value
|
virtual |
give dafault values to Covise -> automatically called !
give dafault values to Covise -> automatically called !
Implements covise::coUifPara.
|
virtual |
|
private |
Assignment operator: NOT IMPLEMENTED.
|
virtual |
handle parameter changes: called by paramCB
handle parameter changes: called by paramCB
Implements covise::coUifPara.
|
virtual |
|
virtual |
set the value of this parameter from a string
set the value of this parameter from a string
Implements covise::coUifPara.
int coChoiceParam::setValue | ( | int | numChoices, |
const char *const * | choice, | ||
int | actChoice | ||
) |
set/update the value: return 0 on error
int covise::coChoiceParam::setValue | ( | int | numChoices, |
const std::vector< string > & | list, | ||
int | actChoice | ||
) |
int coChoiceParam::setValue | ( | int | actChoice | ) |
set/update the value: return 0 on error
set the value: if called after init() : update on map
int coChoiceParam::setValue | ( | const char * | choiceLabel | ) |
set/update the value by giving choice label: return 0 on error
set the value: if called after init() : update on map
int coChoiceParam::updateValue | ( | int | numChoices, |
const char *const * | choice, | ||
int | actChoice, | ||
cmpMode | cmp = CASE_INSENSITIVE |
||
) |
update the value: if possible select string from current selection in new choice list return 0 on error
|
private |
|
private |
|
private |
Port data fields.
|
staticprivate |
my type info
|
staticprivate |
Static data