OpenCOVER
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Classes | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
opencover::coBaseCoviseInteractor Class Referenceabstract

interact with the parameters of a single module More...

#include <coBaseCoviseInteractor.h>

Inheritance diagram for opencover::coBaseCoviseInteractor:
Inheritance graph
[legend]
Collaboration diagram for opencover::coBaseCoviseInteractor:
Collaboration graph
[legend]

Classes

struct  paraRec
 record holding the state of a single parameter More...
 

Public Member Functions

 coBaseCoviseInteractor (const char *n, RenderObject *o, const char *attrib)
 
 ~coBaseCoviseInteractor ()
 
void removedObject ()
 
bool isSameModule (coInteractor *i) const
 returns true, if Interactor comes from same Module as intteractor i; More...
 
bool isSame (coInteractor *i) const
 returns true, if Interactor is exactly the same as interactor i; More...
 
void executeModule ()
 execute the Module More...
 
void copyModule ()
 copy the Module to same host More...
 
void copyModuleExec ()
 copy the Module to same host and execute the copied one More...
 
void deleteModule ()
 delete the Module More...
 
int getBooleanParam (unsigned int paraNo, int &value) const
 
int getIntScalarParam (unsigned int paraNo, int &value) const
 
int getFloatScalarParam (unsigned int paraNo, float &value) const
 
int getIntSliderParam (unsigned int paraNo, int &min, int &max, int &val) const
 
int getFloatSliderParam (unsigned int paraNo, float &min, float &max, float &val) const
 
int getIntVectorParam (unsigned int paraNo, int &numElem, int *&val) const
 
int getFloatVectorParam (unsigned int paraNo, int &numElem, float *&val) const
 
int getStringParam (unsigned int paraNo, const char *&val) const
 
int getChoiceParam (unsigned int paraNo, int &num, char **&labels, int &active) const
 
int getFileBrowserParam (unsigned int paraNo, char *&val) const
 
int getBooleanParam (const std::string &paraName, int &value) const
 
int getIntScalarParam (const std::string &paraName, int &value) const
 
int getFloatScalarParam (const std::string &paraName, float &value) const
 
int getIntSliderParam (const std::string &paraName, int &min, int &max, int &val) const
 
int getFloatSliderParam (const std::string &paraName, float &min, float &max, float &val) const
 
int getIntVectorParam (const std::string &paraName, int &numElem, int *&val) const
 
int getFloatVectorParam (const std::string &paraName, int &numElem, float *&val) const
 
int getStringParam (const std::string &paraName, const char *&val) const
 
int getChoiceParam (const std::string &paraName, int &num, char **&labels, int &active) const
 
int getFileBrowserParam (const std::string &paraName, char *&val) const
 
void setBooleanParam (const char *name, int val)
 set Boolean Parameter More...
 
void setScalarParam (const char *name, float val)
 set float scalar parameter More...
 
void setScalarParam (const char *name, int val)
 set int scalar parameter More...
 
void setSliderParam (const char *name, float min, float max, float value)
 set float slider parameter More...
 
void setSliderParam (const char *name, int min, int max, int value)
 set int slider parameter More...
 
void setVectorParam (const char *name, int numElem, float *field)
 set float Vector Param More...
 
void setVectorParam (const char *name, float u, float v, float w)
 
void setVectorParam (const char *name, int numElem, int *field)
 set int vector parameter More...
 
void setVectorParam (const char *name, int u, int v, int w)
 
void setStringParam (const char *name, const char *val)
 set string parameter More...
 
void setChoiceParam (const char *name, int num, const char *const *list, int pos)
 set choice parameter, pos starts with 1 More...
 
void setFileBrowserParam (const char *name, const char *val)
 set browser parameter More...
 
const char * getObjName ()
 
RenderObjectgetObject ()
 
const char * getPluginName ()
 
const char * getModuleName ()
 
int getModuleInstance ()
 
const char * getModuleHost ()
 
const char * getInfo ()
 
int getNumParam () const
 Get the number of Parameters. More...
 
int getNumUser () const
 Get the number of User Strings. More...
 
const paraRecgetPara (unsigned int i) const
 
const char * getParaName (unsigned int i) const
 
const char * getParaType (unsigned int i) const
 
const char * getParaValue (unsigned int i) const
 
const char * getString (unsigned int i) const
 
void print (FILE *outfile)
 
- Public Member Functions inherited from opencover::coInteractor
 coInteractor ()
 
virtual ~coInteractor ()
 
void incRefCount ()
 if you get an interactor and you want to keep it use ... More...
 
void decRefCount ()
 if you don't need the interactor any more use ... More...
 

Protected Member Functions

virtual void sendFeedback (const char *info, const char *key, const char *data=NULL)=0
 

Static Protected Member Functions

static void unMask (char *string)
 

Protected Attributes

char * d_feedbackInfo
 the part of the attrib created by ApplLib More...
 
int d_refCount
 referenc count for managing lifetime More...
 
char * d_objName
 the name of the DO with the attirbs More...
 
RenderObjectd_object
 the DO with attrib More...
 
char * d_moduleName
 the name of the module More...
 
int d_moduleInstance
 the instance of the module More...
 
char * d_moduleHost
 the hostname of the module More...
 
char * d_pluginName
 the name of the Plugin to load for this Interactor More...
 
char * d_infoString
 whatever the user put in the attribute More...
 
unsigned int d_numPara
 this part is only there if coFeedback created the attribute More...
 
unsigned int d_numUser
 number of user strings More...
 
paraRecd_param
 Parameters. More...
 
char ** d_user
 User strings. More...
 
char * d_splitString
 save splitted string in here More...
 

Detailed Description

interact with the parameters of a single module

Constructor & Destructor Documentation

opencover::coBaseCoviseInteractor::coBaseCoviseInteractor ( const char *  n,
RenderObject o,
const char *  attrib 
)
opencover::coBaseCoviseInteractor::~coBaseCoviseInteractor ( )

Member Function Documentation

void opencover::coBaseCoviseInteractor::copyModule ( )
virtual

copy the Module to same host

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::copyModuleExec ( )
virtual

copy the Module to same host and execute the copied one

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::deleteModule ( )
virtual

delete the Module

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::executeModule ( )
virtual

execute the Module

Implements opencover::coInteractor.

int opencover::coBaseCoviseInteractor::getBooleanParam ( unsigned int  paraNo,
int &  value 
) const
int opencover::coBaseCoviseInteractor::getBooleanParam ( const std::string &  paraName,
int &  value 
) const
virtual
int opencover::coBaseCoviseInteractor::getChoiceParam ( unsigned int  paraNo,
int &  num,
char **&  labels,
int &  active 
) const
int opencover::coBaseCoviseInteractor::getChoiceParam ( const std::string &  paraName,
int &  num,
char **&  labels,
int &  active 
) const
virtual
int opencover::coBaseCoviseInteractor::getFileBrowserParam ( unsigned int  paraNo,
char *&  val 
) const
int opencover::coBaseCoviseInteractor::getFileBrowserParam ( const std::string &  paraName,
char *&  val 
) const
virtual
int opencover::coBaseCoviseInteractor::getFloatScalarParam ( unsigned int  paraNo,
float &  value 
) const
int opencover::coBaseCoviseInteractor::getFloatScalarParam ( const std::string &  paraName,
float &  value 
) const
virtual
int opencover::coBaseCoviseInteractor::getFloatSliderParam ( unsigned int  paraNo,
float &  min,
float &  max,
float &  val 
) const
int opencover::coBaseCoviseInteractor::getFloatSliderParam ( const std::string &  paraName,
float &  min,
float &  max,
float &  val 
) const
virtual
int opencover::coBaseCoviseInteractor::getFloatVectorParam ( unsigned int  paraNo,
int &  numElem,
float *&  val 
) const
int opencover::coBaseCoviseInteractor::getFloatVectorParam ( const std::string &  paraName,
int &  numElem,
float *&  val 
) const
virtual
const char* opencover::coBaseCoviseInteractor::getInfo ( )
inline
int opencover::coBaseCoviseInteractor::getIntScalarParam ( unsigned int  paraNo,
int &  value 
) const
int opencover::coBaseCoviseInteractor::getIntScalarParam ( const std::string &  paraName,
int &  value 
) const
virtual
int opencover::coBaseCoviseInteractor::getIntSliderParam ( unsigned int  paraNo,
int &  min,
int &  max,
int &  val 
) const
int opencover::coBaseCoviseInteractor::getIntSliderParam ( const std::string &  paraName,
int &  min,
int &  max,
int &  val 
) const
virtual
int opencover::coBaseCoviseInteractor::getIntVectorParam ( unsigned int  paraNo,
int &  numElem,
int *&  val 
) const
int opencover::coBaseCoviseInteractor::getIntVectorParam ( const std::string &  paraName,
int &  numElem,
int *&  val 
) const
virtual
const char* opencover::coBaseCoviseInteractor::getModuleHost ( )
inlinevirtual
int opencover::coBaseCoviseInteractor::getModuleInstance ( )
inlinevirtual
const char* opencover::coBaseCoviseInteractor::getModuleName ( )
inlinevirtual
int opencover::coBaseCoviseInteractor::getNumParam ( ) const
inlinevirtual

Get the number of Parameters.

Implements opencover::coInteractor.

int opencover::coBaseCoviseInteractor::getNumUser ( ) const
inlinevirtual

Get the number of User Strings.

Implements opencover::coInteractor.

RenderObject* opencover::coBaseCoviseInteractor::getObject ( )
inlinevirtual
const char* opencover::coBaseCoviseInteractor::getObjName ( )
inlinevirtual
const paraRec* opencover::coBaseCoviseInteractor::getPara ( unsigned int  i) const
const char* opencover::coBaseCoviseInteractor::getParaName ( unsigned int  i) const
const char* opencover::coBaseCoviseInteractor::getParaType ( unsigned int  i) const
const char* opencover::coBaseCoviseInteractor::getParaValue ( unsigned int  i) const
const char* opencover::coBaseCoviseInteractor::getPluginName ( )
inlinevirtual
const char* opencover::coBaseCoviseInteractor::getString ( unsigned int  i) const
virtual
int opencover::coBaseCoviseInteractor::getStringParam ( unsigned int  paraNo,
const char *&  val 
) const
int opencover::coBaseCoviseInteractor::getStringParam ( const std::string &  paraName,
const char *&  val 
) const
virtual
bool opencover::coBaseCoviseInteractor::isSame ( coInteractor i) const
inlinevirtual

returns true, if Interactor is exactly the same as interactor i;

Implements opencover::coInteractor.

bool opencover::coBaseCoviseInteractor::isSameModule ( coInteractor i) const
inlinevirtual

returns true, if Interactor comes from same Module as intteractor i;

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::print ( FILE *  outfile)
void opencover::coBaseCoviseInteractor::removedObject ( )
inlinevirtual
virtual void opencover::coBaseCoviseInteractor::sendFeedback ( const char *  info,
const char *  key,
const char *  data = NULL 
)
protectedpure virtual
void opencover::coBaseCoviseInteractor::setBooleanParam ( const char *  name,
int  val 
)
virtual

set Boolean Parameter

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setChoiceParam ( const char *  name,
int  num,
const char *const *  list,
int  pos 
)
virtual

set choice parameter, pos starts with 1

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setFileBrowserParam ( const char *  name,
const char *  val 
)
virtual

set browser parameter

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setScalarParam ( const char *  name,
float  val 
)
virtual

set float scalar parameter

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setScalarParam ( const char *  name,
int  val 
)
virtual

set int scalar parameter

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setSliderParam ( const char *  name,
float  min,
float  max,
float  value 
)
virtual

set float slider parameter

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setSliderParam ( const char *  name,
int  min,
int  max,
int  value 
)
virtual

set int slider parameter

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setStringParam ( const char *  name,
const char *  val 
)
virtual

set string parameter

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setVectorParam ( const char *  name,
int  numElem,
float *  field 
)
virtual

set float Vector Param

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setVectorParam ( const char *  name,
float  u,
float  v,
float  w 
)
virtual
void opencover::coBaseCoviseInteractor::setVectorParam ( const char *  name,
int  numElem,
int *  field 
)
virtual

set int vector parameter

Implements opencover::coInteractor.

void opencover::coBaseCoviseInteractor::setVectorParam ( const char *  name,
int  u,
int  v,
int  w 
)
virtual
static void opencover::coBaseCoviseInteractor::unMask ( char *  string)
staticprotected

Member Data Documentation

char* opencover::coBaseCoviseInteractor::d_feedbackInfo
protected

the part of the attrib created by ApplLib

char* opencover::coBaseCoviseInteractor::d_infoString
protected

whatever the user put in the attribute

char* opencover::coBaseCoviseInteractor::d_moduleHost
protected

the hostname of the module

int opencover::coBaseCoviseInteractor::d_moduleInstance
protected

the instance of the module

char* opencover::coBaseCoviseInteractor::d_moduleName
protected

the name of the module

unsigned int opencover::coBaseCoviseInteractor::d_numPara
protected

this part is only there if coFeedback created the attribute

number of parameters

unsigned int opencover::coBaseCoviseInteractor::d_numUser
protected

number of user strings

RenderObject* opencover::coBaseCoviseInteractor::d_object
protected

the DO with attrib

char* opencover::coBaseCoviseInteractor::d_objName
protected

the name of the DO with the attirbs

paraRec* opencover::coBaseCoviseInteractor::d_param
protected

Parameters.

char* opencover::coBaseCoviseInteractor::d_pluginName
protected

the name of the Plugin to load for this Interactor

int opencover::coBaseCoviseInteractor::d_refCount
protected

referenc count for managing lifetime

char* opencover::coBaseCoviseInteractor::d_splitString
protected

save splitted string in here

char** opencover::coBaseCoviseInteractor::d_user
protected

User strings.


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