| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

IXmlSvc Class Reference

An interface to provide supporting features for XML manipulation. More...

#include <DetDescCnv/IXmlSvc.h>

Inheritance diagram for IXmlSvc:

[legend]
Collaboration diagram for IXmlSvc:
[legend]
List of all members.

Public Types

 SUCCESS
 NO_INTERFACE
 VERSMISMATCH
 LAST_ERROR
enum  Status

Public Member Functions

virtual bool allowGenericCnv ()=0
 Tells whether generic conversion of user defined detector elements should be used in case the corresponding user defined converter is not available.
virtual double eval (const char *expr, bool check=true)=0
 Evaluates a numerical expresion.
virtual double eval (const std::string &expr, bool check=true)=0
 Evaluates a numerical expresion.
virtual bool addParameter (const std::string &name, const std::string &value)=0
 Adds a parameter in the list of known parameters.
virtual bool addParameter (const char *name, const char *value)=0
 Adds a parameter in the list of known parameters.
virtual bool addParameter (const char *name, double value)=0
 Adds a parameter in the list of known parameters.
virtual bool removeParameter (const std::string &name)=0
 Removes a parameter from the list of known parameters.
virtual bool removeParameter (const char *name)=0
 Removes a parameter from the list of known parameters.
virtual StatusCode queryInterface (const InterfaceID &riid, void **ppvInterface)=0
virtual unsigned long addRef ()=0
virtual unsigned long release ()=0
virtual IOVDOMDocumentparse (const char *fileName)=0
 This method parses an xml file and produces the corresponding DOM document.
virtual IOVDOMDocumentparseString (std::string source)=0
 This method parses XML from a string and produces the corresponding DOM document.
virtual void clearCache ()=0
 This clears the cache of previously parsed xml files.
virtual void releaseDoc (IOVDOMDocument *doc)=0
 Method to remove the lock from a document in the cache or to delete the document generated from a string.

Static Public Member Functions

static const InterfaceIDinterfaceID ()
 Retrieve interface ID.

Public Attributes

 SUCCESS
 NO_INTERFACE
 VERSMISMATCH
 LAST_ERROR

Detailed Description

An interface to provide supporting features for XML manipulation.

This includes among others the interface to the expression evaluation, the parameter handling and the xml parsing

Author:
Radovan Chytracek

Pere Mato

Sebastien Ponce

Definition at line 26 of file IXmlSvc.h.


Member Function Documentation

static const InterfaceID& IXmlSvc::interfaceID (  )  [inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 32 of file IXmlSvc.h.

00032 { return IID_IXmlSvc; }

virtual bool IXmlSvc::allowGenericCnv (  )  [pure virtual]

Tells whether generic conversion of user defined detector elements should be used in case the corresponding user defined converter is not available.

Returns:
true if generic conversion is allowed

virtual double IXmlSvc::eval ( const char *  expr,
bool  check = true 
) [pure virtual]

Evaluates a numerical expresion.

Parameters:
expr expresion to evaluate. It may include units and parameters
check boolean to control if the value needs to be check for being a dimentioned magnitude (with units)
Returns:
return double value

virtual double IXmlSvc::eval ( const std::string &  expr,
bool  check = true 
) [pure virtual]

Evaluates a numerical expresion.

Parameters:
expr expresion to evaluate. It may include units and parameters
check boolean to control if the value needs to be check for being a dimentioned magnitude (with units)
Returns:
return double value

virtual bool IXmlSvc::addParameter ( const std::string &  name,
const std::string &  value 
) [pure virtual]

Adds a parameter in the list of known parameters.

The value can also be an expression with units and other parameters.

Parameters:
name parameter name
value string which defines the value of the parameter.
Returns:
true if success

virtual bool IXmlSvc::addParameter ( const char *  name,
const char *  value 
) [pure virtual]

Adds a parameter in the list of known parameters.

The value can also be an expression with units and other parameters.

Parameters:
name parameter name
value string which defines the value of the parameter.
Returns:
true if success

virtual bool IXmlSvc::addParameter ( const char *  name,
double  value 
) [pure virtual]

Adds a parameter in the list of known parameters.

The value can also be an expression with units and other parameters.

Parameters:
name parameter name
value string which defines the value of the parameter.
Returns:
true if success

virtual bool IXmlSvc::removeParameter ( const std::string &  name  )  [pure virtual]

Removes a parameter from the list of known parameters.

Parameters:
name parameter name
Returns:
true if success

virtual bool IXmlSvc::removeParameter ( const char *  name  )  [pure virtual]

Removes a parameter from the list of known parameters.

Parameters:
name parameter name
Returns:
true if success

virtual IOVDOMDocument* IXmlParserSvc::parse ( const char *  fileName  )  [pure virtual, inherited]

This method parses an xml file and produces the corresponding DOM document.

The actual document is kept in a cache and locked. The user must call IXmlParserSvc::releaseDoc() when he does not need anymore the document.

Parameters:
fileName the name of the file to parse
Returns:
the document issued from the parsing

virtual IOVDOMDocument* IXmlParserSvc::parseString ( std::string  source  )  [pure virtual, inherited]

This method parses XML from a string and produces the corresponding DOM document.

Like for the DOMDocument generated from a file, this one has to be released with IXmlParserSvc::releaseDoc() too.

Parameters:
source the string to parse
Returns:
the document issued from the parsing

virtual void IXmlParserSvc::clearCache (  )  [pure virtual, inherited]

This clears the cache of previously parsed xml files.

virtual void IXmlParserSvc::releaseDoc ( IOVDOMDocument doc  )  [pure virtual, inherited]

Method to remove the lock from a document in the cache or to delete the document generated from a string.


The documentation for this class was generated from the following file:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Mon Apr 11 20:00:37 2011 for XmlTools by doxygen 1.4.7