COVISE Core
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
grmsg::coGRMsg Class Reference

#include <coGRMsg.h>

Inheritance diagram for grmsg::coGRMsg:
Inheritance graph
[legend]

Public Types

enum  Mtype {
  NO_TYPE = 0, REGISTER, GEO_VISIBLE, INTERACTOR_VISIBLE,
  SMOKE_VISIBLE, MOVE_INTERACTOR, INTERACTOR_USED, CREATE_VIEWPOINT,
  CREATE_DEFAULT_VIEWPOINT, SHOW_VIEWPOINT, SHOW_PRESENTATIONPOINT, CHANGE_VIEWPOINT_ID,
  CHANGE_VIEWPOINT_NAME, DELETE_VIEWPOINT, FLYMODE_TOGGLE, SET_CASE,
  SET_NAME, MOVE_OBJECT, ADD_DOCUMENT, SET_DOCUMENT_PAGE,
  SET_DOCUMENT_SCALE, SET_DOCUMENT_POSITION, SET_DOCUMENT_PAGESIZE, SEND_DOCUMENT_NUMBERS,
  DOC_VISIBLE, BOUNDARIES_OBJECT, COLOR_OBJECT, SHADER_OBJECT,
  MATERIAL_OBJECT, SET_TRANSPARENCY, KEYWORD, TRANSFORM_OBJECT,
  TRANSFORM_CASE, RESTRICT_AXIS, GRAPHIC_RESSOURCE, SET_MOVE,
  SET_MOVE_SELECTED, SENSOR, SENSOR_EVENT, ATTACHED_CLIPPLANE,
  ANIMATION_ON, ANIMATION_SPEED, ANIMATION_TIMESTEP, ACTIVATED_VIEWPOINT,
  VPCLIPPLANEMODE_TOGGLE, SNAPSHOT, SEND_CURRENT_DOCUMENT, SET_TRACKING_PARAMS,
  CHANGE_VIEWPOINT, VIEWPOINT_CHANGED, OBJECT_TRANSFORMED, SET_CONNECTIONPOINT,
  GENERIC_PARAM_REGISTER, GENERIC_PARAM_CHANGED, TRANSFORM_SGITEM, SELECT_OBJECT,
  DELETE_OBJECT, GEOMETRY_OBJECT, ADD_CHILD_OBJECT, TURNTABLE_ANIMATION,
  SET_VARIANT, SET_APPEARANCE, KINEMATICS_STATE
}
 id to specify the type of the message More...
 

Public Member Functions

 coGRMsg (const char *msg)
 recreate class from a message string More...
 
virtual ~coGRMsg ()
 destructor More...
 
int isValid ()
 whether recreate was succesful More...
 
virtual void print_stdout ()
 output content to stdout More...
 
Mtype getType ()
 access to private variables More...
 
const char * c_str ()
 
string getString ()
 

Protected Member Functions

 coGRMsg (Mtype type)
 construct used by child class More...
 
void addToken (const char *token)
 add a token to the message More...
 
string getFirstToken ()
 read first token in the message More...
 
string extractFirstToken ()
 read and delete first token in the message More...
 
vector< stringgetAllTokens ()
 read all tokens at once More...
 

Protected Attributes

int is_valid_
 valid can be overwritten by children if their recreation was not succesful More...
 

Private Attributes

const char SplitToken
 split message string by this token More...
 
const string MsgID
 string put to the header to identify the type Gui2RenderMessage More...
 
Mtype type_
 
string content_
 
char * str_
 char representation of content More...
 

Member Enumeration Documentation

id to specify the type of the message

Enumerator
NO_TYPE 
REGISTER 
GEO_VISIBLE 
INTERACTOR_VISIBLE 
SMOKE_VISIBLE 
MOVE_INTERACTOR 
INTERACTOR_USED 
CREATE_VIEWPOINT 
CREATE_DEFAULT_VIEWPOINT 
SHOW_VIEWPOINT 
SHOW_PRESENTATIONPOINT 
CHANGE_VIEWPOINT_ID 
CHANGE_VIEWPOINT_NAME 
DELETE_VIEWPOINT 
FLYMODE_TOGGLE 
SET_CASE 
SET_NAME 
MOVE_OBJECT 
ADD_DOCUMENT 
SET_DOCUMENT_PAGE 
SET_DOCUMENT_SCALE 
SET_DOCUMENT_POSITION 
SET_DOCUMENT_PAGESIZE 
SEND_DOCUMENT_NUMBERS 
DOC_VISIBLE 
BOUNDARIES_OBJECT 
COLOR_OBJECT 
SHADER_OBJECT 
MATERIAL_OBJECT 
SET_TRANSPARENCY 
KEYWORD 
TRANSFORM_OBJECT 
TRANSFORM_CASE 
RESTRICT_AXIS 
GRAPHIC_RESSOURCE 
SET_MOVE 
SET_MOVE_SELECTED 
SENSOR 
SENSOR_EVENT 
ATTACHED_CLIPPLANE 
ANIMATION_ON 
ANIMATION_SPEED 
ANIMATION_TIMESTEP 
ACTIVATED_VIEWPOINT 
VPCLIPPLANEMODE_TOGGLE 
SNAPSHOT 
SEND_CURRENT_DOCUMENT 
SET_TRACKING_PARAMS 
CHANGE_VIEWPOINT 
VIEWPOINT_CHANGED 
OBJECT_TRANSFORMED 
SET_CONNECTIONPOINT 
GENERIC_PARAM_REGISTER 
GENERIC_PARAM_CHANGED 
TRANSFORM_SGITEM 
SELECT_OBJECT 
DELETE_OBJECT 
GEOMETRY_OBJECT 
ADD_CHILD_OBJECT 
TURNTABLE_ANIMATION 
SET_VARIANT 
SET_APPEARANCE 
KINEMATICS_STATE 

Constructor & Destructor Documentation

GRMSGEXPORT coGRMsg::coGRMsg ( const char *  msg)

recreate class from a message string

parsed content will always be removed to enable all children to call extractFirstToken() to get their token

parse for msg id

parse message type

virtual grmsg::coGRMsg::~coGRMsg ( )
inlinevirtual

destructor

GRMSGEXPORT coGRMsg::coGRMsg ( Mtype  type)
protected

construct used by child class

Member Function Documentation

GRMSGEXPORT void coGRMsg::addToken ( const char *  token)
protected

add a token to the message

GRMSGEXPORT const char * coGRMsg::c_str ( )
GRMSGEXPORT string coGRMsg::extractFirstToken ( )
protected

read and delete first token in the message

GRMSGEXPORT vector< string > coGRMsg::getAllTokens ( )
protected

read all tokens at once

GRMSGEXPORT string coGRMsg::getFirstToken ( )
protected

read first token in the message

string grmsg::coGRMsg::getString ( )
inline
Mtype grmsg::coGRMsg::getType ( )
inline

access to private variables

int grmsg::coGRMsg::isValid ( )
inline

whether recreate was succesful

GRMSGEXPORT void coGRMsg::print_stdout ( )
virtual

output content to stdout

Member Data Documentation

string grmsg::coGRMsg::content_
private
int grmsg::coGRMsg::is_valid_
protected

valid can be overwritten by children if their recreation was not succesful

const string grmsg::coGRMsg::MsgID
private

string put to the header to identify the type Gui2RenderMessage

const char grmsg::coGRMsg::SplitToken
private

split message string by this token

char* grmsg::coGRMsg::str_
private

char representation of content

Mtype grmsg::coGRMsg::type_
private

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