ICClass Class Reference

TOBI iC class. More...

#include <tobiic/ICClass.hpp>

Collaboration diagram for ICClass:

Public Member Functions
	ICClass (ICLabel label, ICValue value=0.00f)
	Constructor Raises exceptions.
	ICClass (unsigned int label, ICValue value=0.00f)
	Constructor Raises exceptions.
virtual	~ICClass ()
	Destructor.
virtual ICValue	GetValue (void) const
	Value type getter.
virtual ICLabel	GetLabel (void) const
	Label type getter.
virtual unsigned int	GetLabelUInt (void) const
	Label type getter.
virtual ICClass *	SetValue (ICValue value=0.00f)
	Value type setter.
virtual ICClass *	SetLabel (ICLabel label)
	Label type setter Raises exceptions.
virtual ICClass *	SetLabel (unsigned int label)
	Label type setter Raises exceptions.
virtual const char *	GetChValue (void)
	Value type getter (as char array) Raises exceptions.
virtual const char *	GetChLabel (void)
	Label type getter (as char array)

Detailed Description

TOBI iC class.

This class is used to store a single pair of ICLabel and ICValue. Class labels are represented as strings for the time being (not to loose too much time with the different types).

See Also

ICClassifier, ICMessage, ICSerializer, ICSerializerRapid

Examples:

icclass.cpp, icclassifier.cpp, icexample.cpp, icserializerrapid.cpp, and tpicclient.cpp.

Definition at line 37 of file ICClass.hpp.

Constructor & Destructor Documentation

ICClass::ICClass	(	ICLabel	label,
		ICValue	value = 0.00f
	)

Constructor Raises exceptions.

Parameters

label	Label type
value	Value type
asint	Re-interpret input as integer

See Also

ICLabel, ICValue

Definition at line 31 of file ICClass.cpp.

ICClass::ICClass	(	unsigned int	label,
		ICValue	value = 0.00f
	)

Constructor Raises exceptions.

Parameters

label	Label type (as integer)
value	Value type

See Also

ICLabel, ICValue

Definition at line 36 of file ICClass.cpp.

Member Function Documentation

const char * ICClass::GetChLabel ( void  )

virtual

Label type getter (as char array)

Returns

A pointer to the ICClass instance

Examples:

icclass.cpp.

Definition at line 82 of file ICClass.cpp.

Here is the caller graph for this function:

const char * ICClass::GetChValue ( void  )

virtual

Value type getter (as char array) Raises exceptions.

Returns

A pointer to the ICClass instance

Examples:

icclass.cpp.

Definition at line 88 of file ICClass.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ICLabel ICClass::GetLabel ( void  ) const

virtual

Label type getter.

Returns

Label type

Examples:

icclass.cpp, icclassifier.cpp, and icserializerrapid.cpp.

Definition at line 48 of file ICClass.cpp.

Here is the caller graph for this function:

unsigned int ICClass::GetLabelUInt ( void  ) const

virtual

Label type getter.

Returns

Label type as integer or (int)0 on failure

Examples:

icserializerrapid.cpp.

Definition at line 52 of file ICClass.cpp.

ICValue ICClass::GetValue ( void  ) const

virtual

Value type getter.

Returns

Value type

Examples:

icclass.cpp.

Definition at line 44 of file ICClass.cpp.

Here is the caller graph for this function:

ICClass * ICClass::SetLabel ( ICLabel  label )

virtual

Label type setter Raises exceptions.

Returns

A pointer to the ICClass instance

Definition at line 61 of file ICClass.cpp.

ICClass * ICClass::SetLabel ( unsigned int  label )

virtual

Label type setter Raises exceptions.

Returns

A pointer to the ICClass instance

Definition at line 75 of file ICClass.cpp.

ICClass * ICClass::SetValue ( ICValue  value = 0.00f )

virtual

Value type setter.

Returns

A pointer to the ICClass instance

Examples:

icexample.cpp.

Definition at line 56 of file ICClass.cpp.

Here is the caller graph for this function:

---

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

• tobiic/ICClass.hpp
• tobiic/ICClass.cpp