libSBML C# API
libSBML 5.8.0 C# API
|
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.
Public Member Functions | |
void | addOption (ConversionOption option) |
Adds a copy of the given option to this properties object. More... | |
void | addOption (string key, string value, int type, string description) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, string value, int type) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, string value) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, string value, string description) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, bool value, string description) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, bool value) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, double value, string description) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, double value) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, float value, string description) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, float value) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, int value, string description) |
Adds a new ConversionOption object with the given parameters. More... | |
void | addOption (string key, int value) |
Adds a new ConversionOption object with the given parameters. More... | |
ConversionProperties | clone () |
Creates and returns a deep copy of this ConversionProperties object. More... | |
ConversionProperties (SBMLNamespaces targetNS) | |
Constructor that initializes the conversion properties with a specific SBML target namespace. More... | |
ConversionProperties () | |
Constructor that initializes the conversion properties with a specific SBML target namespace. More... | |
ConversionProperties (ConversionProperties orig) | |
Copy constructor. More... | |
virtual void | Dispose () |
bool | getBoolValue (string key) |
Returns the value of the given option as a Boolean. More... | |
string | getDescription (string key) |
Returns the description string for a given option in this properties object. More... | |
double | getDoubleValue (string key) |
Returns the value of the given option as a double . More... | |
float | getFloatValue (string key) |
Returns the value of the given option as a float . More... | |
int | getIntValue (string key) |
Returns the value of the given option as an integer. More... | |
ConversionOption | getOption (string key) |
Returns the ConversionOption object for a given key. More... | |
SBMLNamespaces | getTargetNamespaces () |
Returns the current target SBML namespace. More... | |
int | getType (string key) |
Returns the type of a given option in this properties object. More... | |
string | getValue (string key) |
Returns the value of the given option as a string. More... | |
bool | hasOption (string key) |
Returns true if this properties object contains an option with the given key. More... | |
bool | hasTargetNamespaces () |
Returns true if the target SBML namespace has been set. More... | |
ConversionOption | removeOption (string key) |
Removes the option with the given key from this properties object. More... | |
void | setBoolValue (string key, bool value) |
Sets the value of the given option to a Boolean. More... | |
void | setDoubleValue (string key, double value) |
Sets the value of the given option to a double . More... | |
void | setFloatValue (string key, float value) |
Sets the value of the given option to a float . More... | |
void | setIntValue (string key, int value) |
Sets the value of the given option to an integer. More... | |
void | setTargetNamespaces (SBMLNamespaces targetNS) |
Sets the target namespace. More... | |
void | setValue (string key, string value) |
Sets the value of the given option to a string. More... | |
Protected Attributes | |
bool | swigCMemOwn |
libsbmlcs.ConversionProperties.ConversionProperties | ( | SBMLNamespaces | targetNS | ) |
Constructor that initializes the conversion properties with a specific SBML target namespace.
targetNS | the target namespace to convert to |
libsbmlcs.ConversionProperties.ConversionProperties | ( | ) |
Constructor that initializes the conversion properties with a specific SBML target namespace.
targetNS | the target namespace to convert to |
libsbmlcs.ConversionProperties.ConversionProperties | ( | ConversionProperties | orig | ) |
Copy constructor.
orig | the object to copy. |
SBMLConstructorException | Thrown if the argument orig is null . |
void libsbmlcs.ConversionProperties.addOption | ( | ConversionOption | option | ) |
Adds a copy of the given option to this properties object.
option | the option to add |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
string | value, | ||
int | type, | ||
string | description | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | (optional) the value of that option |
type | (optional) the type of the option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
string | value, | ||
int | type | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | (optional) the value of that option |
type | (optional) the type of the option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
string | value | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | (optional) the value of that option |
type | (optional) the type of the option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key | ) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | (optional) the value of that option |
type | (optional) the type of the option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
string | value, | ||
string | description | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the string value of that option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
bool | value, | ||
string | description | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the bool value of that option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
bool | value | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the bool value of that option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
double | value, | ||
string | description | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the double value of that option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
double | value | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the double value of that option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
float | value, | ||
string | description | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the float value of that option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
float | value | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the float value of that option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
int | value, | ||
string | description | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the integer value of that option |
description | (optional) the description for the option |
void libsbmlcs.ConversionProperties.addOption | ( | string | key, |
int | value | ||
) |
Adds a new ConversionOption object with the given parameters.
key | the key for the new option |
value | the integer value of that option |
description | (optional) the description for the option |
ConversionProperties libsbmlcs.ConversionProperties.clone | ( | ) |
Creates and returns a deep copy of this ConversionProperties object.
|
virtual |
bool libsbmlcs.ConversionProperties.getBoolValue | ( | string | key | ) |
Returns the value of the given option as a Boolean.
key | the key for the option. |
string libsbmlcs.ConversionProperties.getDescription | ( | string | key | ) |
Returns the description string for a given option in this properties object.
key | the key for the option. |
double libsbmlcs.ConversionProperties.getDoubleValue | ( | string | key | ) |
Returns the value of the given option as a double
.
key | the key for the option. |
float libsbmlcs.ConversionProperties.getFloatValue | ( | string | key | ) |
Returns the value of the given option as a float
.
key | the key for the option. |
int libsbmlcs.ConversionProperties.getIntValue | ( | string | key | ) |
Returns the value of the given option as an integer.
key | the key for the option. |
ConversionOption libsbmlcs.ConversionProperties.getOption | ( | string | key | ) |
Returns the ConversionOption object for a given key.
key | the key for the option. |
SBMLNamespaces libsbmlcs.ConversionProperties.getTargetNamespaces | ( | ) |
Returns the current target SBML namespace.
int libsbmlcs.ConversionProperties.getType | ( | string | key | ) |
Returns the type of a given option in this properties object.
key | the key for the option. |
string libsbmlcs.ConversionProperties.getValue | ( | string | key | ) |
Returns the value of the given option as a string.
key | the key for the option. |
bool libsbmlcs.ConversionProperties.hasOption | ( | string | key | ) |
Returns true
if this properties object contains an option with the given key.
key | the key of the option to find. |
true
if an option with the given key
exists in this properties object, false
otherwise. bool libsbmlcs.ConversionProperties.hasTargetNamespaces | ( | ) |
Returns true
if the target SBML namespace has been set.
true
if the target namespace has been set, false
otherwise. ConversionOption libsbmlcs.ConversionProperties.removeOption | ( | string | key | ) |
Removes the option with the given key from this properties object.
key | the key for the new option to remove |
void libsbmlcs.ConversionProperties.setBoolValue | ( | string | key, |
bool | value | ||
) |
Sets the value of the given option to a Boolean.
key | the key for the option. |
value | the new Boolean value. |
void libsbmlcs.ConversionProperties.setDoubleValue | ( | string | key, |
double | value | ||
) |
Sets the value of the given option to a double
.
key | the key for the option. |
value | the new double value. |
void libsbmlcs.ConversionProperties.setFloatValue | ( | string | key, |
float | value | ||
) |
Sets the value of the given option to a float
.
key | the key for the option. |
value | the new float value. |
void libsbmlcs.ConversionProperties.setIntValue | ( | string | key, |
int | value | ||
) |
Sets the value of the given option to an integer.
key | the key for the option. |
value | the new integer value. |
void libsbmlcs.ConversionProperties.setTargetNamespaces | ( | SBMLNamespaces | targetNS | ) |
Sets the target namespace.
targetNS | the target namespace to use. |
void libsbmlcs.ConversionProperties.setValue | ( | string | key, |
string | value | ||
) |
Sets the value of the given option to a string.
key | the key for the option |
value | the new value |
|
protected |