libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
Objective.cpp File Reference

Implementation of the Objective_t class. More...

Include dependency graph for Objective.cpp:

Functions

Objective_tListOfObjectives_getById (ListOf_t *lo, const char *sid)
 _tReturn_t _tthe_t _tstructure_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.
 
Objective_tListOfObjectives_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _tthe_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int Objective_addFluxObjective (Objective_t *o, FluxObjective_t *fo)
 
Objective_tObjective_clone (Objective_t *o)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
Objective_tObjective_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tObjective_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t, _tand_t _tthe_t @_tp_t _tpkgVersion_t _tpackage_t _tversion_t.
 
FluxObjective_tObjective_createFluxObjective (Objective_t *o)
 
void Objective_free (Objective_t *o)
 _tFrees_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
FluxObjective_tObjective_getFluxObjective (Objective_t *o, unsigned int n)
 
FluxObjective_tObjective_getFluxObjectiveById (Objective_t *o, const char *sid)
 
const char * Objective_getId (const Objective_t *o)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
ListOf_tObjective_getListOfFluxObjectives (Objective_t *o)
 
const char * Objective_getName (const Objective_t *o)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
unsigned int Objective_getNumFluxObjectives (Objective_t *o)
 
const char * Objective_getType (Objective_t *obj)
 _tTakes_t _ta_t _tObjective_t_t _tstructure_t _tand_t _treturns_t _tits_t _ttype_t.
 
int Objective_hasRequiredAttributes (const Objective_t *o)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Objective_hasRequiredElements (const Objective_t *o)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tsub_t-_telements_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Objective_isSetId (const Objective_t *o)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t'_ts_t "_tid_t" _tis_t _tset_t.
 
int Objective_isSetName (const Objective_t *o)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t.
 
int Objective_isSetType (const Objective_t *o)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t'_ts_t "_ttype_t" _tis_t _tset_t.
 
FluxObjective_tObjective_removeFluxObjective (Objective_t *o, unsigned int n)
 
FluxObjective_tObjective_removeFluxObjectiveById (Objective_t *o, const char *sid)
 
int Objective_setId (Objective_t *o, const char *id)
 _tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
int Objective_setName (Objective_t *o, const char *name)
 _tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
int Objective_setType (Objective_t *o, const char *type)
 _tSets_t _tthe_t "_ttype_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
int Objective_unsetId (Objective_t *o)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
int Objective_unsetName (Objective_t *o)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
int Objective_unsetType (Objective_t *o)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_ttype_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.
 
ObjectiveType_t ObjectiveType_fromString (const char *s)
 _tReturns_t _tthe_t _tObjectiveType_t_t _tenumeration_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t, _tor_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_UNKNOWN_t, _tObjectiveType_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.
 
int ObjectiveType_isValidObjectiveType (ObjectiveType_t effect)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tObjectiveType_t_t _tis_t _tvalid_t.
 
int ObjectiveType_isValidObjectiveTypeString (const char *s)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tstring_t _tis_t _ta_t _tvalid_t _tObjectiveType_t_t.
 
const char * ObjectiveType_toString (ObjectiveType_t type)
 _tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t _tObjectiveType_t_t _tenumeration_t.
 

Variables

static const char * OBJECTIVE_TYPE_STRINGS []
 

Detailed Description

Implementation of the Objective_t class.

Author
SBMLTeam

Function Documentation

◆ ListOfObjectives_getById()

Objective_t * ListOfObjectives_getById ( ListOf_t lo,
const char *  sid 
)

_tReturn_t _tthe_t _tstructure_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tsid_t _ta_t _tstring_t _tmatching_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _telement_t _tsought_t.

@_treturn_t _tthe_t _tstructure_t _tfor_t _tthe_t _tgiven_t _tvariable_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t _tin_t _tthe_t _tlist_t.

@_tmemberof_t _tListOfObjectives_t_t

◆ ListOfObjectives_removeById()

Objective_t * ListOfObjectives_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _tthe_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

* _tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tsought_t _tstructure_t.

@_treturn_t _tthe_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tno_t _tstructure_t _twith_t _tthe_t "_tid_t" _tattribute_t _texists_t _tin_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.

@_tmemberof_t _tListOfObjectives_t_t

◆ Objective_addFluxObjective()

int Objective_addFluxObjective ( Objective_t o,
FluxObjective_t fo 
)

◆ Objective_clone()

Objective_t * Objective_clone ( Objective_t o)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturns_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _ta_t _tfailure_t _toccurred_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_create()

Objective_t * Objective_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tObjective_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t, _tand_t _tthe_t @_tp_t _tpkgVersion_t _tpackage_t _tversion_t.

@_tparam_t _tlevel_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tlevel_t _tto_t _tassign_t _tto_t _tthis_t _tObjective_t_t _tstructure_t.

@_tparam_t _tversion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tversion_t _tto_t _tassign_t _tto_t _tthis_t _tObjective_t_t _tstructure_t.

@_tparam_t _tpkgVersion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tversion_t _tof_t _tthe_t _tpackage_t _tto_t _tassign_t _tto_t _tthis_t _tObjective_t_t _tstructure_t.

@_treturns_t _tthe_t _tnewly_t-_tcreated_t _tObjective_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tan_t _terror_t _toccurred_t _tduring_t _tconstruction_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tObjective_t_t

◆ Objective_createFluxObjective()

FluxObjective_t * Objective_createFluxObjective ( Objective_t o)

◆ Objective_free()

void Objective_free ( Objective_t o)

_tFrees_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_getFluxObjective()

FluxObjective_t * Objective_getFluxObjective ( Objective_t o,
unsigned int  n 
)

◆ Objective_getFluxObjectiveById()

FluxObjective_t * Objective_getFluxObjectiveById ( Objective_t o,
const char *  sid 
)

◆ Objective_getId()

const char * Objective_getId ( const Objective_t o)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_getListOfFluxObjectives()

ListOf_t * Objective_getListOfFluxObjectives ( Objective_t o)

◆ Objective_getName()

const char * Objective_getName ( const Objective_t o)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_getNumFluxObjectives()

unsigned int Objective_getNumFluxObjectives ( Objective_t o)

◆ Objective_getType()

const char * Objective_getType ( Objective_t obj)

_tTakes_t _ta_t _tObjective_t_t _tstructure_t _tand_t _treturns_t _tits_t _ttype_t.

@_tparam_t _tobj_t _tthe_t _tObjective_t_t _twhose_t _ttype_t _tis_t _tsought_t.

@_treturn_t _tthe_t _ttype_t _tof_t _tthe_t _tgiven_t _tObjective_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_hasRequiredAttributes()

int Objective_hasRequiredAttributes ( const Objective_t o)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tstructure_t _thave_t _tbeen_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_hasRequiredElements()

int Objective_hasRequiredElements ( const Objective_t o)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tsub_t-_telements_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tsub_t-_telements_t _tfor_t _tthis_t _tstructure_t _thave_t _tbeen_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_isSetId()

int Objective_isSetId ( const Objective_t o)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t'_ts_t "_tid_t" _tis_t _tset_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tid_t" _tof_t _tthis_t _tObjective_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_isSetName()

int Objective_isSetName ( const Objective_t o)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tname_t" _tof_t _tthis_t _tObjective_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_isSetType()

int Objective_isSetType ( const Objective_t o)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t'_ts_t "_ttype_t" _tis_t _tset_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_ttype_t" _tof_t _tthis_t _tObjective_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_removeFluxObjective()

FluxObjective_t * Objective_removeFluxObjective ( Objective_t o,
unsigned int  n 
)

◆ Objective_removeFluxObjectiveById()

FluxObjective_t * Objective_removeFluxObjectiveById ( Objective_t o,
const char *  sid 
)

◆ Objective_setId()

int Objective_setId ( Objective_t o,
const char *  id 
)

_tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tid_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tObjective_unsetId_t().

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_tparam_t _tid_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tid_t" _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tid_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_setName()

int Objective_setName ( Objective_t o,
const char *  name 
)

_tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tname_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tObjective_unsetName_t().

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_tparam_t _tname_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tname_t" _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tname_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t.

@_tmemberof_t _tObjective_t_t

◆ Objective_setType()

int Objective_setType ( Objective_t o,
const char *  type 
)

_tSets_t _tthe_t "_ttype_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_tparam_t _ttype_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_ttype_t" _tattribute_t _tshould_t _tbe_t _tset_t. _tValid_t _tvalues_t _tinclude_t: @_tli_t "_tmaximize_t" (@_tsbmlconstant_t{_tOBJECTIVE_TYPE_MAXIMIZE_t, _tObjectiveType_t_t}) @_tli_t "_tminimize_t" (@_tsbmlconstant_t{_tOBJECTIVE_TYPE_MINIMIZE_t, _tObjectiveType_t_t})

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tObjective_t_t

◆ Objective_unsetId()

int Objective_unsetId ( Objective_t o)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tObjective_t_t

◆ Objective_unsetName()

int Objective_unsetName ( Objective_t o)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tObjective_t_t

◆ Objective_unsetType()

int Objective_unsetType ( Objective_t o)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_ttype_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t.

@_tparam_t _to_t _tthe_t _tObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tObjective_t_t

◆ ObjectiveType_fromString()

ObjectiveType_t ObjectiveType_fromString ( const char *  s)

_tReturns_t _tthe_t _tObjectiveType_t_t _tenumeration_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t, _tor_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_UNKNOWN_t, _tObjectiveType_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.

_tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tmaximize_t" _twill_t _treturn_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_MAXIMIZE_t, _tObjectiveType_t_t}, _tbut_t "_tMaximize_t" _twill_t _treturn_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_UNKNOWN_t, _tObjectiveType_t_t}.

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _tconvert_t _tto_t _tan_t _tObjectiveType_t_t.

@_treturn_t _tThe_t _tcorresponding_t _tObjectiveType_t_t, _tor_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_UNKNOWN_t, _tObjectiveType_t_t} _tif_t _tno_t _tmatch_t _tfound_t.

@_tmemberof_t _tObjective_t_t

◆ ObjectiveType_isValidObjectiveType()

int ObjectiveType_isValidObjectiveType ( ObjectiveType_t  type)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tObjectiveType_t_t _tis_t _tvalid_t.

@_tparam_t _ttype_t _tthe_t _tObjectiveType_t_t _tenumeration_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tObjectiveType_t_t _tis_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_MAXIMIZE_t, _tObjectiveType_t_t} _tor_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_MINIMIZE_t, _tObjectiveType_t_t}; @_tc_t _t0_t (_tfalse_t) _totherwise_t (_tincluding_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_UNKNOWN_t, _tObjectiveType_t_t}).

@_tmemberof_t _tObjective_t_t

◆ ObjectiveType_isValidObjectiveTypeString()

int ObjectiveType_isValidObjectiveTypeString ( const char *  s)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tstring_t _tis_t _ta_t _tvalid_t _tObjectiveType_t_t.

_tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tmaximize_t" _twill_t _treturn_t @_tc_t _ttrue_t, _tbut_t "_tMaximize_t" _twill_t _treturn_t @_tc_t _tfalse_t.

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstring_t _tis_t "_tmaximize_t" _tor_t "_tminimize_t"; @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tObjective_t_t

◆ ObjectiveType_toString()

const char * ObjectiveType_toString ( ObjectiveType_t  type)

_tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t _tObjectiveType_t_t _tenumeration_t.

@_tparam_t _ttype_t _tthe_t _tObjectiveType_t_t _tenumeration_t _tto_t _tconvert_t.

@_treturn_t _tA_t _tstring_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _teffect_t: "_tmaximize_t", "_tminimize_t", _tor_t @_tc_t _tNULL_t _tif_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tOBJECTIVE_TYPE_UNKNOWN_t, _tObjectiveType_t_t} _tor_t _tanother_t _tinvalid_t _tenumeration_t _tvalue_t.

@_tmemberof_t _tObjective_t_t

Variable Documentation

◆ OBJECTIVE_TYPE_STRINGS

const char* OBJECTIVE_TYPE_STRINGS[]
static
Initial value:
=
{
"maximize"
, "minimize"
, "unknown"
}