Detailed Description

A class for storing a list of text lines.

This class is optimized for managing strings on a "per-line" basis, although methods are also provided to obtain/set the whole string list as a single, multi-line string. There are methods for saving and loading to/from text files. You can access to lines directly by "CStringList::get" or through the operator "CStringList::operator ()". The later can be used both, to read and to write elements. Also methods are provided for accesing the text by key if they are formated as "key=value" lines.

Definition at line 32 of file CStringList.h.

#include <mrpt/utils/CStringList.h>

Inheritance diagram for mrpt::utils::CStringList:

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) throw ()

void	operator delete[] (void *ptr) throw ()

void	operator delete (void memory, void ptr) throw ()

void *	operator new (size_t size, const std::nothrow_t &) throw ()

void	operator delete (void *ptr, const std::nothrow_t &) throw ()

	CStringList ()
	Default constructor (empty string list) More...

	CStringList (const std::string &text)
	Constructor from a text. More...

	CStringList (const std::deque< std::string > &lines)
	Explicit constructor from deque<string> More...

	CStringList (const std::vector< std::string > &lines)
	Explicit constructor from vector<string> More...

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

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

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,...) More...

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

void	clear ()
	Clear the whole list. More...

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

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

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. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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

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

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

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

virtual mxArray *	writeToMatlab () const
	Introduces a pure virtual method responsible for writing to a `mxArray` Matlab object, typically a MATLAB `struct` whose contents are documented in each derived class. More...

CObject *	clone () const
	Cloning interface for smart pointers. More...

RTTI classes and functions
mrpt::utils::CObjectPtr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream. More...

void	readFromStream (mrpt::utils::CStream &in, int version)
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

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

RTTI stuff
typedef CStringListPtr	Ptr

typedef CStringListPtr	ConstPtr

static mrpt::utils::CLASSINIT	_init_CStringList

static mrpt::utils::TRuntimeClassId	classCStringList

static const mrpt::utils::TRuntimeClassId *	classinfo

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

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime. More...

virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class. More...

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

static CStringListPtr	Create ()

Member Typedef Documentation

◆ ConstPtr

typedef CStringListPtr mrpt::utils::CStringList::ConstPtr

Definition at line 35 of file CStringList.h.

◆ Ptr

typedef CStringListPtr mrpt::utils::CStringList::Ptr

A typedef for the associated smart pointer

Definition at line 35 of file CStringList.h.

Constructor & Destructor Documentation

◆ CStringList() [1/4]

CStringList::CStringList ( )

Default constructor (empty string list)

Definition at line 30 of file CStringList.cpp.

◆ CStringList() [2/4]

CStringList::CStringList ( const std::string & text )

Constructor from a text.

Definition at line 38 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

◆ CStringList() [3/4]

mrpt::utils::CStringList::CStringList ( const std::deque< std::string > & lines )

inlineexplicit

Explicit constructor from deque<string>

Definition at line 52 of file CStringList.h.

◆ CStringList() [4/4]

mrpt::utils::CStringList::CStringList ( const std::vector< std::string > & lines )

inlineexplicit

Explicit constructor from vector<string>

Definition at line 55 of file CStringList.h.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ add()

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

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

See also: insert,set

Definition at line 49 of file CStringList.cpp.

Referenced by mrpt::opengl::CSetOfObjects::dumpListOfObjects(), mrpt::opengl::COpenGLScene::dumpListOfObjects(), mrpt::opengl::COpenGLViewport::dumpListOfObjects(), and mrpt::maps::CBeacon::getAsMatlabDrawCommands().

◆ clear()

void CStringList::clear ( )

Clear the whole list.

Definition at line 84 of file CStringList.cpp.

Referenced by mrpt::hmtslam::CLocalMetricHypothesis::dumpAsText(), mrpt::hmtslam::CHierarchicalMapMHPartition::dumpAsText(), mrpt::opengl::COpenGLScene::dumpListOfObjects(), and mrpt::maps::CBeacon::getAsMatlabDrawCommands().

◆ clone()

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 133 of file CObject.h.

◆ Create()

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

static

◆ CreateObject()

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

static

◆ duplicate()

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

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 162 of file CObject.h.

References mrpt::utils::CObjectPtr.

Referenced by mrpt::obs::CRawlog::addActions(), mrpt::slam::CIncrementalMapPartitioner::addMapFrame(), and mrpt::obs::CRawlog::addObservations().

◆ find()

bool CStringList::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.

Returns: true if string has been found.

Definition at line 107 of file CStringList.cpp.

References mrpt::system::os::_strcmp(), mrpt::system::os::_strcmpi(), MRPT_END, and MRPT_START.

◆ get()

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

Returns one string from the line list.

Definition at line 273 of file CStringList.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ get_bool()

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

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

Exceptions

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

Definition at line 364 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

◆ get_double()

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

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

Exceptions

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

Definition at line 353 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

◆ get_float()

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

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

Exceptions

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

Definition at line 331 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

◆ get_int()

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

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

Exceptions

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

Definition at line 342 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

◆ get_string()

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

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

Exceptions

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

Definition at line 310 of file CStringList.cpp.

References mrpt::format(), MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ GetRuntimeClass()

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

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ getText() [1/2]

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

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

Definition at line 135 of file CStringList.cpp.

References mrpt::system::os::memcpy(), MRPT_END, and MRPT_START.

Referenced by mrpt::utils::CConfigFileMemory::CConfigFileMemory(), mrpt::maps::CBeaconMap::saveToMATLABScript3D(), and mrpt::utils::CConfigFileMemory::setContent().

◆ getText() [2/2]

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

inline

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

Definition at line 116 of file CStringList.h.

◆ insert()

void CStringList::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,...)

See also: add,set

Definition at line 57 of file CStringList.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ loadFromFile()

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

Load the string list from a file.

Definition at line 174 of file CStringList.cpp.

References ASSERT_, mrpt::system::fileExists(), mrpt::utils::CFileInputStream::getTotalBytesCount(), MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ operator delete() [1/3]

void mrpt::utils::CStringList::operator delete	(	void *	ptr	)
throw	(
	)

inline

Definition at line 35 of file CStringList.h.

◆ operator delete() [2/3]

void mrpt::utils::CStringList::operator delete	(	void *	memory,
		void *	ptr
	)
throw	(
	)

inline

Definition at line 35 of file CStringList.h.

◆ operator delete() [3/3]

void mrpt::utils::CStringList::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 35 of file CStringList.h.

◆ operator delete[]()

void mrpt::utils::CStringList::operator delete[]	(	void *	ptr	)
throw	(
	)

inline

Definition at line 35 of file CStringList.h.

◆ operator new() [1/3]

static void* mrpt::utils::CStringList::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 35 of file CStringList.h.

◆ operator new() [2/3]

void* mrpt::utils::CStringList::operator new	(	size_t	size,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 35 of file CStringList.h.

◆ operator new() [3/3]

void* mrpt::utils::CStringList::operator new ( size_t size )

inline

Definition at line 35 of file CStringList.h.

◆ operator new[]()

void* mrpt::utils::CStringList::operator new[] ( size_t size )

inline

Definition at line 35 of file CStringList.h.

◆ operator()() [1/2]

string CStringList::operator() ( size_t index ) const

Returns one string from the line list.

Definition at line 286 of file CStringList.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ operator()() [2/2]

string & CStringList::operator() ( size_t index )

Returns a reference to one string from the line list.

Definition at line 298 of file CStringList.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ operator<<()

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

inline

An alternative way of adding strings to the list.

Definition at line 66 of file CStringList.h.

◆ readFromStream()

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

protectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 240 of file CStringList.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and version.

◆ remove()

void CStringList::remove ( size_t index )

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

Definition at line 93 of file CStringList.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ saveToFile()

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

Save the string list to a file.

Definition at line 201 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

◆ set() [1/6]

void CStringList::set	(	size_t	index,
		const std::string &	str
	)

Overwrites an existing position with a new value (0=first elements)

See also: insert

Definition at line 70 of file CStringList.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION.