COVISE Core
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Static Protected Attributes | List of all members
covise::CoviseBase Class Reference

#include <CoviseBase.h>

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

Public Types

enum  { MAX_PORTS = 4096 }
 
enum  { ADD_OBJ , DEL_OBJ }
 

Public Member Functions

 CoviseBase ()
 

Static Public Member Functions

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 (const CoviseCallback2 &f)
 
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_int64_scalar (int64_t *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 Public Attributes

static ApplicationProcessappmod = NULL
 

Static Protected Member Functions

static void remove_socket (int sock_id)
 
static std::string get_description_message ()
 
static std::string get_param_description (appl_port_type type)
 
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 (const covise::Message &msg)
 
static void callMasterSwitchCallback (void)
 
static void callParamCallback (bool inMapLoading)
 

Static Protected Attributes

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 std::string h_name
 
static std::string m_name
 
static std::string instance
 
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 CoviseCallback2 customCallbackFunc
 
static CoviseCallbackmasterSwitchCallbackFunc = NULL
 
static voidmasterSwitchUserData = 0L
 
static CoviseParamCallbackparamCallbackFunc = NULL
 
static voidparamUserData = 0L
 
static voidparamCallbackData = 0L
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MAX_PORTS 

◆ anonymous enum

anonymous enum
Enumerator
ADD_OBJ 
DEL_OBJ 

Constructor & Destructor Documentation

◆ CoviseBase()

CoviseBase::CoviseBase ( )

Member Function Documentation

◆ addInteractor()

static void covise::CoviseBase::addInteractor ( coDistributedObject obj,
const char *  name,
const char *  value 
)
static

◆ callCustomCallback()

void CoviseBase::callCustomCallback ( const covise::Message msg)
staticprotected

◆ callMasterSwitchCallback()

void CoviseBase::callMasterSwitchCallback ( void  )
staticprotected

◆ callParamCallback()

void CoviseBase::callParamCallback ( bool  inMapLoading)
staticprotected

◆ callProgressCallback()

void CoviseBase::callProgressCallback ( void  )
staticprotected

◆ callQuitCallback()

void CoviseBase::callQuitCallback ( void  )
staticprotected

◆ callQuitInfoCallback()

void CoviseBase::callQuitInfoCallback ( void  )
staticprotected

◆ cancel_param()

static void covise::CoviseBase::cancel_param ( const char *  name)
static

◆ disable_param()

void CoviseBase::disable_param ( const char *  name)
static

◆ doCustom()

void CoviseBase::doCustom ( Message m)
staticprotected

◆ doMasterSwitch()

void CoviseBase::doMasterSwitch ( )
staticprotected

◆ doProgress()

void CoviseBase::doProgress ( )
staticprotected

◆ doSlaveSwitch()

void CoviseBase::doSlaveSwitch ( )
staticprotected

◆ enable_param()

void CoviseBase::enable_param ( const char *  name)
static

◆ fopen()

FILE * CoviseBase::fopen ( const char *  file,
const char *  mode,
char **  returnPath = NULL 
)
static

◆ get_description_message()

std::string CoviseBase::get_description_message ( )
staticprotected

◆ get_feedback_info()

const char * CoviseBase::get_feedback_info ( )
static

◆ get_feedback_type()

char CoviseBase::get_feedback_type ( )
static

◆ get_host()

static const char * covise::CoviseBase::get_host ( )
inlinestatic

◆ get_instance()

static const char * covise::CoviseBase::get_instance ( )
inlinestatic

◆ get_module()

static const char * covise::CoviseBase::get_module ( )
inlinestatic

◆ get_param_description()

std::string CoviseBase::get_param_description ( appl_port_type  type)
staticprotected

◆ get_reply_arrayset()

int CoviseBase::get_reply_arrayset ( const char **  msg_buf)
static

◆ get_reply_boolean()

int CoviseBase::get_reply_boolean ( int *  val)
static

◆ get_reply_browser()

int CoviseBase::get_reply_browser ( const char **  file)
static

◆ get_reply_choice() [1/2]

int CoviseBase::get_reply_choice ( int *  selected_pos)
static

◆ get_reply_choice() [2/2]

int CoviseBase::get_reply_choice ( int  pos,
string choiceLabels 
)
static

◆ get_reply_cli()

int CoviseBase::get_reply_cli ( const char **  command)
static

◆ get_reply_color()

int CoviseBase::get_reply_color ( float *  r,
float *  g,
float *  b,
float *  a 
)
static

◆ get_reply_colormap() [1/2]

int CoviseBase::get_reply_colormap ( float *  min,
float *  max,
int *  len,
colormap_type type 
)
static

◆ get_reply_colormap() [2/2]

int CoviseBase::get_reply_colormap ( int  pos,
float *  r,
float *  g,
float *  b,
float *  a,
float *  x 
)
static

◆ get_reply_colormapchoice() [1/2]

int CoviseBase::get_reply_colormapchoice ( int *  selected_pos)
static

◆ get_reply_colormapchoice() [2/2]

int CoviseBase::get_reply_colormapchoice ( TColormapChoice values)
static

◆ get_reply_float_scalar()

int CoviseBase::get_reply_float_scalar ( float *  val)
static

◆ get_reply_float_slider()

int CoviseBase::get_reply_float_slider ( float *  min,
float *  max,
float *  val 
)
static

◆ get_reply_float_vector()

int CoviseBase::get_reply_float_vector ( int  pos,
float *  val 
)
static

◆ get_reply_int64_scalar()

int CoviseBase::get_reply_int64_scalar ( int64_t *  val)
static

◆ get_reply_int_scalar()

int CoviseBase::get_reply_int_scalar ( long *  val)
static

◆ get_reply_int_slider()

int CoviseBase::get_reply_int_slider ( long *  min,
long *  max,
long *  val 
)
static

◆ get_reply_int_vector()

int CoviseBase::get_reply_int_vector ( int  pos,
long *  val 
)
static

◆ get_reply_material()

int CoviseBase::get_reply_material ( string value)
static

◆ get_reply_param_name()

static const char * covise::CoviseBase::get_reply_param_name ( )
inlinestatic

◆ get_reply_passwd()

int CoviseBase::get_reply_passwd ( const char **  host,
const char **  user,
const char **  passwd 
)
static

◆ get_reply_string()

int CoviseBase::get_reply_string ( const char **  string)
static

◆ get_reply_timer()

int CoviseBase::get_reply_timer ( long *  start,
long *  delta,
long *  state 
)
static

◆ get_socket_id()

int CoviseBase::get_socket_id ( )
static

◆ getname()

void CoviseBase::getname ( char *  buf,
const char *  file,
const char *  addpath = NULL 
)
static

◆ getnameinpath()

bool CoviseBase::getnameinpath ( char *  buf,
const char *  file,
const char *  path 
)
static

◆ hide_param()

void CoviseBase::hide_param ( const char *  name)
static

◆ init_emergency_message()

void CoviseBase::init_emergency_message ( void  )
staticprotected

◆ is_master()

static bool covise::CoviseBase::is_master ( )
inlinestatic

◆ log_message()

void CoviseBase::log_message ( int  line,
const char *  file,
const char *  comment 
)
static

◆ open()

int CoviseBase::open ( const char *  file,
int  mode 
)
static

◆ opendir()

DIR * CoviseBase::opendir ( const char *  file)
static

◆ parseMessage()

int CoviseBase::parseMessage ( char *  line,
char *  token[],
int  tmax,
const char *  sep 
)
static

◆ printDesc()

void CoviseBase::printDesc ( const char *  callname)
static

◆ remove_custom_callback()

void CoviseBase::remove_custom_callback ( void  )
static

◆ remove_master_switch_callback()

void CoviseBase::remove_master_switch_callback ( void  )
static

◆ remove_param_callback()

void CoviseBase::remove_param_callback ( void  )
static

◆ remove_progress_callback()

void CoviseBase::remove_progress_callback ( void  )
static

◆ remove_quit_callback()

void CoviseBase::remove_quit_callback ( void  )
static

◆ remove_quit_info_callback()

void CoviseBase::remove_quit_info_callback ( void  )
static

◆ remove_socket()

void CoviseBase::remove_socket ( int  sock_id)
staticprotected

◆ reopen_param()

static void covise::CoviseBase::reopen_param ( const char *  name)
static

◆ request_param()

int CoviseBase::request_param ( const char *  name)
static

◆ send_feedback_message()

int CoviseBase::send_feedback_message ( const char *  keyword,
const char *  string 
)
static

◆ send_message()

int CoviseBase::send_message ( covise_msg_type  type,
const char *  msg_string 
)
static

◆ send_quit_request()

void CoviseBase::send_quit_request ( )
static

◆ send_ui_message()

int CoviseBase::send_ui_message ( const char *  keyword,
const char *  string 
)
static

◆ sendError()

void CoviseBase::sendError ( const char *  fmt,
  ... 
)
static

send warning messages - printf style

◆ sendInfo()

void CoviseBase::sendInfo ( const char *  string,
  ... 
)
static

send warning messages - printf style

◆ sendWarning()

void CoviseBase::sendWarning ( const char *  fmt,
  ... 
)
static

send warning messages - printf style

◆ set_custom_callback()

void CoviseBase::set_custom_callback ( const CoviseCallback2 f)
static

◆ set_feedback_info()

void CoviseBase::set_feedback_info ( const char *  string)
static

◆ set_master_switch_callback()

void CoviseBase::set_master_switch_callback ( CoviseCallback f,
void userData 
)
static

◆ set_param_callback()

void CoviseBase::set_param_callback ( CoviseParamCallback f,
void userData 
)
static

◆ set_progress_callback()

void CoviseBase::set_progress_callback ( CoviseCallback f,
void userData 
)
static

◆ set_quit_callback()

void CoviseBase::set_quit_callback ( CoviseCallback f,
void userData 
)
static

◆ set_quit_info_callback()

void CoviseBase::set_quit_info_callback ( CoviseCallback f,
void userData 
)
static

◆ show_param()

void CoviseBase::show_param ( const char *  name)
static

◆ signal_handler()

void CoviseBase::signal_handler ( int  signo,
void  
)
staticprotected

◆ update_boolean_param()

int CoviseBase::update_boolean_param ( const char *  name,
int  val 
)
static

◆ update_choice_param()

int CoviseBase::update_choice_param ( const char *  name,
int  len,
const char *const *  list,
int  pos 
)
static

◆ update_color_param()

int CoviseBase::update_color_param ( const char *  name,
float  r,
float  g,
float  b,
float  a 
)
static

◆ update_colormap_param()

int CoviseBase::update_colormap_param ( const char *  name,
float  min,
float  max,
const string cmap 
)
static

◆ update_colormapchoice_param()

int CoviseBase::update_colormapchoice_param ( const char *  name,
int  num,
int  pos,
TColormapChoice list 
)
static

◆ update_material_param()

int CoviseBase::update_material_param ( const char *  name,
const string value 
)
static

◆ update_scalar_param() [1/2]

int CoviseBase::update_scalar_param ( const char *  name,
float  val 
)
static

◆ update_scalar_param() [2/2]

int CoviseBase::update_scalar_param ( const char *  name,
long  val 
)
static

◆ update_slider_param() [1/2]

int CoviseBase::update_slider_param ( const char *  name,
float  min,
float  max,
float  val 
)
static

◆ update_slider_param() [2/2]

int CoviseBase::update_slider_param ( const char *  name,
long  min,
long  max,
long  val 
)
static

◆ update_string_param()

int CoviseBase::update_string_param ( const char *  name,
char *  string 
)
static

◆ update_text_param()

int CoviseBase::update_text_param ( const char *  name,
char *  text,
int  linenum 
)
static

◆ update_timer_param()

int CoviseBase::update_timer_param ( const char *  name,
long  start,
long  delta,
long  state 
)
static

◆ update_vector_param() [1/2]

int CoviseBase::update_vector_param ( const char *  name,
int  num,
float *  list 
)
static

◆ update_vector_param() [2/2]

int CoviseBase::update_vector_param ( const char *  name,
int  num,
long *  list 
)
static

Member Data Documentation

◆ applMsg

Message * CoviseBase::applMsg = NULL
staticprotected

◆ appmod

ApplicationProcess * CoviseBase::appmod = NULL
static

◆ customCallbackFunc

CoviseCallback2 CoviseBase::customCallbackFunc
staticprotected

◆ emergency_data

char * CoviseBase::emergency_data
staticprotected

◆ emergency_message

Message CoviseBase::emergency_message
staticprotected

◆ error

int CoviseBase::error = 0
staticprotected

◆ feedback_info

char * CoviseBase::feedback_info = NULL
staticprotected

◆ h_name

std::string CoviseBase::h_name
staticprotected

◆ init_flag

int CoviseBase::init_flag = 0
staticprotected

◆ instance

std::string CoviseBase::instance
staticprotected

◆ m_name

std::string CoviseBase::m_name
staticprotected

◆ master

bool CoviseBase::master = false
staticprotected

◆ masterSwitchCallbackFunc

CoviseCallback * CoviseBase::masterSwitchCallbackFunc = NULL
staticprotected

◆ masterSwitchUserData

void * CoviseBase::masterSwitchUserData = 0L
staticprotected

◆ module_description

const char * CoviseBase::module_description = NULL
staticprotected

◆ no_of_reply_tokens

int CoviseBase::no_of_reply_tokens = 0
staticprotected

◆ paramCallbackData

void * CoviseBase::paramCallbackData = 0L
staticprotected

◆ paramCallbackFunc

CoviseParamCallback * CoviseBase::paramCallbackFunc = NULL
staticprotected

◆ paramUserData

void * CoviseBase::paramUserData = 0L
staticprotected

◆ port_datatype

char * CoviseBase::port_datatype
staticprotected

◆ port_default

const char * CoviseBase::port_default
staticprotected

◆ port_dependency

char * CoviseBase::port_dependency
staticprotected

◆ port_description

char * CoviseBase::port_description
staticprotected

◆ port_name

char * CoviseBase::port_name = { NULL, NULL }
staticprotected

◆ port_required

int CoviseBase::port_required
staticprotected

◆ port_type

enum appl_port_type covise::CoviseBase::port_type[MAX_PORTS]
staticprotected

◆ progressCallbackData

void * CoviseBase::progressCallbackData = 0L
staticprotected

◆ progressCallbackFunc

CoviseCallback * CoviseBase::progressCallbackFunc = NULL
staticprotected

◆ progressUserData

void * CoviseBase::progressUserData = 0L
staticprotected

◆ quitCallbackData

void * CoviseBase::quitCallbackData = 0L
staticprotected

◆ quitCallbackFunc

CoviseCallback * CoviseBase::quitCallbackFunc = NULL
staticprotected

◆ quitInfoCallbackData

void * CoviseBase::quitInfoCallbackData = 0L
staticprotected

◆ quitInfoCallbackFunc

CoviseCallback * CoviseBase::quitInfoCallbackFunc = NULL
staticprotected

◆ quitInfoUserData

void * CoviseBase::quitInfoUserData = 0L
staticprotected

◆ quitUserData

void * CoviseBase::quitUserData = 0L
staticprotected

◆ reply_buffer

const char ** CoviseBase::reply_buffer = NULL
staticprotected

◆ reply_keyword

char * CoviseBase::reply_keyword = NULL
staticprotected

◆ reply_param_name

char * CoviseBase::reply_param_name = NULL
staticprotected

◆ reply_param_type

char * CoviseBase::reply_param_type = NULL
staticprotected

◆ socket_id

int CoviseBase::socket_id = 0
staticprotected

◆ tokenlist

vector< string > CoviseBase::tokenlist
staticprotected

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