libSBML C++ API
libSBML 5.8.0 C++ API
|
Implemenentation of ConversionProperties, the class encapsulating conversion configuration.
Functions | |
void | ConversionProperties_addOption (ConversionProperties_t *cp, const ConversionOption_t *option) |
Adds a copy of the given ConversionOption structure to the properties. More... | |
void | ConversionProperties_addOptionWithKey (ConversionProperties_t *cp, const char *key) |
Adds a new ConversionOption structure with the given key to the properties. More... | |
ConversionProperties_t * | ConversionProperties_clone (const ConversionProperties_t *cp) |
Creates and returns a deep copy of the given ConversionProperties object. More... | |
ConversionProperties_t * | ConversionProperties_create () |
creates a new conversion properties structure (without namespace) More... | |
ConversionProperties_t * | ConversionProperties_createWithSBMLNamespace (SBMLNamespaces_t *sbmlns) |
creates a new conversion properties structure with a specific SBML target namespace. More... | |
int | ConversionProperties_getBoolValue (const ConversionProperties_t *cp, const char *key) |
Returns the value as boolean for a given option in the properties object. More... | |
char * | ConversionProperties_getDescription (const ConversionProperties_t *cp, const char *key) |
Returns the description string for a given option in the properties object. More... | |
double | ConversionProperties_getDoubleValue (const ConversionProperties_t *cp, const char *key) |
Returns the value as double for a given option in the properties object. More... | |
float | ConversionProperties_getFloatValue (const ConversionProperties_t *cp, const char *key) |
Returns the value as float for a given option in the properties object. More... | |
int | ConversionProperties_getIntValue (const ConversionProperties_t *cp, const char *key) |
Returns the value as integer for a given option in the properties object. More... | |
const ConversionOption_t * | ConversionProperties_getOption (const ConversionProperties_t *cp, const char *key) |
Returns the ConversionOption object for a given key. More... | |
const SBMLNamespaces_t * | ConversionProperties_getTargetNamespaces (const ConversionProperties_t *cp) |
Returns the current target SBML namespace of the conversion properties. More... | |
ConversionOptionType_t | ConversionProperties_getType (const ConversionProperties_t *cp, const char *key) |
Returns the type of a given option in the properties object. More... | |
char * | ConversionProperties_getValue (const ConversionProperties_t *cp, const char *key) |
Returns the value string for a given option in the properties object. More... | |
int | ConversionProperties_hasOption (const ConversionProperties_t *cp, const char *key) |
Checks whether the given properties structure has an option for the given key. More... | |
int | ConversionProperties_hasTargetNamespaces (const ConversionProperties_t *cp) |
Tests whether the given conversion properties has a target namespace set. More... | |
void | ConversionProperties_removeOption (ConversionProperties_t *cp, const char *key) |
Removes the ConversionOption with the given key from the properties. More... | |
void | ConversionProperties_setBoolValue (ConversionProperties_t *cp, const char *key, int value) |
Sets the value of the option with given key to the given boolean value. More... | |
void | ConversionProperties_setDoubleValue (ConversionProperties_t *cp, const char *key, double value) |
Sets the value of the option with given key to the given double value. More... | |
void | ConversionProperties_setFloatValue (ConversionProperties_t *cp, const char *key, float value) |
Sets the value of the option with given key to the given float value. More... | |
void | ConversionProperties_setIntValue (ConversionProperties_t *cp, const char *key, int value) |
Sets the value of the option with given key to the given int value. More... | |
void | ConversionProperties_setTargetNamespaces (ConversionProperties_t *cp, SBMLNamespaces_t *sbmlns) |
Sets the target namespace. More... | |
void | ConversionProperties_setValue (ConversionProperties_t *cp, const char *key, const char *value) |
Sets the value of the option with given key to the given value. More... | |
void ConversionProperties_addOption | ( | ConversionProperties_t * | cp, |
const ConversionOption_t * | option | ||
) |
Adds a copy of the given ConversionOption structure to the properties.
cp | the conversion properties |
option | the option to add |
void ConversionProperties_addOptionWithKey | ( | ConversionProperties_t * | cp, |
const char * | key | ||
) |
Adds a new ConversionOption structure with the given key to the properties.
cp | the conversion properties |
key | the key for the new option |
ConversionProperties_t* ConversionProperties_clone | ( | const ConversionProperties_t * | cp | ) |
Creates and returns a deep copy of the given ConversionProperties object.
cp | the conversion properties to clone |
ConversionProperties_t* ConversionProperties_create | ( | ) |
creates a new conversion properties structure (without namespace)
ConversionProperties_t* ConversionProperties_createWithSBMLNamespace | ( | SBMLNamespaces_t * | sbmlns | ) |
creates a new conversion properties structure with a specific SBML target namespace.
sbmlns | the target namespace to convert to |
int ConversionProperties_getBoolValue | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Returns the value as boolean for a given option in the properties object.
cp | the conversion properties |
key | the key for the option. |
char* ConversionProperties_getDescription | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Returns the description string for a given option in the properties object.
cp | the conversion properties |
key | the key for the option. |
double ConversionProperties_getDoubleValue | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Returns the value as double for a given option in the properties object.
cp | the conversion properties |
key | the key for the option. |
float ConversionProperties_getFloatValue | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Returns the value as float for a given option in the properties object.
cp | the conversion properties |
key | the key for the option. |
int ConversionProperties_getIntValue | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Returns the value as integer for a given option in the properties object.
cp | the conversion properties |
key | the key for the option. |
const ConversionOption_t* ConversionProperties_getOption | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Returns the ConversionOption object for a given key.
cp | the conversion properties |
key | the key for the option. |
const SBMLNamespaces_t* ConversionProperties_getTargetNamespaces | ( | const ConversionProperties_t * | cp | ) |
Returns the current target SBML namespace of the conversion properties.
cp | the conversion properties |
ConversionOptionType_t ConversionProperties_getType | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Returns the type of a given option in the properties object.
cp | the conversion properties |
key | the key for the option. |
char* ConversionProperties_getValue | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Returns the value string for a given option in the properties object.
cp | the conversion properties |
key | the key for the option. |
int ConversionProperties_hasOption | ( | const ConversionProperties_t * | cp, |
const char * | key | ||
) |
Checks whether the given properties structure has an option for the given key.
cp | the conversion properties |
key | the key for the option. |
1
if the option exists, 0
otherwise. int ConversionProperties_hasTargetNamespaces | ( | const ConversionProperties_t * | cp | ) |
Tests whether the given conversion properties has a target namespace set.
cp | the conversion properties |
1
if the target namespace has been set, 0
otherwise. void ConversionProperties_removeOption | ( | ConversionProperties_t * | cp, |
const char * | key | ||
) |
Removes the ConversionOption with the given key from the properties.
cp | the conversion properties |
key | the key for the option to remove |
void ConversionProperties_setBoolValue | ( | ConversionProperties_t * | cp, |
const char * | key, | ||
int | value | ||
) |
Sets the value of the option with given key to the given boolean value.
cp | the conversion properties |
key | the key for the option. |
value | the new value for the option. |
void ConversionProperties_setDoubleValue | ( | ConversionProperties_t * | cp, |
const char * | key, | ||
double | value | ||
) |
Sets the value of the option with given key to the given double value.
cp | the conversion properties |
key | the key for the option. |
value | the new value for the option. |
void ConversionProperties_setFloatValue | ( | ConversionProperties_t * | cp, |
const char * | key, | ||
float | value | ||
) |
Sets the value of the option with given key to the given float value.
cp | the conversion properties |
key | the key for the option. |
value | the new value for the option. |
void ConversionProperties_setIntValue | ( | ConversionProperties_t * | cp, |
const char * | key, | ||
int | value | ||
) |
Sets the value of the option with given key to the given int value.
cp | the conversion properties |
key | the key for the option. |
value | the new value for the option. |
void ConversionProperties_setTargetNamespaces | ( | ConversionProperties_t * | cp, |
SBMLNamespaces_t * | sbmlns | ||
) |
Sets the target namespace.
cp | the conversion properties |
sbmlns | the target namespace to use. |
void ConversionProperties_setValue | ( | ConversionProperties_t * | cp, |
const char * | key, | ||
const char * | value | ||
) |
Sets the value of the option with given key to the given value.
cp | the conversion properties |
key | the key for the option. |
value | the new value for the option. |