SHAPER
9.12.0
|
Class to process feature's xml definition. More...
Public Member Functions | |
Config_FeatureReader (const std::string &theXmlFile, const std::string &theLibraryName, const std::string &theDocSection=std::string(), const char *theEventGenerated=0) | |
Constructor. More... | |
std::list< std::string > | features () const |
Returns list of all features defined in reader's file. More... | |
CONFIG_EXPORT void | readAll () |
CONFIG_EXPORT xmlNodePtr | findRoot (const std::string theDocumentPath="") |
CONFIG_EXPORT const char * | encoding () const |
Static Public Member Functions | |
static CONFIG_EXPORT std::string | resourcesConfigFile () |
static CONFIG_EXPORT std::string | pluginConfigFile () |
static CONFIG_EXPORT std::string | findConfigFile (const std::string theFileName, const int theFindIndex=0) |
Checks all possible paths to configuration file given Uses theFindIndex if several solutions can be found (this is the number of solution to find) More... | |
Protected Member Functions | |
virtual void | processNode (xmlNodePtr aNode) |
Overloaded method. Defines how to process each node. More... | |
virtual void | cleanup (xmlNodePtr aNode) |
Overloaded method. Clears attribute cache on exit from attribute's node. More... | |
virtual bool | processChildren (xmlNodePtr aNode) |
Overloaded method. Defines if the given node should be parsed recursively. More... | |
void | fillFeature (xmlNodePtr theRoot, const std::shared_ptr< Config_FeatureMessage > &outFeatureMessage) |
Fills feature message. More... | |
void | readRecursively (xmlNodePtr theParent) |
xmlNodePtr | node (void *theNode) |
void* -> xmlNodePtr More... | |
std::string | getNodeName (xmlNodePtr theNode) |
Gets xml node name. More... | |
void | storeAttribute (xmlNodePtr theNode, const char *theNodeAttribute, bool doClean=false) |
Stores an attribute in internal map for later use. More... | |
std::string | restoreAttribute (xmlNodePtr theNode, const char *theNodeAttribute) |
Restores an attribute from internal map. More... | |
std::string | restoreAttribute (const char *theNodeName, const char *theNodeAttribute) |
Restores an attribute from internal map. More... | |
bool | cleanupAttribute (xmlNodePtr theNode, const char *theNodeAttribute) |
Cleanups attribute from cache. More... | |
bool | cleanupAttribute (const char *theNodeName, const char *theNodeAttribute) |
Cleanups attribute from cache. More... | |
Protected Attributes | |
std::string | myDocumentPath |
Path to the xml document. More... | |
xmlDocPtr | myXmlDoc |
Root of the xml document. More... | |
std::string | myRootFileName |
name of the root file More... | |
std::map< std::string, std::string > | myCachedAttributes |
A map to store all parent's attributes. More... | |
bool | isFromMemory |
Class to process feature's xml definition.
Config_FeatureReader::Config_FeatureReader | ( | const std::string & | theXmlFile, |
const std::string & | theLibraryName, | ||
const std::string & | theDocSection = std::string() , |
||
const char * | theEventGenerated = 0 |
||
) |
Constructor.
std::list< std::string > Config_FeatureReader::features | ( | ) | const |
Returns list of all features defined in reader's file.
|
protectedvirtual |
Overloaded method. Defines how to process each node.
the box is optional, attribute is in case if the optional attribute value is not empty
Reimplemented from Config_XMLReader.
|
protectedvirtual |
Overloaded method. Clears attribute cache on exit from attribute's node.
Reimplemented from Config_XMLReader.
|
protectedvirtual |
Overloaded method. Defines if the given node should be parsed recursively.
Reimplemented from Config_XMLReader.
|
protected |
Fills feature message.
|
staticinherited |
Returns a path to resource files (created from ROOT_DIR environment variable)
|
staticinherited |
Returns a path to the plugins.xml file (created from ROOT_DIR environment variable)
|
inherited |
Read all nodes in associated xml file, recursively if processChildren(xmlNode) is true for the xmlNode. For each read node the processNode will be called.
|
inherited |
Returns xmlNodePtr to the root of reader's document or NULL if not found. If the path to the document to read is empty, uses myDocumentPath.
|
staticinherited |
Checks all possible paths to configuration file given Uses theFindIndex if several solutions can be found (this is the number of solution to find)
|
protectedinherited |
Calls processNode() for each child (for some - recursively) of the given node.
|
protectedinherited |
void* -> xmlNodePtr
|
protectedinherited |
Gets xml node name.
|
protectedinherited |
Stores an attribute in internal map for later use.
Key is "Node_Name:Node_Attribute" and value is getProperty(theNodeAttribute)
|
protectedinherited |
Restores an attribute from internal map.
|
protectedinherited |
Restores an attribute from internal map.
|
protectedinherited |
Cleanups attribute from cache.
|
protectedinherited |
Cleanups attribute from cache.
|
protectedinherited |
Path to the xml document.
|
protectedinherited |
Root of the xml document.
|
protectedinherited |
name of the root file
|
protectedinherited |
A map to store all parent's attributes.
The key has from "Node_Name:Node_Attribute"