covise::CtlMessage Class Reference

#include <covise_msg.h>

Inheritance diagram for covise::CtlMessage:

Collaboration diagram for covise::CtlMessage:

Public Member Functions
	CtlMessage (Message *m)
	~CtlMessage ()
void	get_header (char **m, char **h, char **inst)
int	get_scalar_param (const char *, long *)
int	get_scalar_param (const char *, float *)
int	get_vector_param (const char *, int, long *)
int	get_vector_param (const char *, int, float *)
int	get_string_param (const char *, char **)
int	get_text_param (const char *, char ***, int *line_num)
int	get_boolean_param (const char *, int *)
int	get_slider_param (const char *, long *min, long *max, long *value)
int	get_slider_param (const char *, float *min, float *max, float *value)
int	get_browser_param (const char *, char **)
int	get_timer_param (const char *, long *start, long *delta, long *state)
int	get_passwd_param (const char *, char **host, char **user, char **passwd)
int	get_choice_param (const char *, int *)
int	get_choice_param (const char *, char **)
int	get_material_param (const char *, char **)
int	get_colormapchoice_param (const char *, int *)
int	get_colormapchoice_param (const char *, char **)
int	get_colormap_param (const char *, float *min, float *max, int *len, colormap_type *type)
int	get_color_param (const char *, float *r, float *g, float *b, float *a)
int	set_scalar_param (const char *, long)
int	set_scalar_param (const char *, float)
int	set_vector_param (const char *, int num, long *)
int	set_vector_param (const char *, int num, float *)
int	set_string_param (const char *, char *)
int	set_text_param (const char *, char *, int)
int	set_boolean_param (const char *, int)
int	set_slider_param (const char *, long min, long max, long value)
int	set_slider_param (const char *, float min, float max, float value)
int	set_choice_param (const char *, int, char **, int)
int	set_browser_param (const char *, char *, char *)
int	set_timer_param (const char *, long start, long delta, long state)
int	set_passwd_param (const char *, char *host, char *user, char *passwd)
char *	get_object_name (const char *name)
char *	getObjectType (const char *name)
int	set_save_object (const char *name)
int	set_release_object (const char *name)
int	create_finpart_message ()
int	create_finall_message ()
int	is_port_connected (const char *name)
Public Member Functions inherited from covise::Message
	Message ()
	Message (TokenBuffer &t)
	Message (const Connection *c)
	Message (int message_type, const std::string &str=std::string())
	Message (int message_type, const DataHandle &dh)
	Message (const Message &)
Message &	operator= (const Message &src)
void	copyAndReuseData (const Message &src)
void	print () override
Public Member Functions inherited from covise::MessageBase
	MessageBase ()
	MessageBase (TokenBuffer &tb)
	MessageBase (DataHandle &dh)
virtual	~MessageBase ()=default
virtual void	print ()=0

Private Member Functions
void	init_list ()

Private Attributes
char *	m_name
char *	h_name
char *	inst_no
int	no_of_objects
int	no_of_save_objects
int	no_of_release_objects
int	no_of_params_in
int	no_of_params_out
int	MAX_OUT_PAR
char **	port_names
char **	object_names
char **	object_types
int *	port_connected
char **	save_names
char **	release_names
Param **	params_in
Param **	params_out

Additional Inherited Members
Public Types inherited from covise::Message
enum	Type {   EMPTY = -1 , HOSTID = 81 , SOCKET_CLOSED = 84 , CLOSE_SOCKET = 31 ,   STDINOUT_EMPTY = 54 , UI = 6 , RENDER = 45 }
enum	SenderType { UNDEFINED = 0 , STDINOUT = 9 }
Public Attributes inherited from covise::Message
int	sender = -1
int	send_type = UNDEFINED
int	type = EMPTY
Public Attributes inherited from covise::MessageBase
DataHandle	data
const Connection *	conn = nullptr

Constructor & Destructor Documentation

CtlMessage()

covise::CtlMessage::CtlMessage ( Message *  m )

inline

~CtlMessage()

CtlMessage::~CtlMessage

(

)

Member Function Documentation

create_finall_message()

int CtlMessage::create_finall_message

(

)

create_finpart_message()

int CtlMessage::create_finpart_message

(

)

get_boolean_param()

int CtlMessage::get_boolean_param	(	const char *	param_name,
		int *	value
	)

get_browser_param()

int CtlMessage::get_browser_param	(	const char *	param_name,
		char **	file
	)

get_choice_param() [1/2]

int CtlMessage::get_choice_param	(	const char *	param_name,
		char **	string
	)

get_choice_param() [2/2]

int CtlMessage::get_choice_param	(	const char *	param_name,
		int *	sel
	)

get_color_param()

int CtlMessage::get_color_param	(	const char *	param_name,
		float *	r,
		float *	g,
		float *	b,
		float *	a
	)

get_colormap_param()

int CtlMessage::get_colormap_param	(	const char *	param_name,
		float *	min,
		float *	max,
		int *	len,
		colormap_type *	type
	)

get_colormapchoice_param() [1/2]

int CtlMessage::get_colormapchoice_param	(	const char *	param_name,
		char **	string
	)

get_colormapchoice_param() [2/2]

int CtlMessage::get_colormapchoice_param	(	const char *	param_name,
		int *	sel
	)

get_header()

void covise::CtlMessage::get_header ( char **  m, char **  h, char **  inst  )

inline

get_material_param()

int CtlMessage::get_material_param	(	const char *	param_name,
		char **	string
	)

get_object_name()

char * CtlMessage::get_object_name

(

const char *

name

)

get_passwd_param()

int CtlMessage::get_passwd_param	(	const char *	param_name,
		char **	host,
		char **	user,
		char **	passwd
	)

get_scalar_param() [1/2]

int CtlMessage::get_scalar_param	(	const char *	param_name,
		float *	value
	)

get_scalar_param() [2/2]

int CtlMessage::get_scalar_param	(	const char *	param_name,
		long *	value
	)

get_slider_param() [1/2]

int CtlMessage::get_slider_param	(	const char *	param_name,
		float *	min,
		float *	max,
		float *	value
	)

get_slider_param() [2/2]

int CtlMessage::get_slider_param	(	const char *	param_name,
		long *	min,
		long *	max,
		long *	value
	)

get_string_param()

int CtlMessage::get_string_param	(	const char *	param_name,
		char **	string
	)

get_text_param()

int CtlMessage::get_text_param	(	const char *	param_name,
		char ***	text,
		int *	line_num
	)

get_timer_param()

int CtlMessage::get_timer_param	(	const char *	param_name,
		long *	start,
		long *	delta,
		long *	state
	)

get_vector_param() [1/2]

int CtlMessage::get_vector_param	(	const char *	param_name,
		int	pos,
		float *	list
	)

get_vector_param() [2/2]

int CtlMessage::get_vector_param	(	const char *	param_name,
		int	pos,
		long *	list
	)

getObjectType()

char * CtlMessage::getObjectType

(

const char *

name

)

init_list()

void CtlMessage::init_list ( )

private

is_port_connected()

int CtlMessage::is_port_connected

(

const char *

name

)

set_boolean_param()

int CtlMessage::set_boolean_param	(	const char *	pname,
		int	val
	)

set_browser_param()

int CtlMessage::set_browser_param	(	const char *	pname,
		char *	file,
		char *
	)

set_choice_param()

int CtlMessage::set_choice_param	(	const char *	pname,
		int	len,
		char **	list,
		int	pos
	)

set_passwd_param()

int CtlMessage::set_passwd_param	(	const char *	pname,
		char *	host,
		char *	user,
		char *	passwd
	)

set_release_object()

int CtlMessage::set_release_object

(

const char *

name

)

set_save_object()

int CtlMessage::set_save_object

(

const char *

name

)

set_scalar_param() [1/2]

int CtlMessage::set_scalar_param	(	const char *	pname,
		float	val
	)

set_scalar_param() [2/2]

int CtlMessage::set_scalar_param	(	const char *	pname,
		long	val
	)

set_slider_param() [1/2]

int CtlMessage::set_slider_param	(	const char *	pname,
		float	min,
		float	max,
		float	value
	)

set_slider_param() [2/2]

int CtlMessage::set_slider_param	(	const char *	pname,
		long	min,
		long	max,
		long	value
	)

set_string_param()

int CtlMessage::set_string_param	(	const char *	pname,
		char *	val
	)

set_text_param()

int CtlMessage::set_text_param	(	const char *	pname,
		char *	text,
		int	linenum
	)

set_timer_param()

int CtlMessage::set_timer_param	(	const char *	pname,
		long	start,
		long	delta,
		long	state
	)

set_vector_param() [1/2]

int CtlMessage::set_vector_param	(	const char *	pname,
		int	num,
		float *	val
	)

set_vector_param() [2/2]

int CtlMessage::set_vector_param	(	const char *	pname,
		int	num,
		long *	val
	)

Member Data Documentation

h_name

char* covise::CtlMessage::h_name

private

inst_no

char* covise::CtlMessage::inst_no

private

m_name

char* covise::CtlMessage::m_name

private

MAX_OUT_PAR

int covise::CtlMessage::MAX_OUT_PAR

private

no_of_objects

int covise::CtlMessage::no_of_objects

private

no_of_params_in

int covise::CtlMessage::no_of_params_in

private

no_of_params_out

int covise::CtlMessage::no_of_params_out

private

no_of_release_objects

int covise::CtlMessage::no_of_release_objects

private

no_of_save_objects

int covise::CtlMessage::no_of_save_objects

private

object_names

char** covise::CtlMessage::object_names

private

object_types

char** covise::CtlMessage::object_types

private

params_in

Param** covise::CtlMessage::params_in

private

params_out

Param** covise::CtlMessage::params_out

private

port_connected

int* covise::CtlMessage::port_connected

private

port_names

char** covise::CtlMessage::port_names

private

release_names

char** covise::CtlMessage::release_names

private

save_names

char** covise::CtlMessage::save_names

private

---

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

• covise/covise_msg.h
• covise/covise_msg.cpp