Visual Servoing Platform  version 3.2.0
vpXmlParserRectOriented Class Reference

#include <vpXmlParserRectOriented.h>

+ Inheritance diagram for vpXmlParserRectOriented:

Public Types

enum  vpXmlCodeType {
  CODE_XML_BAD = -1, CODE_XML_OTHER, CODE_XML_CENTER_I, CODE_XML_CENTER_J,
  CODE_XML_HEIGHT, CODE_XML_WIDTH, CODE_XML_THETA
}
 
enum  vpXmlCodeSequenceType { SEQUENCE_OK, SEQUENCE_ERROR }
 

Public Member Functions

 vpXmlParserRectOriented ()
 
virtual ~vpXmlParserRectOriented ()
 
const vpRectOriented getRectangle ()
 
void setRectangle (const vpRectOriented rectangle)
 
Public Member Functions Inherited from vpXmlParser
void parse (const std::string &filename)
 
void save (const std::string &filename, const bool append=false)
 
void setMap (const std::map< std::string, int > &_map)
 
void setMainTag (const std::string &tag)
 

Static Public Member Functions

Static Public Member Functions Inherited from vpXmlParser
static void cleanup ()
 

Protected Member Functions

void readMainClass (xmlDocPtr doc, xmlNodePtr node)
 
void writeMainClass (xmlNodePtr node)
 

Protected Member Functions Inherited from vpXmlParser

bool xmlReadBoolChild (xmlDocPtr doc, xmlNodePtr node)
 
char * xmlReadCharChild (xmlDocPtr doc, xmlNodePtr node)
 
double xmlReadDoubleChild (xmlDocPtr doc, xmlNodePtr node)
 
float xmlReadFloatChild (xmlDocPtr doc, xmlNodePtr node)
 
int xmlReadIntChild (xmlDocPtr doc, xmlNodePtr node)
 
std::string xmlReadStringChild (xmlDocPtr doc, xmlNodePtr node)
 
unsigned int xmlReadUnsignedIntChild (xmlDocPtr doc, xmlNodePtr node)
 
void xmlWriteBoolChild (xmlNodePtr node, const char *label, const bool value)
 
void xmlWriteCharChild (xmlNodePtr node, const char *label, const char *value)
 
void xmlWriteDoubleChild (xmlNodePtr node, const char *label, const double value)
 
void xmlWriteFloatChild (xmlNodePtr node, const char *label, const float value)
 
void xmlWriteIntChild (xmlNodePtr node, const char *label, const int value)
 
void xmlWriteStringChild (xmlNodePtr node, const char *label, const std::string &value)
 
void xmlWriteUnsignedIntChild (xmlNodePtr node, const char *label, const unsigned int value)
 
std::map< std::string, int > nodeMap
 
std::string main_tag
 

Detailed Description

XML parser to load and save an oriented rectangle in a file.

The following example shows how to save an oriented rectangle in an xml file:

#include <visp3/core/vpRectOriented.h>
#include <visp3/core/vpXmlParserRectOriented.h>
int main()
{
vpRectOriented rect(vpImagePoint(10, 15), 20, 12, 0.25);
parser.setRectangle(rect);
std::string filename = "myRectangle.xml";
parser.save(filename);
return 0;
}

The following example shows how to read an oriented rectangle from an xml file:

#include <visp3/core/vpRectOriented.h>
#include <visp3/core/vpXmlParserRectOriented.h>
int main()
{
std::string filename = "myRectangle.xml";
parser.parse(filename);
vpRectOriented rect = parser.getRectangle();
return 0;
}
Warning
This class is only available if libxml2 is installed and detected by ViSP. Installation instructions are provided here https://visp.inria.fr/3rd_xml2.

Definition at line 95 of file vpXmlParserRectOriented.h.

Member Enumeration Documentation

◆ vpXmlCodeSequenceType

Enumerator
SEQUENCE_OK 
SEQUENCE_ERROR 

Definition at line 112 of file vpXmlParserRectOriented.h.

◆ vpXmlCodeType

Enumerator
CODE_XML_BAD 
CODE_XML_OTHER 
CODE_XML_CENTER_I 
CODE_XML_CENTER_J 
CODE_XML_HEIGHT 
CODE_XML_WIDTH 
CODE_XML_THETA 

Definition at line 102 of file vpXmlParserRectOriented.h.

Constructor & Destructor Documentation

◆ vpXmlParserRectOriented()

vpXmlParserRectOriented::vpXmlParserRectOriented ( )

Default constructor.

Definition at line 49 of file vpXmlParserRectOriented.cpp.

◆ ~vpXmlParserRectOriented()

vpXmlParserRectOriented::~vpXmlParserRectOriented ( )
virtual

Destructor.

Definition at line 61 of file vpXmlParserRectOriented.cpp.

Member Function Documentation

◆ cleanup()

static void vpXmlParser::cleanup ( )
inlinestaticinherited

As stated in http://xmlsoft.org/html/libxml-parser.html#xmlCleanupParser to clean up memory allocated by the xml2 library itself, the user should call xmlCleanupParser() only when the process has finished using the xml2 library. In case of doubt abstain from calling this function or do it just before calling exit() to avoid leak reports from valgrind ! That's why in ViSP the destructor doesn't call xmlCleanupParser(). Rather we provide the static function vpXmlParser::cleanup() that calls xmlCleanupParser() that could be called just before exit().

Examples
mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testXmlParser.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, and tutorial-mb-tracker-full.cpp.

Definition at line 309 of file vpXmlParser.h.

◆ getRectangle()

const vpRectOriented vpXmlParserRectOriented::getRectangle ( )
inline

Definition at line 114 of file vpXmlParserRectOriented.h.

◆ parse()

void vpXmlParser::parse ( const std::string &  filename)
inherited

parse the document. The data in the file are stored in the attributes of the child class. This method calls the readMainClass method which has to be implemented for every child class depending on the content to parse.

Parameters
filename: name of the file to parse

Definition at line 420 of file vpXmlParser.cpp.

Referenced by vpMbDepthDenseTracker::loadConfigFile(), vpMbDepthNormalTracker::loadConfigFile(), and vpMbTracker::loadConfigFile().

◆ readMainClass()

void vpXmlParserRectOriented::readMainClass ( xmlDocPtr  doc,
xmlNodePtr  node 
)
protectedvirtual

Reading method, called by vpXmlParser::parse().

Parameters
doc: a pointer representing the document.
node: the root node of the document.

Implements vpXmlParser.

Definition at line 68 of file vpXmlParserRectOriented.cpp.

◆ save()

void vpXmlParser::save ( const std::string &  filename,
const bool  append = false 
)
inherited

Save the content of the class in the file given in parameters. The data of the class are in the child class. This method calls the write_main_class method which has to be implemented for every class depending on the data to save.

Parameters
filename: the name of the file used to record the data
append: if true and if the file exists, the data will be added to the data already in the file

Definition at line 452 of file vpXmlParser.cpp.

◆ setMainTag()

void vpXmlParser::setMainTag ( const std::string &  tag)
inlineinherited

set the name of the main tag

The main tag corresponds to the name of the root node

Parameters
tag: name of the root node of the document

Definition at line 294 of file vpXmlParser.h.

◆ setMap()

void vpXmlParser::setMap ( const std::map< std::string, int > &  _map)
inlineinherited

Set the map describing the data to parse. This map stores the name of each node and an associated key used to simplify the parsing of the file.

If the following file want to be parsed:

<config>
<range>5</range>
<step>7</step>
<size_filter>3</size_filter>
</config>

The following map has to be declared:

std::map dataToParse;
dataToParse["config"] = 0;
dataToParse["range"] = 1;
dataToParse["step"] = 2;
dataToParse["size_filter"] = 3;

Or, you can use keyzord instead of number as key but it implies to declare in the child class an enumeration type of the name. For example:

typedef enum{
config,
range,
step,
size_filter} data_enum;
std::map dataToParse;
dataToParse["config"] = config;
dataToParse["range"] = range;
dataToParse["step"] = step;
dataToParse["size_filter"] = size_filter;
Parameters
_map: the map describing the data to parse

Definition at line 285 of file vpXmlParser.h.

◆ setRectangle()

void vpXmlParserRectOriented::setRectangle ( const vpRectOriented  rectangle)
inline

Definition at line 115 of file vpXmlParserRectOriented.h.

◆ writeMainClass()

void vpXmlParserRectOriented::writeMainClass ( xmlNodePtr  node)
protectedvirtual

Writing method, called by vpXmlParser::save().

Parameters
node: the root node of the document.

Implements vpXmlParser.

Definition at line 104 of file vpXmlParserRectOriented.cpp.

◆ xmlReadBoolChild()

bool vpXmlParser::xmlReadBoolChild ( xmlDocPtr  doc,
xmlNodePtr  node 
)
protectedinherited

read a boolean

Warning
throw a vpException::ioError if the value cannot be parsed to a bool
Parameters
doc: The main xml document
node: a pointer to the node to read value
Returns
the bool value in the node

Definition at line 281 of file vpXmlParser.cpp.

◆ xmlReadCharChild()

char * vpXmlParser::xmlReadCharChild ( xmlDocPtr  doc,
xmlNodePtr  node 
)
protectedinherited

Read an array of character.

Warning
The array of characters is allocated and must be explicitly freed to avoid memory leak.
Parameters
doc: The main xml document
node: a pointer to the node to read value
Returns
pointer to an allocated array of character.

Definition at line 99 of file vpXmlParser.cpp.

Referenced by vpMbtXmlGenericParser::read_projection_error().

◆ xmlReadDoubleChild()

double vpXmlParser::xmlReadDoubleChild ( xmlDocPtr  doc,
xmlNodePtr  node 
)
protectedinherited

read a double

Warning
throw a vpException::ioError if the value cannot be parsed to a double
Parameters
doc: The main xml document
node: a pointer to the node to read value
Returns
the double value in the node

Definition at line 211 of file vpXmlParser.cpp.

Referenced by vpMbXmlParser::read_lod(), and vpMbtXmlGenericParser::read_lod().

◆ xmlReadFloatChild()

float vpXmlParser::xmlReadFloatChild ( xmlDocPtr  doc,
xmlNodePtr  node 
)
protectedinherited

read a float

Warning
throw a vpException::ioError if the value cannot be parsed to a float
Parameters
doc: The main xml document
node: a pointer to the node to read value
Returns
the float value in the node

Definition at line 244 of file vpXmlParser.cpp.

◆ xmlReadIntChild()

int vpXmlParser::xmlReadIntChild ( xmlDocPtr  doc,
xmlNodePtr  node 
)
protectedinherited

read an int

Warning
throw a vpException::ioError if the value cannot be parsed to an integer
Parameters
doc: The main xml document
node: a pointer to the node to read value
Returns
the integer value in the node

Definition at line 143 of file vpXmlParser.cpp.

Referenced by vpMbXmlParser::read_lod(), vpMbtXmlGenericParser::read_lod(), and vpMbtXmlGenericParser::read_projection_error().

◆ xmlReadStringChild()

std::string vpXmlParser::xmlReadStringChild ( xmlDocPtr  doc,
xmlNodePtr  node 
)
protectedinherited

Read an array of character.

Parameters
doc: The main xml document
node: a pointer to the node to read value
Returns
std::string representing the value.

Definition at line 119 of file vpXmlParser.cpp.

◆ xmlReadUnsignedIntChild()

unsigned int vpXmlParser::xmlReadUnsignedIntChild ( xmlDocPtr  doc,
xmlNodePtr  node 
)
protectedinherited

read an int

Warning
throw a vpException::ioError if the value cannot be parsed to an unsigned integer
Parameters
doc: The main xml document
node: a pointer to the node to read value
Returns
the unsigned integer value in the node

Definition at line 177 of file vpXmlParser.cpp.

◆ xmlWriteBoolChild()

void vpXmlParser::xmlWriteBoolChild ( xmlNodePtr  node,
const char *  label,
const bool  value 
)
protectedinherited

write a bool.

Parameters
node: a pointer to the node to read value
label: label (name of the data) of the node
value: boolean to write (true or false)

Definition at line 397 of file vpXmlParser.cpp.

◆ xmlWriteCharChild()

void vpXmlParser::xmlWriteCharChild ( xmlNodePtr  node,
const char *  label,
const char *  value 
)
protectedinherited

write an array of character.

Parameters
node: a pointer to the node to read value
label: label (name of the data) of the node
value: pointer to the array of character to write

Definition at line 305 of file vpXmlParser.cpp.

◆ xmlWriteDoubleChild()

void vpXmlParser::xmlWriteDoubleChild ( xmlNodePtr  node,
const char *  label,
const double  value 
)
protectedinherited

write a double.

Parameters
node: a pointer to the node to read value
label: label (name of the data) of the node
value: double to write

Definition at line 365 of file vpXmlParser.cpp.

◆ xmlWriteFloatChild()

void vpXmlParser::xmlWriteFloatChild ( xmlNodePtr  node,
const char *  label,
const float  value 
)
protectedinherited

write a float.

Parameters
node: a pointer to the node to read value
label: label (name of the data) of the node
value: float to write

Definition at line 381 of file vpXmlParser.cpp.

◆ xmlWriteIntChild()

void vpXmlParser::xmlWriteIntChild ( xmlNodePtr  node,
const char *  label,
const int  value 
)
protectedinherited

write an integer.

Parameters
node: a pointer to the node to read value
label: label (name of the data) of the node
value: integer to write

Definition at line 333 of file vpXmlParser.cpp.

◆ xmlWriteStringChild()

void vpXmlParser::xmlWriteStringChild ( xmlNodePtr  node,
const char *  label,
const std::string &  value 
)
protectedinherited

write an array of character.

Parameters
node: a pointer to the node to read value
label: label (name of the data) of the node
value: std::string to write;

Definition at line 319 of file vpXmlParser.cpp.

◆ xmlWriteUnsignedIntChild()

void vpXmlParser::xmlWriteUnsignedIntChild ( xmlNodePtr  node,
const char *  label,
const unsigned int  value 
)
protectedinherited

write an unsigned integer.

Parameters
node: a pointer to the node to read value
label: label (name of the data) of the node
value: unsigned integer to write

Definition at line 349 of file vpXmlParser.cpp.

Member Data Documentation

◆ main_tag

std::string vpXmlParser::main_tag
protectedinherited

The name of the main tag for the file to parse

Definition at line 230 of file vpXmlParser.h.

◆ nodeMap

std::map<std::string, int> vpXmlParser::nodeMap
protectedinherited

The map describing the data to parse

Definition at line 225 of file vpXmlParser.h.

Referenced by vpMbXmlParser::read_lod(), vpMbtXmlGenericParser::read_lod(), and vpMbtXmlGenericParser::read_projection_error().

vpXmlParser::parse
void parse(const std::string &filename)
Definition: vpXmlParser.cpp:420
vpXmlParser::save
void save(const std::string &filename, const bool append=false)
Definition: vpXmlParser.cpp:452
vpRectOriented
Defines an oriented rectangle in the plane.
Definition: vpRectOriented.h:51
vpXmlParserRectOriented
XML parser to load and save an oriented rectangle in a file.
Definition: vpXmlParserRectOriented.h:95
vpImagePoint
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:87
vpXmlParserRectOriented::getRectangle
const vpRectOriented getRectangle()
Definition: vpXmlParserRectOriented.h:114
vpXmlParserRectOriented::setRectangle
void setRectangle(const vpRectOriented rectangle)
Definition: vpXmlParserRectOriented.h:115