exml::Document Class Reference
#include <Document.hpp>
Inheritance diagram for exml::Document:
Public Member Functions | |
| Document (ememory::SharedPtr< exml::internal::Node > _internalNode) | |
| Document (const exml::Document &_obj) | |
| Document () | |
| exml::Document & | operator= (const exml::Document &_obj) |
| void | setCaseSensitive (bool _val) |
| virtual bool | getCaseSensitive () const |
| bool | parse (const std::string &_data) |
| bool | generate (std::string &_data) |
| bool | load (const std::string &_file) |
| bool | store (const std::string &_file) |
| void | display () |
| void | setDisplayError (bool _value) |
| bool | getDisplayError () |
| void | displayError () |
 Public Member Functions inherited from exml::Element | |
| Element (const ememory::SharedPtr< exml::internal::Node > &_internalNode) | |
| Element (const exml::Element &_obj) | |
| Element (const std::string &_value="") | |
| exml::Element & | operator= (const exml::Element &_obj) |
| std::string | getText () const |
| void | clear () override |
| Public Member Functions inherited from exml::Node | |
| Node (const ememory::SharedPtr< exml::internal::Node > &_internalNode) | |
| Node () | |
| virtual | ~Node ()=default |
| bool | exist () const |
| exml::FilePos | getPos () const |
| virtual void | setValue (std::string _value) |
| const std::string & | getValue () const |
| enum nodeType | getType () const |
| exml::Document | toDocument () |
| const exml::Document | toDocument () const |
| exml::Attribute | toAttribute () |
| const exml::Attribute | toAttribute () const |
| exml::Comment | toComment () |
| const exml::Comment | toComment () const |
| exml::Declaration | toDeclaration () |
| const exml::Declaration | toDeclaration () const |
| exml::Element | toElement () |
| const exml::Element | toElement () const |
| exml::Text | toText () |
| const exml::Text | toText () const |
| bool | isDocument () const |
| bool | isAttribute () const |
| bool | isComment () const |
| bool | isDeclaration () const |
| bool | isElement () const |
| bool | isText () const |
Additional Inherited Members | |
| Public Attributes inherited from exml::Element | |
| ElementData | nodes |
| Public Attributes inherited from exml::AttributeList | |
| AttributeListData | attributes |
| Protected Member Functions inherited from exml::AttributeList | |
| AttributeList (const ememory::SharedPtr< exml::internal::Node > &_internalNode) | |
| AttributeList () | |
| Protected Attributes inherited from exml::Node | |
| ememory::SharedPtr< exml::internal::Node > | m_data |
Detailed Description
Basic document element of a document.
Constructor & Destructor Documentation
§ Document() [1/3]
| exml::Document::Document | ( | ememory::SharedPtr< exml::internal::Node > | _internalNode | ) |
Constructor.
- Parameters
-
[in] _internalNode Internal Node to set data
§ Document() [2/3]
| exml::Document::Document | ( | const exml::Document & | _obj | ) |
Copy constructor.
- Parameters
-
[in] _obj Object to copy
§ Document() [3/3]
| exml::Document::Document | ( | ) |
Constructor.
Member Function Documentation
§ display()
| void exml::Document::display | ( | ) |
Display the Document on console.
§ displayError()
| void exml::Document::displayError | ( | ) |
Display error detected.
§ generate()
| bool exml::Document::generate | ( | std::string & | _data | ) |
generate a string that contain the created XML
- Parameters
-
[out] _data Data where the xml is stored
- Returns
- false : An error occured
- true : Parsing is OK
§ getCaseSensitive()
|
virtual |
get the status of case sensitive mode.
- Returns
- true if case sensitive is active
§ getDisplayError()
| bool exml::Document::getDisplayError | ( | ) |
Get the display of the error status.
- Returns
- true Display error
- false Does not display error (get it at end)
§ load()
| bool exml::Document::load | ( | const std::string & | _file | ) |
Load the file that might contain the xml.
- Parameters
-
[in] _file Filename of the xml (compatible with etk FSNode naming)
- Returns
- false : An error occured
- true : Parsing is OK
§ operator=()
| exml::Document& exml::Document::operator= | ( | const exml::Document & | _obj | ) |
Copy constructor.
- Parameters
-
[in] _obj Object to copy
- Returns
- Reference on the local Object
§ parse()
| bool exml::Document::parse | ( | const std::string & | _data | ) |
parse a string that contain an XML
- Parameters
-
[in] _data Data to parse
- Returns
- false : An error occured
- true : Parsing is OK
§ setCaseSensitive()
| void exml::Document::setCaseSensitive | ( | bool | _val | ) |
Enable or diasable the case sensitive (must be done before the call of parsing)
- Parameters
-
[in] _val true if enable; false else.
§ setDisplayError()
| void exml::Document::setDisplayError | ( | bool | _value | ) |
Set the display of the error when detected.
- Parameters
-
[in] _value true: display error, false not display error (get it at end)
§ store()
| bool exml::Document::store | ( | const std::string & | _file | ) |
Store the Xml in the file.
- Parameters
-
[in] _file Filename of the xml (compatible with etk FSNode naming)
- Returns
- false : An error occured
- true : Parsing is OK
The documentation for this class was generated from the following file:
- framework/atria-soft/exml/exml/Document.hpp
