Detailed Description

A decorator of CStringList special for keeping logs.

Note: Class written by Vicente Arevalo

Definition at line 34 of file CLog.h.

#include <mrpt/utils/CLog.h>

Inheritance diagram for mrpt::utils::CLog:

Public Member Functions
	CLog ()

virtual	~CLog ()

void	pushMessages (std::string message)
	push a message

void	pushMessages (mrpt::utils::CStringList messages)
	push a list of messages

void	popMessages (std::string &message)
	pop the current unpublished message (clear the content of "message")

void	popMessages (mrpt::utils::CStringList &messages)
	pop all unpublished messages (clear the content of "messages")

void	getMessages (size_t begin, size_t end, mrpt::utils::CStringList &messages)
	get messages from "begin" to "end" (clear the content of "messages")

void	saveLog (std::string name)
	save the current log

void	loadLog (std::string name)
	load a log (clear the previous content)

void	clearLog ()
	clear the log content

void	setLastMessageIndex (size_t index)
	change the last unpublished message.

size_t	getLastMessageIndex ()
	get the current unpublished message index.

Protected Member Functions
void	add (const std::string &str)
	Appends a new string at the end of the string list.

CStringList &	operator<< (const std::string &s)
	An alternative way of adding strings to the list.

void	insert (size_t index, const std::string &str)
	Inserts a new item at a given position (0=insert at the beggining,1=put into the second position,...)

void	set (size_t index, const std::string &str)
	Overwrites an existing position with a new value (0=first elements)

void	set (const std::string &keyName, const std::string &value)
	Sets the value of a given key ("key=value"), overwritten previous value if it existed.

void	set (const std::string &keyName, const int &value)
	Sets the value of a given key ("key=value"), overwritten previous value if it existed.

void	set (const std::string &keyName, const float &value)
	Sets the value of a given key ("key=value"), overwritten previous value if it existed.

void	set (const std::string &keyName, const double &value)
	Sets the value of a given key ("key=value"), overwritten previous value if it existed.

void	set (const std::string &keyName, const bool &value)
	Sets the value of a given key ("key=value"), overwritten previous value if it existed.

void	clear ()
	Clear the whole list.

size_t	size () const
	Returns the number of text lines in the list.

void	remove (size_t index)
	Delete the element at a given position (0=first element)

bool	find (const std::string &compareText, size_t foundIndex, bool caseSensitive=true) const
	Looks for a given string in the list, and returns its index, or returns "false" otherwise.

void	get (size_t index, std::string &outText) const
	Returns one string from the line list.

std::string	operator() (size_t index) const
	Returns one string from the line list.

std::string &	operator() (size_t index)
	Returns a reference to one string from the line list.

void	getText (std::string &outText) const
	Returns the whole string list as a single string with '\r ' characters for newlines.

std::string	getText () const
	Returns the whole string list as a single string with '\r ' characters for newlines.

void	setText (const std::string &inText)
	Fills the string list by parsing a single string with '\r', ' ', or '\r ' characters indicatng newlines.

void	loadFromFile (const std::string &fileName)
	Load the string list from a file.

void	saveToFile (const std::string &fileName) const
	Save the string list to a file.

std::string	get_string (const std::string &keyName)
	Returns the value of the given key ("key=value").

float	get_float (const std::string &keyName)
	Returns the value of the given key ("key=value").

int	get_int (const std::string &keyName)
	Returns the value of the given key ("key=value").

double	get_double (const std::string &keyName)
	Returns the value of the given key ("key=value").

bool	get_bool (const std::string &keyName)
	Returns the value of the given key ("key=value").

CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const MRPT_OVERRIDE

void	readFromStream (mrpt::utils::CStream &in, int version) MRPT_OVERRIDE

Protected Attributes
mrpt::synch::CCriticalSection	semaphore

size_t	last

std::deque< std::string >	m_strings
	The internal list of strings.

RTTI stuff <br>
typedef CStringListPtr	SmartPtr

static mrpt::utils::CLASSINIT	_init_CStringList

static mrpt::utils::TRuntimeClassId	classCStringList

static const mrpt::utils::TRuntimeClassId *	classinfo

static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()

static mrpt::utils::CObject *	CreateObject ()

static CStringListPtr	Create ()

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const MRPT_OVERRIDE

virtual mrpt::utils::CObject *	duplicate () const MRPT_OVERRIDE

Member Typedef Documentation

◆ SmartPtr

typedef CStringListPtr mrpt::utils::CStringList::SmartPtr

inherited

A typedef for the associated smart pointer

Definition at line 35 of file CStringList.h.

Constructor & Destructor Documentation

◆ CLog()

mrpt::utils::CLog::CLog ( )

◆ ~CLog()

virtual mrpt::utils::CLog::~CLog ( )

virtual

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId * mrpt::utils::CStringList::_GetBaseClass ( )

staticprotectedinherited

◆ add()

void mrpt::utils::CStringList::add ( const std::string & str )

inherited

Appends a new string at the end of the string list.

See also: insert,set

◆ clear()

void mrpt::utils::CStringList::clear ( )

inherited

Clear the whole list.

◆ clearLog()

void mrpt::utils::CLog::clearLog ( )

clear the log content

◆ Create()

static CStringListPtr mrpt::utils::CStringList::Create ( )

staticinherited

◆ CreateObject()

static mrpt::utils::CObject * mrpt::utils::CStringList::CreateObject ( )

staticinherited

◆ duplicate()

virtual mrpt::utils::CObject * mrpt::utils::CStringList::duplicate ( ) const

virtualinherited

◆ find()

bool mrpt::utils::CStringList::find	(	const std::string &	compareText,
		size_t	foundIndex,
		bool	caseSensitive = `true`
	)		const

inherited

Looks for a given string in the list, and returns its index, or returns "false" otherwise.

Returns: true if string has been found.

◆ get()

void mrpt::utils::CStringList::get	(	size_t	index,
		std::string &	outText
	)		const

inherited

Returns one string from the line list.

◆ get_bool()

bool mrpt::utils::CStringList::get_bool ( const std::string & keyName )

inherited

Returns the value of the given key ("key=value").

Exceptions

std::exception If the key is not found in the string list.

◆ get_double()

double mrpt::utils::CStringList::get_double ( const std::string & keyName )

inherited

Returns the value of the given key ("key=value").

Exceptions

std::exception If the key is not found in the string list.

◆ get_float()

float mrpt::utils::CStringList::get_float ( const std::string & keyName )

inherited

Returns the value of the given key ("key=value").

Exceptions

std::exception If the key is not found in the string list.

◆ get_int()

int mrpt::utils::CStringList::get_int ( const std::string & keyName )

inherited

Returns the value of the given key ("key=value").

Exceptions

std::exception If the key is not found in the string list.

◆ get_string()

std::string mrpt::utils::CStringList::get_string ( const std::string & keyName )

inherited

Returns the value of the given key ("key=value").

Exceptions

std::exception If the key is not found in the string list.

◆ getLastMessageIndex()

size_t mrpt::utils::CLog::getLastMessageIndex ( )

get the current unpublished message index.

◆ getMessages()

void mrpt::utils::CLog::getMessages	(	size_t	begin,
		size_t	end,
		mrpt::utils::CStringList &	messages
	)

get messages from "begin" to "end" (clear the content of "messages")

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId * mrpt::utils::CStringList::GetRuntimeClass ( ) const

virtualinherited

◆ getText() [1/2]

std::string mrpt::utils::CStringList::getText ( ) const

inlineinherited

Returns the whole string list as a single string with '\r
' characters for newlines.

Definition at line 116 of file CStringList.h.

◆ getText() [2/2]

void mrpt::utils::CStringList::getText ( std::string & outText ) const

inherited

Returns the whole string list as a single string with '\r
' characters for newlines.

◆ insert()

void mrpt::utils::CStringList::insert	(	size_t	index,
		const std::string &	str
	)

inherited

Inserts a new item at a given position (0=insert at the beggining,1=put into the second position,...)

See also: add,set

◆ loadFromFile()

void mrpt::utils::CStringList::loadFromFile ( const std::string & fileName )

inherited

Load the string list from a file.

◆ loadLog()

void mrpt::utils::CLog::loadLog ( std::string name )

load a log (clear the previous content)

◆ operator()() [1/2]

std::string & mrpt::utils::CStringList::operator() ( size_t index )

inherited

Returns a reference to one string from the line list.

◆ operator()() [2/2]

std::string mrpt::utils::CStringList::operator() ( size_t index ) const

inherited

Returns one string from the line list.

◆ operator<<()

CStringList & mrpt::utils::CStringList::operator<< ( const std::string & s )

inlineinherited

An alternative way of adding strings to the list.

Definition at line 66 of file CStringList.h.

◆ popMessages() [1/2]

void mrpt::utils::CLog::popMessages ( mrpt::utils::CStringList & messages )

pop all unpublished messages (clear the content of "messages")

◆ popMessages() [2/2]

void mrpt::utils::CLog::popMessages ( std::string & message )

pop the current unpublished message (clear the content of "message")

◆ pushMessages() [1/2]

void mrpt::utils::CLog::pushMessages ( mrpt::utils::CStringList messages )

push a list of messages

◆ pushMessages() [2/2]

void mrpt::utils::CLog::pushMessages ( std::string message )

push a message

◆ readFromStream()

void mrpt::utils::CStringList::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedinherited

◆ remove()

void mrpt::utils::CStringList::remove ( size_t index )

inherited

Delete the element at a given position (0=first element)

◆ saveLog()

void mrpt::utils::CLog::saveLog ( std::string name )

save the current log

◆ saveToFile()

void mrpt::utils::CStringList::saveToFile ( const std::string & fileName ) const

inherited

Save the string list to a file.