{core} Class of object that encapsulates the properties of an SBML converter.
This class of objects is defined by libSBML only and has no direct
equivalent in terms of SBML components. It is a class used in
the implementation of extra functionality provided by libSBML.
The properties of SBML converters are communicated using objects of class ConversionProperties, and within such objects, individual options are encapsulated using ConversionOption objects. The ConversionProperties class provides numerous methods for setting and getting options.
ConversionProperties objects are also used to determine the target SBML namespace when an SBML converter's behavior depends on the intended Level+Version combination of SBML. In addition, it is conceivable that conversions may be affected by SBML Level 3 packages being used by an SBML document. These, too, are communicated by the values of the SBML namespaces set on a ConversionProperties object.
- See also
- ConversionOption
-
SBMLNamespaces
- Examples:
- inlineFunctionDefintions.cpp, promoteParameters.cpp, and stripPackage.cpp.
|
virtual void | addOption (const ConversionOption &option) |
| Adds a copy of the given option to this properties object. More...
|
|
virtual void | addOption (std::string key, std::string value="", ConversionOptionType_t type=CNV_TYPE_STRING, std::string description="") |
| Adds a new ConversionOption object with the given parameters. More...
|
|
virtual void | addOption (std::string key, const char *value, std::string description="") |
| Adds a new ConversionOption object with the given parameters. More...
|
|
virtual void | addOption (std::string key, bool value, std::string description="") |
| Adds a new ConversionOption object with the given parameters. More...
|
|
virtual void | addOption (std::string key, double value, std::string description="") |
| Adds a new ConversionOption object with the given parameters. More...
|
|
virtual void | addOption (std::string key, float value, std::string description="") |
| Adds a new ConversionOption object with the given parameters. More...
|
|
virtual void | addOption (std::string key, int value, std::string description="") |
| Adds a new ConversionOption object with the given parameters. More...
|
|
virtual ConversionProperties * | clone () const |
| Creates and returns a deep copy of this ConversionProperties object. More...
|
|
| ConversionProperties (SBMLNamespaces *targetNS=NULL) |
| Constructor that initializes the conversion properties with a specific SBML target namespace. More...
|
|
| ConversionProperties (const ConversionProperties &orig) |
| Copy constructor. More...
|
|
virtual bool | getBoolValue (std::string key) const |
| Returns the value of the given option as a Boolean. More...
|
|
virtual std::string | getDescription (std::string key) const |
| Returns the description string for a given option in this properties object. More...
|
|
virtual double | getDoubleValue (std::string key) const |
| Returns the value of the given option as a double . More...
|
|
virtual float | getFloatValue (std::string key) const |
| Returns the value of the given option as a float . More...
|
|
virtual int | getIntValue (std::string key) const |
| Returns the value of the given option as an integer. More...
|
|
virtual ConversionOption * | getOption (std::string key) const |
| Returns the ConversionOption object for a given key. More...
|
|
virtual SBMLNamespaces * | getTargetNamespaces () const |
| Returns the current target SBML namespace. More...
|
|
virtual ConversionOptionType_t | getType (std::string key) const |
| Returns the type of a given option in this properties object. More...
|
|
virtual std::string | getValue (std::string key) const |
| Returns the value of the given option as a string. More...
|
|
virtual bool | hasOption (std::string key) const |
| Returns true if this properties object contains an option with the given key. More...
|
|
virtual bool | hasTargetNamespaces () const |
| Returns true if the target SBML namespace has been set. More...
|
|
ConversionProperties & | operator= (const ConversionProperties &rhs) |
| Assignment operator for conversion properties. More...
|
|
virtual ConversionOption * | removeOption (std::string key) |
| Removes the option with the given key from this properties object. More...
|
|
virtual void | setBoolValue (std::string key, bool value) |
| Sets the value of the given option to a Boolean. More...
|
|
virtual void | setDoubleValue (std::string key, double value) |
| Sets the value of the given option to a double . More...
|
|
virtual void | setFloatValue (std::string key, float value) |
| Sets the value of the given option to a float . More...
|
|
virtual void | setIntValue (std::string key, int value) |
| Sets the value of the given option to an integer. More...
|
|
virtual void | setTargetNamespaces (SBMLNamespaces *targetNS) |
| Sets the target namespace. More...
|
|
virtual void | setValue (std::string key, std::string value) |
| Sets the value of the given option to a string. More...
|
|
virtual | ~ConversionProperties () |
| Destructor. More...
|
|