class: ejson::String
Description:
Constructor and Destructor:
+ String (const std::string & _value);
+ virtual ~String ();
Synopsis:
# std::string m_value;
+ void set (const std::string & _value);
+ const std::string & get () const;
+ virtual bool iParse (const std::string & _data,
size_t & _pos,
ejson::filePos & _filePos,
ejson::Document & _doc);
+ virtual bool iGenerate (std::string & _data,
size_t _indent) const;
+ virtual bool transfertIn (ejson::Value* _obj);
+ virtual ejson::Value* duplicate () const;
Object Hierarchy:
+ejson::Value
+--> ejson::String
Detail:
String
+ String (const std::string & _value);
basic element of a xml structure
~String
+ virtual ~String ();
destructor
m_value
# std::string m_value;
value of the node (for element this is the name, for text it is the inside text ...)
set
+ void set (const std::string & _value);
set the value of the node.
Parameter [input]: _value New value of the node.
get
+ const std::string & get () const;
get the current element Value.
Return: the reference of the string value.
iParse
+ virtual bool iParse (const std::string & _data,
size_t & _pos,
ejson::filePos & _filePos,
ejson::Document & _doc);
parse the Current node [pure VIRUAL]
Parameter [input]: _data data string to parse.
Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
Parameter [input] [output]: file parsing position (line x col x)
Return: false if an error occured.
iGenerate
+ virtual bool iGenerate (std::string & _data,
size_t _indent) const;
generate a string with the tree of the xml
Parameter [input] [output]: _data string where to add the elements
Parameter [input]: current indentation of the file
Return: false if an error occured.
transfertIn
+ virtual bool transfertIn (ejson::Value* _obj);
Tranfert all element in the element set in parameter
Note: all element is remove from the curent element.
Parameter [input] [output]: _obj move all parameter in the selected element
Return: true if transfer is done corectly
duplicate
+ virtual ejson::Value* duplicate () const;
Copy the curent node and all the child in the curent one.
Return: NULL in an error occured, the pointer on the element otherwise
+ejson::Value
+--> ejson::String
Detail:
String
+ String (const std::string & _value);basic element of a xml structure
~String
+ virtual ~String ();destructor
m_value
# std::string m_value;value of the node (for element this is the name, for text it is the inside text ...)
set
+ void set (const std::string & _value);set the value of the node.
| Parameter [input]: | _value | New value of the node. |
get
+ const std::string & get () const;get the current element Value.
| Return: | the reference of the string value. |
iParse
+ virtual bool iParse (const std::string & _data,parse the Current node [pure VIRUAL]
size_t & _pos,
ejson::filePos & _filePos,
ejson::Document & _doc);
| Parameter [input]: | _data | data string to parse. | Parameter [input] [output]: | _pos | position in the string to start parse, return the position end of parsing. | Parameter [input]: | _caseSensitive | Request a parsion of element that is not case sensitive (all element is in low case) | Parameter [input] [output]: | file | parsing position (line x col x) |
| Return: | false if an error occured. |
iGenerate
+ virtual bool iGenerate (std::string & _data,generate a string with the tree of the xml
size_t _indent) const;
| Parameter [input] [output]: | _data | string where to add the elements | Parameter [input]: | current | indentation of the file |
| Return: | false if an error occured. |
transfertIn
+ virtual bool transfertIn (ejson::Value* _obj);Tranfert all element in the element set in parameter
Note: all element is remove from the curent element.
| Parameter [input] [output]: | _obj | move all parameter in the selected element |
| Return: | true if transfer is done corectly |
duplicate
+ virtual ejson::Value* duplicate () const;Copy the curent node and all the child in the curent one.
| Return: | NULL in an error occured, the pointer on the element otherwise |