libSBML C# API  libSBML 5.8.0 C# API
 All Classes Namespaces Files Functions Variables Properties Pages
libsbmlcs.ConversionProperties Class Reference
Inheritance diagram for libsbmlcs.ConversionProperties:
[legend]

Detailed Description

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

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
 

Constructor & Destructor Documentation

libsbmlcs.ConversionProperties.ConversionProperties ( SBMLNamespaces  targetNS)

Constructor that initializes the conversion properties with a specific SBML target namespace.

Parameters
targetNSthe target namespace to convert to
libsbmlcs.ConversionProperties.ConversionProperties ( )

Constructor that initializes the conversion properties with a specific SBML target namespace.

Parameters
targetNSthe target namespace to convert to
libsbmlcs.ConversionProperties.ConversionProperties ( ConversionProperties  orig)

Copy constructor.

Parameters
origthe object to copy.
Exceptions
SBMLConstructorExceptionThrown if the argument orig is null.

Member Function Documentation

void libsbmlcs.ConversionProperties.addOption ( ConversionOption  option)

Adds a copy of the given option to this properties object.

Parameters
optionthe option to add
void libsbmlcs.ConversionProperties.addOption ( string  key,
string  value,
int  type,
string  description 
)

Adds a new ConversionOption object with the given parameters.

Parameters
keythe 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.

Parameters
keythe 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.

Parameters
keythe 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.

Parameters
keythe 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.

Parameters
keythe key for the new option
valuethe 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.

Parameters
keythe key for the new option
valuethe 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.

Parameters
keythe key for the new option
valuethe 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.

Parameters
keythe key for the new option
valuethe 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.

Parameters
keythe key for the new option
valuethe 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.

Parameters
keythe key for the new option
valuethe 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.

Parameters
keythe key for the new option
valuethe 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.

Parameters
keythe key for the new option
valuethe 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.

Parameters
keythe key for the new option
valuethe 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.

Returns
a (deep) copy of this ConversionProperties object.
virtual void libsbmlcs.ConversionProperties.Dispose ( )
virtual
bool libsbmlcs.ConversionProperties.getBoolValue ( string  key)

Returns the value of the given option as a Boolean.

Parameters
keythe key for the option.
Returns
the bool value of the option with the given key.
string libsbmlcs.ConversionProperties.getDescription ( string  key)

Returns the description string for a given option in this properties object.

Parameters
keythe key for the option.
Returns
the description text of the option with the given key.
double libsbmlcs.ConversionProperties.getDoubleValue ( string  key)

Returns the value of the given option as a double.

Parameters
keythe key for the option.
Returns
the double value of the option with the given key.
float libsbmlcs.ConversionProperties.getFloatValue ( string  key)

Returns the value of the given option as a float.

Parameters
keythe key for the option.
Returns
the float value of the option with the given key.
int libsbmlcs.ConversionProperties.getIntValue ( string  key)

Returns the value of the given option as an integer.

Parameters
keythe key for the option.
Returns
the int value of the option with the given key.
ConversionOption libsbmlcs.ConversionProperties.getOption ( string  key)

Returns the ConversionOption object for a given key.

Parameters
keythe key for the option.
Returns
the option with the given key.
SBMLNamespaces libsbmlcs.ConversionProperties.getTargetNamespaces ( )

Returns the current target SBML namespace.

Returns
the SBMLNamepaces object expressing the target namespace.
int libsbmlcs.ConversionProperties.getType ( string  key)

Returns the type of a given option in this properties object.

Parameters
keythe key for the option.
Returns
the type of the option with the given key.
string libsbmlcs.ConversionProperties.getValue ( string  key)

Returns the value of the given option as a string.

Parameters
keythe key for the option.
Returns
the string value of the option with the given key.
bool libsbmlcs.ConversionProperties.hasOption ( string  key)

Returns true if this properties object contains an option with the given key.

Parameters
keythe key of the option to find.
Returns
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.

Returns
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.

Parameters
keythe key for the new option to remove
Returns
the removed option
void libsbmlcs.ConversionProperties.setBoolValue ( string  key,
bool  value 
)

Sets the value of the given option to a Boolean.

Parameters
keythe key for the option.
valuethe new Boolean value.
void libsbmlcs.ConversionProperties.setDoubleValue ( string  key,
double  value 
)

Sets the value of the given option to a double.

Parameters
keythe key for the option.
valuethe new double value.
void libsbmlcs.ConversionProperties.setFloatValue ( string  key,
float  value 
)

Sets the value of the given option to a float.

Parameters
keythe key for the option.
valuethe new float value.
void libsbmlcs.ConversionProperties.setIntValue ( string  key,
int  value 
)

Sets the value of the given option to an integer.

Parameters
keythe key for the option.
valuethe new integer value.
void libsbmlcs.ConversionProperties.setTargetNamespaces ( SBMLNamespaces  targetNS)

Sets the target namespace.

Parameters
targetNSthe target namespace to use.
void libsbmlcs.ConversionProperties.setValue ( string  key,
string  value 
)

Sets the value of the given option to a string.

Parameters
keythe key for the option
valuethe new value

Member Data Documentation

bool libsbmlcs.ConversionProperties.swigCMemOwn
protected