COVISE Core
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
Static Public Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
covise::Covise Class Reference

#include <ApplInterface.h>

Inheritance diagram for covise::Covise:
Inheritance graph
[legend]
Collaboration diagram for covise::Covise:
Collaboration graph
[legend]

Static Public Member Functions

static void set_module_description (const char *desc)
 set/get the module description More...
 
static const char * get_module_description ()
 
static void add_port (enum appl_port_type type, const char *name, const char *datatype, const char *description)
 create a new port More...
 
static void set_port_default (const char *name, const char *defVal)
 set a port's default value More...
 
static void set_port_dependency (const char *port, char *depPort)
 declare this (input) port dependent from another (output) port More...
 
static void set_port_required (const char *name, int isReqired)
 tell that this port is (not) required More...
 
static char * get_description_message ()
 
static int is_port_connected (const char *name)
 check whether port is connected - use in compute() CB only More...
 
static char * getObjNameToAdd ()
 
static char * getObjNameToDelete ()
 
static void init (int argc, char *argv[])
 
static void sendFinishedMsg (void *msg)
 
static int check_and_handle_event (float time=0.0)
 
static void do_one_event ()
 
static void ReceiveOneMsg ()
 
static int deleteConnection ()
 
static void main_loop ()
 
static void progress_main_loop ()
 
static void set_start_callback (CoviseCallback *f, void *userData)
 
static void set_add_object_callback (CoviseCallback *f, void *userData)
 
static void set_feedback_callback (FeedbackCallback *f, void *userData)
 
static void set_generic_callback (CoviseCallback *f, void *userData)
 
static void set_sync_callback (CoviseCallback *f, void *userData)
 
static void set_port_callback (CoviseCallback *f, void *userData)
 
static void set_after_finish_callback (CoviseCallback *f, void *userData)
 
static void set_pipeline_finish_callback (CoviseCallback *f, void *userData)
 
static void remove_start_callback ()
 
static void remove_feedback_callback ()
 
static void remove_generic_callback ()
 
static void remove_sync_callback ()
 
static void remove_after_finish_callback ()
 
static void remove_pipeline_finish_callback ()
 
static char * get_reply_port_name ()
 
static char * get_object_name (const char *name)
 
static char * getObjectType (const char *name)
 
static int get_scalar_param (const char *name, long *val)
 
static int get_scalar_param (const char *name, float *val)
 
static int get_vector_param (const char *name, int pos, long *list)
 
static int get_vector_param (const char *name, int pos, float *list)
 
static int get_string_param (const char *name, char **string)
 
static int get_browser_param (const char *name, char **file)
 
static int get_boolean_param (const char *name, int *b)
 
static int get_slider_param (const char *name, long *min, long *max, long *val)
 
static int get_slider_param (const char *name, float *min, float *max, float *val)
 
static int get_text_param (const char *name, char ***text, int *linenum)
 
static int get_timer_param (const char *name, long *start, long *delta, long *state)
 
static int get_passwd_param (const char *name, char **host, char **user, char **passwd)
 
static int get_choice_param (const char *name, int *pos)
 
static int get_choice_param (const char *name, char **string)
 
static int get_material_param (const char *name, char **string)
 
static int get_colormapchoice_param (const char *name, int *pos)
 
static int get_colormapchoice_param (const char *name, char **string)
 
static int get_colormap_param (const char *name, float *min, float *max, int *len, colormap_type *type)
 
static int get_color_param (const char *name, float *r, float *g, float *b, float *a)
 
static int set_scalar_param (const char *name, long val)
 
static int set_scalar_param (const char *name, float val)
 
static int set_vector_param (const char *name, int num, long *list)
 
static int set_vector_param (const char *name, int num, float *list)
 
static int set_string_param (const char *name, char *string)
 
static int set_boolean_param (const char *name, int val)
 
static int set_slider_param (const char *name, long min, long max, long val)
 
static int set_slider_param (const char *name, float min, float max, float val)
 
static int set_choice_param (const char *name, int len, char **list, int pos)
 
static int set_browser_param (const char *name, char *file, char *wildcard)
 
static int set_text_param (const char *name, char *text, int linenum)
 
static int set_timer_param (const char *name, int start, int delta, int state)
 
static int set_passwd_param (const char *name, char *host, char *user, char *passwd)
 
static int set_save_object (char *name)
 
static int set_release_object (char *name)
 
static void cancel_param (const char *name)
 
static void reopen_param (const char *name)
 
static int send_generic_message (const char *keyword, const char *string)
 
static int send_genericinit_message (const char *mkey, const char *keyword, const char *string)
 
static char * get_generic_message ()
 
static void send_stop_pipeline ()
 
static int send_ctl_message (covise_msg_type type, const char *msg_string)
 
static void sendFinishedMsg ()
 
static void callFeedbackCallback (Message *)
 
static void callStartCallback (void)
 
static void callAddObjectCallback (void)
 
static void callGenericCallback (void)
 
static void callSyncCallback (void)
 
static void callPortReplyCallback (void)
 
static void callAfterFinishCallback (void)
 
static void callPipelineFinishCallback (void)
 
static void partobjects_initialized (void)
 
static void addInteractor (coDistributedObject *obj, const char *name, const char *value)
 
- Static Public Member Functions inherited from covise::CoviseBase
static int parseMessage (char *line, char *token[], int tmax, const char *sep)
 
static void set_progress_callback (CoviseCallback *f, void *userData)
 
static void set_quit_callback (CoviseCallback *f, void *userData)
 
static void set_quit_info_callback (CoviseCallback *f, void *userData)
 
static void set_custom_callback (CoviseCallback *f, void *userData)
 
static void set_param_callback (CoviseParamCallback *f, void *userData)
 
static void remove_progress_callback ()
 
static void remove_quit_callback ()
 
static void remove_quit_info_callback ()
 
static void remove_custom_callback ()
 
static void remove_param_callback ()
 
static void set_master_switch_callback (CoviseCallback *f, void *userData)
 
static void remove_master_switch_callback ()
 
static bool is_master ()
 
static int request_param (const char *name)
 
static void enable_param (const char *name)
 
static void disable_param (const char *name)
 
static void hide_param (const char *name)
 
static void show_param (const char *name)
 
static void cancel_param (const char *name)
 
static void reopen_param (const char *name)
 
static int get_reply_passwd (const char **host, const char **user, const char **passwd)
 
static int get_reply_cli (const char **command)
 
static int get_reply_int_slider (long *min, long *max, long *val)
 
static int get_reply_float_slider (float *min, float *max, float *val)
 
static int get_reply_int_vector (int pos, long *val)
 
static int get_reply_float_vector (int pos, float *val)
 
static int get_reply_int_scalar (long *val)
 
static int get_reply_float_scalar (float *val)
 
static int get_reply_boolean (int *)
 
static int get_reply_string (const char **string)
 
static int get_reply_browser (const char **file)
 
static int get_reply_timer (long *start, long *delta, long *state)
 
static int get_reply_arrayset (const char **msg_buf)
 
static int get_reply_choice (int *selected_pos)
 
static int get_reply_choice (int pos, string *choiceLabels)
 
static int get_reply_colormapchoice (int *selected_pos)
 
static int get_reply_colormapchoice (TColormapChoice *values)
 
static int get_reply_material (string *value)
 
static int get_reply_colormap (float *min, float *max, int *len, colormap_type *type)
 
static int get_reply_colormap (int pos, float *r, float *g, float *b, float *a, float *x)
 
static int get_reply_color (float *r, float *g, float *b, float *a)
 
static int update_slider_param (const char *name, long min, long max, long val)
 
static int update_slider_param (const char *name, float min, float max, float val)
 
static int update_scalar_param (const char *name, long val)
 
static int update_scalar_param (const char *name, float val)
 
static int update_vector_param (const char *name, int num, long *list)
 
static int update_vector_param (const char *name, int num, float *list)
 
static int update_string_param (const char *name, char *string)
 
static int update_text_param (const char *name, char *text, int linenum)
 
static int update_boolean_param (const char *name, int val)
 
static int update_choice_param (const char *name, int len, const char *const *list, int pos)
 
static int update_timer_param (const char *name, long start, long delta, long state)
 
static int update_colormap_param (const char *name, float min, float max, const string &cmap)
 
static int update_material_param (const char *name, const string &value)
 
static int update_colormapchoice_param (const char *name, int num, int pos, TColormapChoice *list)
 
static int update_color_param (const char *name, float r, float g, float b, float a)
 
static int get_socket_id ()
 
static const char * get_instance ()
 
static const char * get_host ()
 
static const char * get_module ()
 
static const char * get_reply_param_name ()
 
static void sendWarning (const char *fmt,...)
 send warning messages - printf style More...
 
static void sendError (const char *fmt,...)
 send warning messages - printf style More...
 
static void sendInfo (const char *string,...)
 send warning messages - printf style More...
 
static int send_message (covise_msg_type type, const char *msg_string)
 
static int send_ui_message (const char *keyword, const char *string)
 
static int send_feedback_message (const char *keyword, const char *string)
 
static void set_feedback_info (const char *string)
 
static const char * get_feedback_info ()
 
static char get_feedback_type ()
 
static void send_quit_request ()
 
static void log_message (int line, const char *file, const char *comment)
 
static FILE * fopen (const char *file, const char *mode, char **returnPath=NULL)
 
static int open (const char *file, int mode)
 
static DIR * opendir (const char *file)
 
static void getname (char *buf, const char *file, const char *addpath=NULL)
 
static bool getnameinpath (char *buf, const char *file, const char *path)
 
static void addInteractor (coDistributedObject *obj, const char *name, const char *value)
 
static void printDesc (const char *callname)
 

Static Private Member Functions

static void doParam (Message *m)
 
static void doPortReply (Message *m)
 
static void doPipelineFinish ()
 
static void generic (Message *applMsg)
 
static void doStartWithoutFinish (Message *m)
 
static void doStart (Message *m)
 
static void doAddObject ()
 
static void doGeneric (Message *m)
 
static void doSync (Message *m)
 
static int doQuit ()
 

Static Private Attributes

static CtlMessagemsg = NULL
 
static char * reply_port_name = NULL
 
static char * modkey = NULL
 
static int renderMode_ = 0
 
static int pipeline_state_once = 0
 
static FeedbackCallbackfeedbackCallbackFunc = NULL
 
static voidfeedbackUserData = 0L
 
static CoviseCallbackstartCallbackFunc = NULL
 
static voidstartUserData = 0L
 
static voidstartCallbackData = 0L
 
static CoviseCallbackaddObjectCallbackFunc = NULL
 
static voidaddObjectUserData = 0L
 
static voidaddObjectCallbackData = 0L
 
static CoviseCallbackgenericCallbackFunc = NULL
 
static voidgenericUserData = 0L
 
static voidgenericCallbackData = 0L
 
static char * genericMessageData = 0L
 
static CoviseCallbacksyncCallbackFunc = NULL
 
static voidsyncUserData = 0L
 
static voidsyncCallbackData = 0L
 
static CoviseCallbackportReplyCallbackFunc = NULL
 
static voidportReplyUserData = 0L
 
static voidportReplyCallbackData = 0L
 
static CoviseCallbackafterFinishCallbackFunc = NULL
 
static voidafterFinishUserData = 0L
 
static voidafterFinishCallbackData = 0L
 
static CoviseCallbackpipelineFinishCallbackFunc = NULL
 
static voidpipelineFinishUserData = 0L
 
static voidpipelineFinishCallbackData = 0L
 
static char * objNameToAdd_ = NULL
 
static char * objNameToDelete_ = NULL
 

Additional Inherited Members

- Public Types inherited from covise::CoviseBase
enum  { MAX_PORTS = 4096 }
 
enum  { ADD_OBJ, DEL_OBJ }
 
- Public Member Functions inherited from covise::CoviseBase
 CoviseBase ()
 
- Static Public Attributes inherited from covise::CoviseBase
static ApplicationProcessappmod = NULL
 
- Static Protected Member Functions inherited from covise::CoviseBase
static void remove_socket (int sock_id)
 
static void doProgress ()
 
static void doCustom (Message *m)
 
static void doMasterSwitch ()
 
static void doSlaveSwitch ()
 
static void signal_handler (int signo, void *)
 
static void init_emergency_message (void)
 
static void callProgressCallback (void)
 
static void callQuitCallback (void)
 
static void callQuitInfoCallback (void)
 
static void callCustomCallback (void)
 
static void callMasterSwitchCallback (void)
 
static void callParamCallback (bool inMapLoading)
 
- Static Protected Attributes inherited from covise::CoviseBase
static int error = 0
 
static char * reply_keyword = NULL
 
static char * reply_param_name = NULL
 
static char * reply_param_type = NULL
 
static const char ** reply_buffer = NULL
 
static int no_of_reply_tokens = 0
 
static vector< stringtokenlist
 
static MessageapplMsg = NULL
 
static int socket_id = 0
 
static const char * h_name = NULL
 
static const char * m_name = NULL
 
static const char * instance = NULL
 
static Message emergency_message
 
static char * emergency_data
 
static const char * module_description = NULL
 
static bool master = false
 
static char * port_name [MAX_PORTS] = { NULL, NULL }
 
static char * port_description [MAX_PORTS]
 
static enum appl_port_type port_type [MAX_PORTS]
 
static const char * port_default [MAX_PORTS]
 
static char * port_datatype [MAX_PORTS]
 
static char * port_dependency [MAX_PORTS]
 
static int port_required [MAX_PORTS]
 
static int init_flag = 0
 
static char * feedback_info = NULL
 
static CoviseCallbackprogressCallbackFunc = NULL
 
static voidprogressUserData = 0L
 
static voidprogressCallbackData = 0L
 
static CoviseCallbackquitCallbackFunc = NULL
 
static voidquitUserData = 0L
 
static voidquitCallbackData = 0L
 
static CoviseCallbackquitInfoCallbackFunc = NULL
 
static voidquitInfoUserData = 0L
 
static voidquitInfoCallbackData = 0L
 
static CoviseCallbackcustomCallbackFunc = NULL
 
static voidcustomUserData = 0L
 
static voidcustomCallbackData = 0L
 
static CoviseCallbackmasterSwitchCallbackFunc = NULL
 
static voidmasterSwitchUserData = 0L
 
static CoviseParamCallbackparamCallbackFunc = NULL
 
static voidparamUserData = 0L
 
static voidparamCallbackData = 0L
 

Member Function Documentation

void Covise::add_port ( enum appl_port_type  type,
const char *  name,
const char *  datatype,
const char *  description 
)
static

create a new port

void Covise::addInteractor ( coDistributedObject obj,
const char *  name,
const char *  value 
)
static
void Covise::callAddObjectCallback ( void  )
static
void Covise::callAfterFinishCallback ( void  )
static
void Covise::callFeedbackCallback ( Message msg)
static
void Covise::callGenericCallback ( void  )
static
void Covise::callPipelineFinishCallback ( void  )
static
void Covise::callPortReplyCallback ( void  )
static
void Covise::callStartCallback ( void  )
static
void Covise::callSyncCallback ( void  )
static
void Covise::cancel_param ( const char *  name)
static
int Covise::check_and_handle_event ( float  time = 0.0)
static
int Covise::deleteConnection ( )
static
void Covise::do_one_event ( )
static
void Covise::doAddObject ( )
staticprivate
void Covise::doGeneric ( Message m)
staticprivate
void Covise::doParam ( Message m)
staticprivate
void Covise::doPipelineFinish ( )
staticprivate
void Covise::doPortReply ( Message m)
staticprivate
int Covise::doQuit ( )
staticprivate
void Covise::doStart ( Message m)
staticprivate
void Covise::doStartWithoutFinish ( Message m)
staticprivate
void Covise::doSync ( Message m)
staticprivate
void Covise::generic ( Message applMsg)
staticprivate
static int covise::Covise::get_boolean_param ( const char *  name,
int *  b 
)
inlinestatic
static int covise::Covise::get_browser_param ( const char *  name,
char **  file 
)
inlinestatic
static int covise::Covise::get_choice_param ( const char *  name,
int *  pos 
)
inlinestatic
static int covise::Covise::get_choice_param ( const char *  name,
char **  string 
)
inlinestatic
static int covise::Covise::get_color_param ( const char *  name,
float *  r,
float *  g,
float *  b,
float *  a 
)
inlinestatic
static int covise::Covise::get_colormap_param ( const char *  name,
float *  min,
float *  max,
int *  len,
colormap_type type 
)
inlinestatic
static int covise::Covise::get_colormapchoice_param ( const char *  name,
int *  pos 
)
inlinestatic
static int covise::Covise::get_colormapchoice_param ( const char *  name,
char **  string 
)
inlinestatic
char * Covise::get_description_message ( )
static
char * Covise::get_generic_message ( )
static
static int covise::Covise::get_material_param ( const char *  name,
char **  string 
)
inlinestatic
const char * Covise::get_module_description ( )
static
static char* covise::Covise::get_object_name ( const char *  name)
inlinestatic
static int covise::Covise::get_passwd_param ( const char *  name,
char **  host,
char **  user,
char **  passwd 
)
inlinestatic
static char* covise::Covise::get_reply_port_name ( )
inlinestatic
static int covise::Covise::get_scalar_param ( const char *  name,
long *  val 
)
inlinestatic
static int covise::Covise::get_scalar_param ( const char *  name,
float *  val 
)
inlinestatic
static int covise::Covise::get_slider_param ( const char *  name,
long *  min,
long *  max,
long *  val 
)
inlinestatic
static int covise::Covise::get_slider_param ( const char *  name,
float *  min,
float *  max,
float *  val 
)
inlinestatic
static int covise::Covise::get_string_param ( const char *  name,
char **  string 
)
inlinestatic
static int covise::Covise::get_text_param ( const char *  name,
char ***  text,
int *  linenum 
)
inlinestatic
static int covise::Covise::get_timer_param ( const char *  name,
long *  start,
long *  delta,
long *  state 
)
inlinestatic
static int covise::Covise::get_vector_param ( const char *  name,
int  pos,
long *  list 
)
inlinestatic
static int covise::Covise::get_vector_param ( const char *  name,
int  pos,
float *  list 
)
inlinestatic
static char* covise::Covise::getObjectType ( const char *  name)
inlinestatic
static char* covise::Covise::getObjNameToAdd ( )
inlinestatic
static char* covise::Covise::getObjNameToDelete ( )
inlinestatic
void Covise::init ( int  argc,
char *  argv[] 
)
static
static int covise::Covise::is_port_connected ( const char *  name)
inlinestatic

check whether port is connected - use in compute() CB only

void Covise::main_loop ( )
static
void Covise::partobjects_initialized ( void  )
static
void Covise::progress_main_loop ( )
static
void Covise::ReceiveOneMsg ( )
static
void Covise::remove_after_finish_callback ( void  )
static
void Covise::remove_feedback_callback ( void  )
static
void Covise::remove_generic_callback ( void  )
static
void Covise::remove_pipeline_finish_callback ( void  )
static
void Covise::remove_start_callback ( void  )
static
void Covise::remove_sync_callback ( void  )
static
void Covise::reopen_param ( const char *  name)
static
int Covise::send_ctl_message ( covise_msg_type  type,
const char *  msg_string 
)
static
int Covise::send_generic_message ( const char *  keyword,
const char *  string 
)
static
int Covise::send_genericinit_message ( const char *  mkey,
const char *  keyword,
const char *  string 
)
static
void Covise::send_stop_pipeline ( )
static
void Covise::sendFinishedMsg ( void msg)
static
void Covise::sendFinishedMsg ( )
static
void Covise::set_add_object_callback ( CoviseCallback f,
void userData 
)
static
void Covise::set_after_finish_callback ( CoviseCallback f,
void userData 
)
static
static int covise::Covise::set_boolean_param ( const char *  name,
int  val 
)
inlinestatic
static int covise::Covise::set_browser_param ( const char *  name,
char *  file,
char *  wildcard 
)
inlinestatic
static int covise::Covise::set_choice_param ( const char *  name,
int  len,
char **  list,
int  pos 
)
inlinestatic
void Covise::set_feedback_callback ( FeedbackCallback f,
void userData 
)
static
void Covise::set_generic_callback ( CoviseCallback f,
void userData 
)
static
void Covise::set_module_description ( const char *  desc)
static

set/get the module description

static int covise::Covise::set_passwd_param ( const char *  name,
char *  host,
char *  user,
char *  passwd 
)
inlinestatic
void Covise::set_pipeline_finish_callback ( CoviseCallback f,
void userData 
)
static
void Covise::set_port_callback ( CoviseCallback f,
void userData 
)
static
void Covise::set_port_default ( const char *  name,
const char *  defVal 
)
static

set a port's default value

void Covise::set_port_dependency ( const char *  port,
char *  depPort 
)
static

declare this (input) port dependent from another (output) port

find the port

void Covise::set_port_required ( const char *  name,
int  isReqired 
)
static

tell that this port is (not) required

static int covise::Covise::set_release_object ( char *  name)
inlinestatic
static int covise::Covise::set_save_object ( char *  name)
inlinestatic
static int covise::Covise::set_scalar_param ( const char *  name,
long  val 
)
inlinestatic
static int covise::Covise::set_scalar_param ( const char *  name,
float  val 
)
inlinestatic
static int covise::Covise::set_slider_param ( const char *  name,
long  min,
long  max,
long  val 
)
inlinestatic
static int covise::Covise::set_slider_param ( const char *  name,
float  min,
float  max,
float  val 
)
inlinestatic
void Covise::set_start_callback ( CoviseCallback f,
void userData 
)
static
static int covise::Covise::set_string_param ( const char *  name,
char *  string 
)
inlinestatic
void Covise::set_sync_callback ( CoviseCallback f,
void userData 
)
static
static int covise::Covise::set_text_param ( const char *  name,
char *  text,
int  linenum 
)
inlinestatic
static int covise::Covise::set_timer_param ( const char *  name,
int  start,
int  delta,
int  state 
)
inlinestatic
static int covise::Covise::set_vector_param ( const char *  name,
int  num,
long *  list 
)
inlinestatic
static int covise::Covise::set_vector_param ( const char *  name,
int  num,
float *  list 
)
inlinestatic

Member Data Documentation

void * Covise::addObjectCallbackData = 0L
staticprivate
CoviseCallback * Covise::addObjectCallbackFunc = NULL
staticprivate
void * Covise::addObjectUserData = 0L
staticprivate
void * Covise::afterFinishCallbackData = 0L
staticprivate
CoviseCallback * Covise::afterFinishCallbackFunc = NULL
staticprivate
void * Covise::afterFinishUserData = 0L
staticprivate
FeedbackCallback * Covise::feedbackCallbackFunc = NULL
staticprivate
void * Covise::feedbackUserData = 0L
staticprivate
void * Covise::genericCallbackData = 0L
staticprivate
CoviseCallback * Covise::genericCallbackFunc = NULL
staticprivate
char * Covise::genericMessageData = 0L
staticprivate
void * Covise::genericUserData = 0L
staticprivate
char * Covise::modkey = NULL
staticprivate
CtlMessage * Covise::msg = NULL
staticprivate
char * Covise::objNameToAdd_ = NULL
staticprivate
char * Covise::objNameToDelete_ = NULL
staticprivate
int Covise::pipeline_state_once = 0
staticprivate
void * Covise::pipelineFinishCallbackData = 0L
staticprivate
CoviseCallback * Covise::pipelineFinishCallbackFunc = NULL
staticprivate
void * Covise::pipelineFinishUserData = 0L
staticprivate
void * Covise::portReplyCallbackData = 0L
staticprivate
CoviseCallback * Covise::portReplyCallbackFunc = NULL
staticprivate
void * Covise::portReplyUserData = 0L
staticprivate
int Covise::renderMode_ = 0
staticprivate
char * Covise::reply_port_name = NULL
staticprivate
void * Covise::startCallbackData = 0L
staticprivate
CoviseCallback * Covise::startCallbackFunc = NULL
staticprivate
void * Covise::startUserData = 0L
staticprivate
void * Covise::syncCallbackData = 0L
staticprivate
CoviseCallback * Covise::syncCallbackFunc = NULL
staticprivate
void * Covise::syncUserData = 0L
staticprivate

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