Main MRPT website > C++ reference for MRPT 1.5.5
List of all members | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes
mrpt::utils::CStringList Class Reference

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:
Inheritance graph

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) throw ()
 
void operator delete[] (void *ptr) throw ()
 
void operator delete (void *memory, void *ptr) throw ()
 
voidoperator 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...
 
CStringListoperator<< (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::stringoperator() (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 mxArraywriteToMatlab () 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...
 
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...
 
CObjectclone () const
 Cloning interface for smart pointers. More...
 

Static Public Member Functions

static voidoperator 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::stringm_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::CObjectduplicate () const
 Returns a copy of the object, indepently of its class. More...
 
static mrpt::utils::CObjectCreateObject ()
 
static CStringListPtr Create ()
 

Member Typedef Documentation

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

Definition at line 35 of file CStringList.h.

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::CStringList ( )

Default constructor (empty string list)

Definition at line 30 of file CStringList.cpp.

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

Constructor from a text.

Definition at line 38 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

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

Explicit constructor from deque<string>

Definition at line 52 of file CStringList.h.

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

static const mrpt::utils::TRuntimeClassId* mrpt::utils::CStringList::_GetBaseClass ( )
staticprotected
void CStringList::add ( const std::string str)
void CStringList::clear ( )
CObject* mrpt::utils::CObject::clone ( ) const
inlineinherited

Cloning interface for smart pointers.

Definition at line 143 of file CObject.h.

static CStringListPtr mrpt::utils::CStringList::Create ( )
static
static mrpt::utils::CObject* mrpt::utils::CStringList::CreateObject ( )
static
virtual mrpt::utils::CObject* mrpt::utils::CStringList::duplicate ( ) const
virtual

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

Implements mrpt::utils::CObject.

mrpt::utils::CObjectPtr mrpt::utils::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 140 of file CObject.h.

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

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.

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.

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

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

Exceptions
std::exceptionIf the key is not found in the string list.

Definition at line 364 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

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

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

Exceptions
std::exceptionIf the key is not found in the string list.

Definition at line 353 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

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

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

Exceptions
std::exceptionIf the key is not found in the string list.

Definition at line 331 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

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

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

Exceptions
std::exceptionIf the key is not found in the string list.

Definition at line 342 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

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

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

Exceptions
std::exceptionIf 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.

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.

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().

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.

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.

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.

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

Definition at line 35 of file CStringList.h.

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

Definition at line 35 of file CStringList.h.

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

Definition at line 35 of file CStringList.h.

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

Definition at line 35 of file CStringList.h.

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

Definition at line 35 of file CStringList.h.

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

Definition at line 35 of file CStringList.h.

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

Definition at line 35 of file CStringList.h.

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

Definition at line 35 of file CStringList.h.

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.

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.

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.

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
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn 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.

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.

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.

Referenced by mrpt::hmtslam::CHMTSLAM::LSLAM_process_message_from_AA().

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.

void CStringList::set ( const std::string keyName,
const std::string value 
)

Sets the value of a given key ("key=value"), overwritten previous value if it existed.

Definition at line 375 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

void CStringList::set ( const std::string keyName,
const int value 
)

Sets the value of a given key ("key=value"), overwritten previous value if it existed.

Definition at line 400 of file CStringList.cpp.

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

void CStringList::set ( const std::string keyName,
const float &  value 
)

Sets the value of a given key ("key=value"), overwritten previous value if it existed.

Definition at line 409 of file CStringList.cpp.

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

void CStringList::set ( const std::string keyName,
const double &  value 
)

Sets the value of a given key ("key=value"), overwritten previous value if it existed.

Definition at line 419 of file CStringList.cpp.

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

void CStringList::set ( const std::string keyName,
const bool &  value 
)

Sets the value of a given key ("key=value"), overwritten previous value if it existed.

Definition at line 429 of file CStringList.cpp.

References MRPT_END, and MRPT_START.

void CStringList::setText ( const std::string inText)

Fills the string list by parsing a single string with '', '
', or '
' characters indicatng newlines.

Definition at line 164 of file CStringList.cpp.

References MRPT_END, MRPT_START, and mrpt::system::tokenize().

size_t CStringList::size ( ) const
virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const
inlinevirtualinherited

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.

Returns
A new mxArray (caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

void CStringList::writeToStream ( mrpt::utils::CStream out,
int getVersion 
) const
protectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters
outThe output binary stream where object must be dumped.
getVersionIf NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.
Exceptions
std::exceptionOn any error, see CStream::WriteBuffer
See Also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 221 of file CStringList.cpp.

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::utils::CStringList::_init_CStringList
staticprotected

Definition at line 35 of file CStringList.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject
staticinherited

Definition at line 128 of file CObject.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable
staticinherited

Definition at line 42 of file CSerializable.h.

mrpt::utils::TRuntimeClassId mrpt::utils::CStringList::classCStringList
static

Definition at line 35 of file CStringList.h.

const mrpt::utils::TRuntimeClassId* mrpt::utils::CStringList::classinfo
static

Definition at line 35 of file CStringList.h.

std::deque<std::string> mrpt::utils::CStringList::m_strings
protected

The internal list of strings.

Definition at line 40 of file CStringList.h.




Page generated by Doxygen 1.8.6 for MRPT 1.5.5 Git: e06b63d Fri Dec 1 14:41:11 2017 +0100 at sáb dic 2 13:00:21 CET 2017