vrb Namespace Reference

Classes
class	regClass
class	regVar
class	clientRegClass
class	clientRegVar
class	regClassObserver
class	regVarObserver
class	SessionID
class	SharedStateBase
class	SharedState
class	SharedStateManager
	Manages the behaviour of all sharedStates depending on their sharedStateType. More...
class	VrbClientRegistry
class	VrbMessageSenderInterface
class	VrbRegistry

Enumerations
enum	SharedStateType { USE_COUPLING_MODE, NEVER_SHARE, ALWAYS_SHARE, SHARE_WITH_ALL }
enum	SharedStateDataType {   UNDEFINED = 0, BOOL, INT, FLOAT,   STRING, DOUBLE, VECTOR, SET,   MAP }

Functions
covise::TokenBuffer &	operator<< (covise::TokenBuffer &tb, const vrb::SessionID &id)
covise::TokenBuffer &	operator>> (covise::TokenBuffer &tb, vrb::SessionID &id)
template<>
SharedStateDataType	getSharedStateType< bool > (const bool &type)
template<>
SharedStateDataType	getSharedStateType< int > (const int &type)
template<>
SharedStateDataType	getSharedStateType< float > (const float &type)
template<>
SharedStateDataType	getSharedStateType< std::string > (const std::string &type)
template<>
SharedStateDataType	getSharedStateType< char > (const char &type)
template<>
SharedStateDataType	getSharedStateType< double > (const double &type)
std::string	tokenBufferToString (covise::TokenBuffer &&tb, int typeID)
template<class T >
SharedStateDataType	getSharedStateType (const T &type)
template<class T >
SharedStateDataType	getSharedStateType (const std::vector< T > &type)
template<class T >
SharedStateDataType	getSharedStateType (const std::set< T > &type)
template<class K , class V >
SharedStateDataType	getSharedStateType (const std::map< K, V > &type)
template<>
VRBEXPORT SharedStateDataType	getSharedStateType< bool > (const bool &type)
template<>
VRBEXPORT SharedStateDataType	getSharedStateType< int > (const int &type)
template<>
VRBEXPORT SharedStateDataType	getSharedStateType< float > (const float &type)
template<>
VRBEXPORT SharedStateDataType	getSharedStateType< std::string > (const std::string &type)
template<>
VRBEXPORT SharedStateDataType	getSharedStateType< char > (const char &type)
template<>
VRBEXPORT SharedStateDataType	getSharedStateType< double > (const double &type)
template<class T >
void	serialize (covise::TokenBuffer &tb, const T &value)
	convert the value to a TokenBuffer More...
template<class T >
void	serialize (covise::TokenBuffer &tb, const std::vector< T > &value)
template<class T >
void	serialize (covise::TokenBuffer &tb, const std::set< T > &value)
template<class K , class V >
void	serialize (covise::TokenBuffer &tb, const std::map< K, V > &value)
template<class T >
void	deserialize (covise::TokenBuffer &tb, T &value)
template<class T >
void	deserialize (covise::TokenBuffer &tb, std::vector< T > &value)
template<class T >
void	deserialize (covise::TokenBuffer &tb, std::set< T > &value)
template<class K , class V >
void	deserialize (covise::TokenBuffer &tb, std::map< K, V > &value)
template<class T >
void	serializeWithType (covise::TokenBuffer &tb, const T &value)
template<class T >
void	deserializeWithType (covise::TokenBuffer &tb, T &value)

Detailed Description

Basic class to synchronize the state of any variable with other clients connectet to vrb

for variables of types other than: bool, int, float, double, string, TokenBuffer the serialize and deserialize methods have to be implemented make sure the variable name is unique for each SharedState e.g. by naming the variable Plugin.Class.Variablename.ID

Enumeration Type Documentation

enum vrb::SharedStateDataType

Enumerator
UNDEFINED
BOOL
INT
FLOAT
STRING
DOUBLE
VECTOR
SET
MAP

enum vrb::SharedStateType

Enumerator
USE_COUPLING_MODE
NEVER_SHARE
ALWAYS_SHARE
SHARE_WITH_ALL

Function Documentation

template<class T >

void vrb::deserialize	(	covise::TokenBuffer &	tb,
		T &	value
	)

DESERIALIZE/////////////////////////////////// converts the TokenBuffer back to the value

template<class T >

void vrb::deserialize	(	covise::TokenBuffer &	tb,
		std::vector< T > &	value
	)

template<class T >

void vrb::deserialize	(	covise::TokenBuffer &	tb,
		std::set< T > &	value
	)

template<class K , class V >

void vrb::deserialize	(	covise::TokenBuffer &	tb,
		std::map< K, V > &	value
	)

template<class T >

void vrb::deserializeWithType	(	covise::TokenBuffer &	tb,
		T &	value
	)

template<class T >

SharedStateDataType vrb::getSharedStateType

(

const T &

type

)

template<class T >

SharedStateDataType vrb::getSharedStateType

(

const std::vector< T > &

type

)

template<class T >

SharedStateDataType vrb::getSharedStateType

(

const std::set< T > &

type

)

template<class K , class V >

SharedStateDataType vrb::getSharedStateType

(

const std::map< K, V > &

type

)

template<>

SharedStateDataType vrb::getSharedStateType< bool >

(

const bool &

type

)

template<>

VRBEXPORT SharedStateDataType vrb::getSharedStateType< bool >

(

const bool &

type

)

template<>

SharedStateDataType vrb::getSharedStateType< char >

(

const char &

type

)

template<>

VRBEXPORT SharedStateDataType vrb::getSharedStateType< char >

(

const char &

type

)

template<>

SharedStateDataType vrb::getSharedStateType< double >

(

const double &

type

)

template<>

VRBEXPORT SharedStateDataType vrb::getSharedStateType< double >

(

const double &

type

)

template<>

SharedStateDataType vrb::getSharedStateType< float >

(

const float &

type

)

template<>

VRBEXPORT SharedStateDataType vrb::getSharedStateType< float >

(

const float &

type

)

template<>

SharedStateDataType vrb::getSharedStateType< int >

(

const int &

type

)

template<>

VRBEXPORT SharedStateDataType vrb::getSharedStateType< int >

(

const int &

type

)

template<>

SharedStateDataType vrb::getSharedStateType< std::string >

(

const std::string &

type

)

template<>

VRBEXPORT SharedStateDataType vrb::getSharedStateType< std::string >

(

const std::string &

type

)

VRBEXPORT covise::TokenBuffer & vrb::operator<<	(	covise::TokenBuffer &	tb,
		const vrb::SessionID &	id
	)

VRBEXPORT covise::TokenBuffer & vrb::operator>>	(	covise::TokenBuffer &	tb,
		vrb::SessionID &	id
	)

template<class T >

void vrb::serialize	(	covise::TokenBuffer &	tb,
		const T &	value
	)

convert the value to a TokenBuffer

template<class T >

void vrb::serialize	(	covise::TokenBuffer &	tb,
		const std::vector< T > &	value
	)

template<class T >

void vrb::serialize	(	covise::TokenBuffer &	tb,
		const std::set< T > &	value
	)

template<class K , class V >

void vrb::serialize	(	covise::TokenBuffer &	tb,
		const std::map< K, V > &	value
	)

template<class T >

void vrb::serializeWithType	(	covise::TokenBuffer &	tb,
		const T &	value
	)

VRBEXPORT std::string vrb::tokenBufferToString	(	covise::TokenBuffer &&	tb,
		int	typeID
	)