class: exml::Comment
Description:
Constructor and Destructor:
+ Comment (void );
+ Comment (const std::string & _value);
+ virtual ~Comment (void );
Synopsis:
+ virtual enum nodeType getType (void ) const;
+ virtual bool iParse (const std::string & _data,
int32_t & _pos,
bool _caseSensitive,
exml::filePos & _filePos,
exml::Document & _doc);
+ virtual bool iGenerate (std::string & _data,
int32_t _indent) const;
+ virtual exml::Comment* toComment (void );
+ virtual const exml::Comment* toComment (void ) const;
Object Hierarchy:
+exml::Node
+--> exml::Comment
Detail:
Comment
+ Comment (void );
Constructor
Comment
+ Comment (const std::string & _value);
Constructor
Parameter [input]: _value comment value
~Comment
+ virtual ~Comment (void );
Destructor
getType
+ virtual enum nodeType getType (void ) const;
get the node type.
Return: the type of the Node.
iParse
+ virtual bool iParse (const std::string & _data,
int32_t & _pos,
bool _caseSensitive,
exml::filePos & _filePos,
exml::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,
int32_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.
toComment
+ virtual exml::Comment* toComment (void );
Cast the element in a Comment if it is possible.
Return: pointer on the class or NULL.
toComment
+ virtual const exml::Comment* toComment (void ) const;
Cast the element in a Comment if it is possible.
Return: pointer on the class or NULL.
+exml::Node
+--> exml::Comment
Detail:
Comment
+ Comment (void );Constructor
Comment
+ Comment (const std::string & _value);Constructor
| Parameter [input]: | _value | comment value |
~Comment
+ virtual ~Comment (void );Destructor
getType
+ virtual enum nodeType getType (void ) const;get the node type.
| Return: | the type of the Node. |
iParse
+ virtual bool iParse (const std::string & _data,parse the Current node [pure VIRUAL]
int32_t & _pos,
bool _caseSensitive,
exml::filePos & _filePos,
exml::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
int32_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. |
toComment
+ virtual exml::Comment* toComment (void );Cast the element in a Comment if it is possible.
| Return: | pointer on the class or NULL. |
toComment
+ virtual const exml::Comment* toComment (void ) const;Cast the element in a Comment if it is possible.
| Return: | pointer on the class or NULL. |