libSBML Perl API  libSBML 5.8.0 Perl API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ConversionOption.cpp File Reference

Detailed Description

Implementation of ConversionOption, the class encapsulating conversion options.

Author
Frank Bergmann
Include dependency graph for ConversionOption.cpp:

Functions

ConversionOption_tConversionOption_clone (const ConversionOption_t *co)
 Creates and returns a deep copy of the ConversionOption object. More...
 
ConversionOption_tConversionOption_create (const char *key)
 Creates a new ConversionOption_t with the given key. More...
 
ConversionOption_tConversionOption_createWithKeyAndType (const char *key, ConversionOptionType_t type)
 Creates a new ConversionOption_t with given key and type. More...
 
int ConversionOption_getBoolValue (const ConversionOption_t *co)
 Returns the value (as boolean) for the given option. More...
 
const char * ConversionOption_getDescription (const ConversionOption_t *co)
 Returns the description for the given option. More...
 
double ConversionOption_getDoubleValue (const ConversionOption_t *co)
 Returns the value (as double) for the given option. More...
 
float ConversionOption_getFloatValue (const ConversionOption_t *co)
 Returns the value (as float) for the given option. More...
 
int ConversionOption_getIntValue (const ConversionOption_t *co)
 Returns the value (as integer) for the given option. More...
 
const char * ConversionOption_getKey (const ConversionOption_t *co)
 Returns the key for the given option. More...
 
ConversionOptionType_t ConversionOption_getType (const ConversionOption_t *co)
 Returns the type for the given option. More...
 
const char * ConversionOption_getValue (const ConversionOption_t *co)
 Returns the value for the given option. More...
 
void ConversionOption_setBoolValue (ConversionOption_t *co, int value)
 Sets the value for the option. More...
 
void ConversionOption_setDescription (ConversionOption_t *co, const char *description)
 Sets the description for the option. More...
 
void ConversionOption_setDoubleValue (ConversionOption_t *co, double value)
 Sets the value for the option. More...
 
void ConversionOption_setFloatValue (ConversionOption_t *co, float value)
 Sets the value for the option. More...
 
void ConversionOption_setIntValue (ConversionOption_t *co, int value)
 Sets the value for the option. More...
 
void ConversionOption_setKey (ConversionOption_t *co, const char *key)
 Sets the key for the option. More...
 
void ConversionOption_setType (ConversionOption_t *co, ConversionOptionType_t type)
 Sets the type for the option. More...
 
void ConversionOption_setValue (ConversionOption_t *co, const char *value)
 Sets the value for the option. More...
 

Function Documentation

ConversionOption_t* ConversionOption_clone ( const ConversionOption_t co)

Creates and returns a deep copy of the ConversionOption object.

Parameters
cothe conversion option to clone
Returns
a (deep) copy of the ConversionOption object.
ConversionOption_t* ConversionOption_create ( const char *  key)

Creates a new ConversionOption_t with the given key.

Parameters
keythe key for this option
ConversionOption_t* ConversionOption_createWithKeyAndType ( const char *  key,
ConversionOptionType_t  type 
)

Creates a new ConversionOption_t with given key and type.

Parameters
keythe key for this option
typethe type of this option
int ConversionOption_getBoolValue ( const ConversionOption_t co)

Returns the value (as boolean) for the given option.

Parameters
cothe conversion option
Returns
the value, as a boolean.
const char* ConversionOption_getDescription ( const ConversionOption_t co)

Returns the description for the given option.

Parameters
cothe conversion option
Returns
the description, as a string.
double ConversionOption_getDoubleValue ( const ConversionOption_t co)

Returns the value (as double) for the given option.

Parameters
cothe conversion option
Returns
the value, as a double.
float ConversionOption_getFloatValue ( const ConversionOption_t co)

Returns the value (as float) for the given option.

Parameters
cothe conversion option
Returns
the value, as a float.
int ConversionOption_getIntValue ( const ConversionOption_t co)

Returns the value (as integer) for the given option.

Parameters
cothe conversion option
Returns
the value, as a integer.
const char* ConversionOption_getKey ( const ConversionOption_t co)

Returns the key for the given option.

Parameters
cothe conversion option
Returns
the key, as a string.
ConversionOptionType_t ConversionOption_getType ( const ConversionOption_t co)

Returns the type for the given option.

Parameters
cothe conversion option
Returns
the type
const char* ConversionOption_getValue ( const ConversionOption_t co)

Returns the value for the given option.

Parameters
cothe conversion option
Returns
the value, as a string.
void ConversionOption_setBoolValue ( ConversionOption_t co,
int  value 
)

Sets the value for the option.

Parameters
cothe conversion option
valuea bool representing the value to set.
void ConversionOption_setDescription ( ConversionOption_t co,
const char *  description 
)

Sets the description for the option.

Parameters
cothe conversion option
descriptiona string representing the description to set.
void ConversionOption_setDoubleValue ( ConversionOption_t co,
double  value 
)

Sets the value for the option.

Parameters
cothe conversion option
valuea double representing the value to set.
void ConversionOption_setFloatValue ( ConversionOption_t co,
float  value 
)

Sets the value for the option.

Parameters
cothe conversion option
valuea float representing the value to set.
void ConversionOption_setIntValue ( ConversionOption_t co,
int  value 
)

Sets the value for the option.

Parameters
cothe conversion option
valuean integer representing the value to set.
void ConversionOption_setKey ( ConversionOption_t co,
const char *  key 
)

Sets the key for the option.

Parameters
cothe conversion option
keya string representing the key to set.
void ConversionOption_setType ( ConversionOption_t co,
ConversionOptionType_t  type 
)

Sets the type for the option.

Parameters
cothe conversion option
typethe type for this option.
void ConversionOption_setValue ( ConversionOption_t co,
const char *  value 
)

Sets the value for the option.

Parameters
cothe conversion option
valuea string representing the value to set.