yane::Utils::DebugClient Class Reference

DebugClient class. More...

Collaboration diagram for yane::Utils::DebugClient:

List of all members.

Public Member Functions
	DebugClient (DebugMaster *master, const std::string &clientname)
	Constructor.
	DebugClient (const DebugClient &input)
	Copy Constructor.
std::string	name () const
	Get Name.
DebugClient &	operator= (const DebugClient &input)
	assignment operator
void	sendDebugInfo (std::string message, std::string dataname="", void *data=0, int datasize=0, int datatype=0, int level=0)
	Adds a debug message and data to the master.
void	sendDebugInfo (const char *message, const char *dataname=0, void *data=0, int datasize=0, int datatype=0, int level=0)
	Adds a debug message and data to the master.
virtual void	sendDebugMessage (const std::string &message, int debuglevel)
	Submit a debugmessage.
virtual void	sendDebugMessageDouble (const std::string &message, const std::string &varname, int length, double *data, int debuglevel)
	Submit a debugmessage with doublevalued data.
virtual void	sendDebugMessageInt (const std::string &message, const std::string &varname, int length, int *data, int debuglevel)
	Submit a debugmessage with integervalued data.
virtual void	sendDebugMessageString (const std::string &message, const std::string &varname, const char *data, int debuglevel)
	Submit a debugmessage with textstring data.
	~DebugClient ()
	Destructor.
Protected Attributes
DebugMaster *	_master

---

Detailed Description

See also:

DebugMaster This class uses a DebugMaster to debug information. Usually this class is used as the following example :

                 RTClock::RTClock *clock = new RTClock::RTClock();
                 DebugMasterConsole::DebugMasterConsole *master = new DebugMasterConsole::DebugMasterConsole(clock, 90);
                 DebugClient::DebugClient *debug = master->newClient("Main");
                 debug->sendDebugInfo("Testmessage", 0, 0, 0, 0, 6);
                 debug->sendDebugInfo("Testmessage");
                 delete clock;
                 delete master;
                 delete debug;

Every program has usually only one DebugMaster and more than one DebugClient (e.g. threads have their own DebugClient, ...).

---

Constructor & Destructor Documentation

LIB_EXPORT yane::Utils::DebugClient::DebugClient	(	DebugMaster *	master,
		const std::string &	clientname
	)

Creates a new DebugClient object. You should use master->newClient instead.

Parameters:

master	Associated master
clientname	Name of the client, is shown in the debug messages.

LIB_EXPORT yane::Utils::DebugClient::DebugClient

(

const DebugClient &

input

)

Creates a new DebugClient object.

Parameters:

input

DebugClient

LIB_EXPORT yane::Utils::DebugClient::~DebugClient

(

)

Destroys the object.

---

Member Function Documentation

LIB_EXPORT std::string yane::Utils::DebugClient::name

(

)

const

Returns name of the Client

Returns:

name of the client

LIB_EXPORT yane::Utils::DebugClient & yane::Utils::DebugClient::operator=

(

const DebugClient &

input

)

assignment operator

Parameters:

input

DebugClient

Returns:

DebugClient

LIB_EXPORT void yane::Utils::DebugClient::sendDebugInfo	(	const char *	message,
		const char *	dataname = 0,
		void *	data = 0,
		int	datasize = 0,
		int	datatype = 0,
		int	level = 0
	)

Adds a debug message and data to the master. Depending on the master the message is written to file (DebugMasterFile) or Console (DebugMasterConsole).

Parameters:

message	Debug message
dataname	Name of the data
data	Pointer to the data
datasize	Size of the data
datatype	Type of the data
level	Debug level

LIB_EXPORT void yane::Utils::DebugClient::sendDebugInfo	(	std::string	message,
		std::string	dataname = "",
		void *	data = 0,
		int	datasize = 0,
		int	datatype = 0,
		int	level = 0
	)

Adds a debug message and data to the master. Depending on the master the message is written to file (DebugMasterFile) or Console (DebugMasterConsole).

Parameters:

message	Debug message
dataname	Name of the data
data	Pointer to the data
datasize	Size of the data
datatype	Type of the data
level	Debug level

LIB_EXPORT void yane::Utils::DebugClient::sendDebugMessage	(	const std::string &	message,
		int	debuglevel
	)		[virtual]

Added for convenient handling

Parameters:

message	Message which is debugged
debuglevel	Level with which the message is debugged.

LIB_EXPORT void yane::Utils::DebugClient::sendDebugMessageDouble	(	const std::string &	message,
		const std::string &	varname,
		int	length,
		double *	data,
		int	debuglevel
	)		[virtual]

Added for convenient handling

Parameters:

message	Message which is debugged
varname	Data name
length	Length of data array
data	Data which is added.
debuglevel	Level with which the message is debugged.

LIB_EXPORT void yane::Utils::DebugClient::sendDebugMessageInt	(	const std::string &	message,
		const std::string &	varname,
		int	length,
		int *	data,
		int	debuglevel
	)		[virtual]

Added for convenient handling

Parameters:

message	Message which is debugged
varname	Data name
length	Length of data array
data	Data which is added.
debuglevel	Level with which the message is debugged.

LIB_EXPORT void yane::Utils::DebugClient::sendDebugMessageString	(	const std::string &	message,
		const std::string &	varname,
		const char *	data,
		int	debuglevel
	)		[virtual]

Added for convenient handling

Parameters:

message	Message which is debugged
varname	Data name
data	Pointer to an additional nullterminated character array, that has to be stored as data
debuglevel	Level with which the message is debugged.

---

Member Data Documentation

DebugMaster* yane::Utils::DebugClient::_master [protected]

< Master this object is using. Name of the client.