libSBML C# API
libSBML 5.8.0 C# API
|
Class of object that encapsulates a conversion option.
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.
LibSBML provides a number of converters that can perform transformations on SBML documents. These converters allow their behaviors to be controlled by setting property values. Converter properties are communicated using objects of class ConversionProperties, and within such objects, individual options are encapsulated using ConversionOption objects.
A ConversionOption object consists of four parts:
There are no constraints on the values of keys or descriptions; authors of SBML converters are free to choose them as they see fit.
An option in ConversionOption must have a data type declared, to indicate whether it is a string value, an integer, and so forth. The possible types of values are taken from the enumeration ConversionOptionType_t. The following are the possible values:
Enumerator | Meaning |
CNV_TYPE_BOOL | Indicates the value type is a Boolean. |
CNV_TYPE_DOUBLE | Indicates the value type is a double-sized float. |
CNV_TYPE_INT | Indicates the value type is an integer. |
CNV_TYPE_SINGLE | Indicates the value type is a float. |
CNV_TYPE_STRING | Indicates the value type is a string. |
Public Member Functions | |
ConversionOption | clone () |
Creates and returns a deep copy of this ConversionOption object. More... | |
ConversionOption (string key, string value, int type, string description) | |
Creates a new ConversionOption. More... | |
ConversionOption (string key, string value, int type) | |
Creates a new ConversionOption. More... | |
ConversionOption (string key, string value) | |
Creates a new ConversionOption. More... | |
ConversionOption (string key) | |
Creates a new ConversionOption. More... | |
ConversionOption (string key, string value, string description) | |
Creates a new ConversionOption specialized for string-type options. More... | |
ConversionOption (string key, bool value, string description) | |
Creates a new ConversionOption specialized for Boolean-type options. More... | |
ConversionOption (string key, bool value) | |
Creates a new ConversionOption specialized for Boolean-type options. More... | |
ConversionOption (string key, double value, string description) | |
Creates a new ConversionOption specialized for double-type options. More... | |
ConversionOption (string key, double value) | |
Creates a new ConversionOption specialized for double-type options. More... | |
ConversionOption (string key, float value, string description) | |
Creates a new ConversionOption specialized for float-type options. More... | |
ConversionOption (string key, float value) | |
Creates a new ConversionOption specialized for float-type options. More... | |
ConversionOption (string key, int value, string description) | |
Creates a new ConversionOption specialized for integer-type options. More... | |
ConversionOption (string key, int value) | |
Creates a new ConversionOption specialized for integer-type options. More... | |
ConversionOption (ConversionOption orig) | |
Copy constructor; creates a copy of an ConversionOption object. More... | |
virtual void | Dispose () |
bool | getBoolValue () |
Returns the value of this option as a Boolean. More... | |
string | getDescription () |
Returns the description string for this option. More... | |
double | getDoubleValue () |
Returns the value of this option as a double . More... | |
float | getFloatValue () |
Returns the value of this option as a float . More... | |
int | getIntValue () |
Returns the value of this option as an integer . More... | |
string | getKey () |
Returns the key for this option. More... | |
int | getType () |
Returns the type of this option. More... | |
string | getValue () |
Returns the value of this option. More... | |
void | setBoolValue (bool value) |
Set the value of this option to a given Boolean value. More... | |
void | setDescription (string description) |
Sets the description text for this option. More... | |
void | setDoubleValue (double value) |
Set the value of this option to a given double value. More... | |
void | setFloatValue (float value) |
Set the value of this option to a given float value. More... | |
void | setIntValue (int value) |
Set the value of this option to a given int value. More... | |
void | setKey (string key) |
Sets the key for this option. More... | |
void | setType (int type) |
Sets the type of this option. More... | |
void | setValue (string value) |
Sets the value for this option. More... | |
Protected Attributes | |
bool | swigCMemOwn |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
string | value, | ||
int | type, | ||
string | description | ||
) |
Creates a new ConversionOption.
This is the general constructor, taking arguments for all aspects of an option. Other constructors exist with different arguments.
key | the key for this option |
value | an optional value for this option |
type | the type of this option |
description | the description for this option |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
string | value, | ||
int | type | ||
) |
Creates a new ConversionOption.
This is the general constructor, taking arguments for all aspects of an option. Other constructors exist with different arguments.
key | the key for this option |
value | an optional value for this option |
type | the type of this option |
description | the description for this option |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
string | value | ||
) |
Creates a new ConversionOption.
This is the general constructor, taking arguments for all aspects of an option. Other constructors exist with different arguments.
key | the key for this option |
value | an optional value for this option |
type | the type of this option |
description | the description for this option |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key | ) |
Creates a new ConversionOption.
This is the general constructor, taking arguments for all aspects of an option. Other constructors exist with different arguments.
key | the key for this option |
value | an optional value for this option |
type | the type of this option |
description | the description for this option |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
string | value, | ||
string | description | ||
) |
Creates a new ConversionOption specialized for string-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
bool | value, | ||
string | description | ||
) |
Creates a new ConversionOption specialized for Boolean-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
bool | value | ||
) |
Creates a new ConversionOption specialized for Boolean-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
double | value, | ||
string | description | ||
) |
Creates a new ConversionOption specialized for double-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
double | value | ||
) |
Creates a new ConversionOption specialized for double-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
float | value, | ||
string | description | ||
) |
Creates a new ConversionOption specialized for float-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
float | value | ||
) |
Creates a new ConversionOption specialized for float-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
int | value, | ||
string | description | ||
) |
Creates a new ConversionOption specialized for integer-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | string | key, |
int | value | ||
) |
Creates a new ConversionOption specialized for integer-type options.
key | the key for this option |
value | the value for this option |
description | an optional description |
libsbmlcs.ConversionOption.ConversionOption | ( | ConversionOption | orig | ) |
Copy constructor; creates a copy of an ConversionOption object.
orig | the ConversionOption object to copy. |
SBMLConstructorException | Thrown if the argument orig is null . |
ConversionOption libsbmlcs.ConversionOption.clone | ( | ) |
Creates and returns a deep copy of this ConversionOption object.
|
virtual |
bool libsbmlcs.ConversionOption.getBoolValue | ( | ) |
Returns the value of this option as a Boolean.
string libsbmlcs.ConversionOption.getDescription | ( | ) |
Returns the description string for this option.
double libsbmlcs.ConversionOption.getDoubleValue | ( | ) |
Returns the value of this option as a double
.
float libsbmlcs.ConversionOption.getFloatValue | ( | ) |
Returns the value of this option as a float
.
int libsbmlcs.ConversionOption.getIntValue | ( | ) |
Returns the value of this option as an integer
.
string libsbmlcs.ConversionOption.getKey | ( | ) |
Returns the key for this option.
int libsbmlcs.ConversionOption.getType | ( | ) |
Returns the type of this option.
string libsbmlcs.ConversionOption.getValue | ( | ) |
Returns the value of this option.
void libsbmlcs.ConversionOption.setBoolValue | ( | bool | value | ) |
Set the value of this option to a given Boolean value.
Invoking this method will also set the type of the option to CNV_TYPE_BOOL.
value | the Boolean value to set |
void libsbmlcs.ConversionOption.setDescription | ( | string | description | ) |
Sets the description text for this option.
description | the description to set for this option. |
void libsbmlcs.ConversionOption.setDoubleValue | ( | double | value | ) |
Set the value of this option to a given double
value.
Invoking this method will also set the type of the option to CNV_TYPE_DOUBLE.
value | the value to set |
void libsbmlcs.ConversionOption.setFloatValue | ( | float | value | ) |
Set the value of this option to a given float
value.
Invoking this method will also set the type of the option to CNV_TYPE_SINGLE.
value | the value to set |
void libsbmlcs.ConversionOption.setIntValue | ( | int | value | ) |
Set the value of this option to a given int
value.
Invoking this method will also set the type of the option to CNV_TYPE_INT.
value | the value to set |
void libsbmlcs.ConversionOption.setKey | ( | string | key | ) |
Sets the key for this option.
key | a string representing the key to set. |
void libsbmlcs.ConversionOption.setType | ( | int | type | ) |
Sets the type of this option.
type | the type value to use. |
void libsbmlcs.ConversionOption.setValue | ( | string | value | ) |
Sets the value for this option.
value | the value to set, as a string. |
|
protected |