libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
FbcOr.h File Reference

Implementation of the FbcOr_t class. More...

Include dependency graph for FbcOr.h:
This graph shows which files directly or indirectly include this file:

Functions

int FbcOr_addAssociation (FbcOr_t *fo, const FbcAssociation_t *a)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFbcAssociation_t_t _tto_t _tthis_t _tFbcOr_t_t.
 
FbcOr_tFbcOr_clone (const FbcOr_t *fo)
 _tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tFbcOr_t_t _tobject_t.
 
FbcOr_tFbcOr_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tFbcOr_t_t _tusing_t _tthe_t _tgiven_t _tSBML_t _tLevel_t, _tVersion_t _tand_t &_tldquo_t;_tfbc_t&_trdquo_t; _tpackage_t _tversion_t.
 
FbcAnd_tFbcOr_createAnd (FbcOr_t *fo)
 _tCreates_t _ta_t _tnew_t _tFbcAnd_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcOr_t_t _tobject_t _tand_t _treturns_t _tthe_t _tFbcAnd_t_t _tobject_t _tcreated_t.
 
GeneProductRef_tFbcOr_createGeneProductRef (FbcOr_t *fo)
 _tCreates_t _ta_t _tnew_t _tGeneProductRef_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcOr_t_t _tobject_t _tand_t _treturns_t _tthe_t _tGeneProductRef_t_t _tobject_t _tcreated_t.
 
FbcOr_tFbcOr_createOr (FbcOr_t *fo)
 _tCreates_t _ta_t _tnew_t _tFbcOr_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcOr_t_t _tobject_t _tand_t _treturns_t _tthe_t _tFbcOr_t_t _tobject_t _tcreated_t.
 
void FbcOr_free (FbcOr_t *fo)
 _tFrees_t _tthis_t _tFbcOr_t_t _tobject_t.
 
FbcAssociation_tFbcOr_getAssociation (FbcOr_t *fo, unsigned int n)
 _tGet_t _tan_t _tFbcAssociation_t_t _tfrom_t _tthe_t _tFbcOr_t_t.
 
FbcAssociation_tFbcOr_getAssociationById (FbcOr_t *fo, const char *sid)
 _tGet_t _tan_t _tFbcAssociation_t_t _tfrom_t _tthe_t _tFbcOr_t_t.
 
ListOf_tFbcOr_getListOfFbcAssociations (FbcOr_t *fo)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tFbcAssociation_t_t _tobjects_t _tfrom_t _tthis_t _tFbcOr_t_t.
 
unsigned int FbcOr_getNumAssociations (FbcOr_t *fo)
 _tGet_t _tthe_t _tnumber_t _tof_t _tFbcAssociation_t_t _tobjects_t _tin_t _tthis_t _tFbcOr_t_t.
 
int FbcOr_hasRequiredAttributes (const FbcOr_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tFbcOr_t_t _tobject_t _thave_t _tbeen_t _tset_t.
 
int FbcOr_hasRequiredElements (const FbcOr_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _telements_t _tfor_t _tthis_t _tFbcOr_t_t _tobject_t _thave_t _tbeen_t _tset_t.
 
FbcAssociation_tFbcOr_removeAssociation (FbcOr_t *fo, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tFbcAssociation_t_t _tfrom_t _tthis_t _tFbcOr_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
FbcAssociation_tFbcOr_removeAssociationById (FbcOr_t *fo, const char *sid)
 _tRemoves_t _tthe_t _tFbcAssociation_t_t _twith_t _tthe_t _tgiven_t _tidentifier_t _tfrom_t _tthis_t _tFbcOr_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 

Detailed Description

Implementation of the FbcOr_t class.

Author
SBMLTeam

Function Documentation

◆ FbcOr_addAssociation()

int FbcOr_addAssociation ( FbcOr_t fo,
const FbcAssociation_t a 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFbcAssociation_t_t _tto_t _tthis_t _tFbcOr_t_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tFbcAssociation_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _ta_t _tthe_t _tFbcAssociation_t_t _tobject_t _tto_t _tadd_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_clone()

FbcOr_t * FbcOr_clone ( const FbcOr_t fo)

_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tFbcOr_t_t _tobject_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tFbcOr_t_t _tobject_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_create()

FbcOr_t * FbcOr_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tFbcOr_t_t _tusing_t _tthe_t _tgiven_t _tSBML_t _tLevel_t, _tVersion_t _tand_t &_tldquo_t;_tfbc_t&_trdquo_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 _tFbcOr_t_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 _tFbcOr_t_t.

@_tparam_t _tpkgVersion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tFbc_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tFbcOr_t_t.

@_tcopydetails_t _tdoc_note_setting_lv_pkg_t

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_createAnd()

FbcAnd_t * FbcOr_createAnd ( FbcOr_t fo)

_tCreates_t _ta_t _tnew_t _tFbcAnd_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcOr_t_t _tobject_t _tand_t _treturns_t _tthe_t _tFbcAnd_t_t _tobject_t _tcreated_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tFbcAnd_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tFbcAnd_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_createGeneProductRef()

GeneProductRef_t * FbcOr_createGeneProductRef ( FbcOr_t fo)

_tCreates_t _ta_t _tnew_t _tGeneProductRef_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcOr_t_t _tobject_t _tand_t _treturns_t _tthe_t _tGeneProductRef_t_t _tobject_t _tcreated_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tGeneProductRef_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tGeneProductRef_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_createOr()

FbcOr_t * FbcOr_createOr ( FbcOr_t fo)

_tCreates_t _ta_t _tnew_t _tFbcOr_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcOr_t_t _tobject_t _tand_t _treturns_t _tthe_t _tFbcOr_t_t _tobject_t _tcreated_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tFbcOr_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tFbcOr_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_free()

void FbcOr_free ( FbcOr_t fo)

_tFrees_t _tthis_t _tFbcOr_t_t _tobject_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t.

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_getAssociation()

FbcAssociation_t * FbcOr_getAssociation ( FbcOr_t fo,
unsigned int  n 
)

_tGet_t _tan_t _tFbcAssociation_t_t _tfrom_t _tthe_t _tFbcOr_t_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tFbcAssociation_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tFbcAssociation_t_t _tin_t _tthe_t _tListOfAssociations_t _twithin_t _tthis_t _tFbcOr_t. _tIf_t _tthe_t _tindex_t @_tp_t _tn_t _tis_t _tinvalid_t, @_tc_t _tNULL_t _tis_t _treturned_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_getAssociationById()

FbcAssociation_t * FbcOr_getAssociationById ( FbcOr_t fo,
const char *  sid 
)

_tGet_t _tan_t _tFbcAssociation_t_t _tfrom_t _tthe_t _tFbcOr_t_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tthe_t _tFbcAssociation_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tFbcAssociation_t_t _tin_t _tthe_t _tListOfAssociations_t _twithin_t _tthis_t _tFbcOr_t _twith_t _tthe_t _tgiven_t _tidentifier_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_getListOfFbcAssociations()

ListOf_t * FbcOr_getListOfFbcAssociations ( FbcOr_t fo)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tFbcAssociation_t_t _tobjects_t _tfrom_t _tthis_t _tFbcOr_t_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _twhose_t _tListOfAssociations_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfAssociations_t _tfrom_t _tthis_t _tFbcOr_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tFbcOr_addAssociation_t() @_tsee_t _tFbcOr_getAssociationById_t() @_tsee_t _tFbcOr_getAssociation_t() @_tsee_t _tFbcOr_getNumAssociations_t() @_tsee_t _tFbcOr_removeAssociationById_t() @_tsee_t _tFbcOr_removeAssociation_t()

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_getNumAssociations()

unsigned int FbcOr_getNumAssociations ( FbcOr_t fo)

_tGet_t _tthe_t _tnumber_t _tof_t _tFbcAssociation_t_t _tobjects_t _tin_t _tthis_t _tFbcOr_t_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tFbcAssociation_t_t _tobjects_t _tin_t _tthis_t _tFbcOr_t_t.

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_hasRequiredAttributes()

int FbcOr_hasRequiredAttributes ( const FbcOr_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tFbcOr_t_t _tobject_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tto_t _tindicate_t _tthat_t _tall_t _tthe_t _trequired_t _tattributes_t _tof_t _tthis_t _tFbcOr_t_t _thave_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_hasRequiredElements()

int FbcOr_hasRequiredElements ( const FbcOr_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _telements_t _tfor_t _tthis_t _tFbcOr_t_t _tobject_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tto_t _tindicate_t _tthat_t _tall_t _tthe_t _trequired_t _telements_t _tof_t _tthis_t _tFbcOr_t_t _thave_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tnote_t _tThe_t _trequired_t _telements_t _tfor_t _tthe_t _tFbcOr_t_t _tobject_t _tare_t:

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_removeAssociation()

FbcAssociation_t * FbcOr_removeAssociation ( FbcOr_t fo,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tFbcAssociation_t_t _tfrom_t _tthis_t _tFbcOr_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tFbcAssociation_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tFbcAssociation_t_t _tin_t _tthis_t _tFbcOr_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tFbcOr_t_t

◆ FbcOr_removeAssociationById()

FbcAssociation_t * FbcOr_removeAssociationById ( FbcOr_t fo,
const char *  sid 
)

_tRemoves_t _tthe_t _tFbcAssociation_t_t _twith_t _tthe_t _tgiven_t _tidentifier_t _tfrom_t _tthis_t _tFbcOr_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tfo_t _tthe_t _tFbcOr_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tthe_t _tFbcAssociation_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tremoved_t _tFbcAssociation_t_t _tin_t _tthis_t _tFbcOr_t_t, _tor_t _tNULL_t _tif_t _tno_t _tFbcAssociation_t_t _twas_t _tfound_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tFbcOr_t_t