libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
GeneProductAssociation.h File Reference

Implementation of the GeneProductAssociation_t class. More...

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

Functions

GeneProductAssociation_tGeneProductAssociation_clone (GeneProductAssociation_t *gpa)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.
 
GeneProductAssociation_tGeneProductAssociation_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tGeneProductAssociation_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.
 
FbcAnd_tGeneProductAssociation_createAnd (GeneProductAssociation_t *gpa)
 
GeneProductRef_tGeneProductAssociation_createGeneProductRef (GeneProductAssociation_t *gpa)
 
FbcOr_tGeneProductAssociation_createOr (GeneProductAssociation_t *gpa)
 
void GeneProductAssociation_free (GeneProductAssociation_t *gpa)
 _tFrees_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.
 
FbcAssociation_tGeneProductAssociation_getAssociation (GeneProductAssociation_t *gpa)
 
const char * GeneProductAssociation_getId (const GeneProductAssociation_t *gpa)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.
 
const char * GeneProductAssociation_getName (const GeneProductAssociation_t *gpa)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.
 
int GeneProductAssociation_hasRequiredAttributes (const GeneProductAssociation_t *gpa)
 _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 _tGeneProductAssociation_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int GeneProductAssociation_hasRequiredElements (const GeneProductAssociation_t *gpa)
 _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 _tGeneProductAssociation_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int GeneProductAssociation_isSetAssociation (const GeneProductAssociation_t *gpa)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t'_ts_t "_tassociation_t" _tis_t _tset_t.
 
int GeneProductAssociation_isSetId (const GeneProductAssociation_t *gpa)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t'_ts_t "_tid_t" _tis_t _tset_t.
 
int GeneProductAssociation_isSetName (const GeneProductAssociation_t *gpa)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t.
 
int GeneProductAssociation_setAssociation (GeneProductAssociation_t *gpa, FbcAssociation_t *association)
 
int GeneProductAssociation_setId (GeneProductAssociation_t *gpa, const char *id)
 _tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.
 
int GeneProductAssociation_setName (GeneProductAssociation_t *gpa, const char *name)
 _tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.
 
int GeneProductAssociation_unsetId (GeneProductAssociation_t *gpa)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.
 
int GeneProductAssociation_unsetName (GeneProductAssociation_t *gpa)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.
 

Detailed Description

Implementation of the GeneProductAssociation_t class.

Author
SBMLTeam

Function Documentation

◆ GeneProductAssociation_clone()

GeneProductAssociation_t * GeneProductAssociation_clone ( GeneProductAssociation_t gpa)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

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

@_tmemberof_t _tGeneProductAssociation_t_t

◆ GeneProductAssociation_create()

GeneProductAssociation_t * GeneProductAssociation_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tGeneProductAssociation_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 _tGeneProductAssociation_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 _tGeneProductAssociation_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 _tGeneProductAssociation_t_t _tstructure_t.

@_treturns_t _tthe_t _tnewly_t-_tcreated_t _tGeneProductAssociation_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 _tGeneProductAssociation_t_t

◆ GeneProductAssociation_createAnd()

FbcAnd_t * GeneProductAssociation_createAnd ( GeneProductAssociation_t gpa)

◆ GeneProductAssociation_createGeneProductRef()

GeneProductRef_t * GeneProductAssociation_createGeneProductRef ( GeneProductAssociation_t gpa)

◆ GeneProductAssociation_createOr()

FbcOr_t * GeneProductAssociation_createOr ( GeneProductAssociation_t gpa)

◆ GeneProductAssociation_free()

void GeneProductAssociation_free ( GeneProductAssociation_t gpa)

_tFrees_t _tthe_t _tgiven_t _tGeneProductAssociation_t_t _tstructure_t.

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tGeneProductAssociation_t_t

◆ GeneProductAssociation_getAssociation()

FbcAssociation_t * GeneProductAssociation_getAssociation ( GeneProductAssociation_t gpa)

◆ GeneProductAssociation_getId()

const char * GeneProductAssociation_getId ( const GeneProductAssociation_t gpa)

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

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_t_t _tstructure_t.

@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tGeneProductAssociation_t_t

◆ GeneProductAssociation_getName()

const char * GeneProductAssociation_getName ( const GeneProductAssociation_t gpa)

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

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_t_t _tstructure_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tGeneProductAssociation_t_t

◆ GeneProductAssociation_hasRequiredAttributes()

int GeneProductAssociation_hasRequiredAttributes ( const GeneProductAssociation_t gpa)

_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 _tGeneProductAssociation_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_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 _tGeneProductAssociation_t_t

◆ GeneProductAssociation_hasRequiredElements()

int GeneProductAssociation_hasRequiredElements ( const GeneProductAssociation_t gpa)

_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 _tGeneProductAssociation_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_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 _tGeneProductAssociation_t_t

◆ GeneProductAssociation_isSetAssociation()

int GeneProductAssociation_isSetAssociation ( const GeneProductAssociation_t gpa)

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

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_t_t _tstructure_t.

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

@_tmemberof_t _tGeneProductAssociation_t_t

◆ GeneProductAssociation_isSetId()

int GeneProductAssociation_isSetId ( const GeneProductAssociation_t gpa)

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

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_t_t _tstructure_t.

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

@_tmemberof_t _tGeneProductAssociation_t_t

◆ GeneProductAssociation_isSetName()

int GeneProductAssociation_isSetName ( const GeneProductAssociation_t gpa)

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

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_t_t _tstructure_t.

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

@_tmemberof_t _tGeneProductAssociation_t_t

◆ GeneProductAssociation_setAssociation()

int GeneProductAssociation_setAssociation ( GeneProductAssociation_t gpa,
FbcAssociation_t association 
)

◆ GeneProductAssociation_setId()

int GeneProductAssociation_setId ( GeneProductAssociation_t gpa,
const char *  id 
)

_tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_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 _tGeneProductAssociation_unsetId_t().

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_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 _tGeneProductAssociation_t_t

◆ GeneProductAssociation_setName()

int GeneProductAssociation_setName ( GeneProductAssociation_t gpa,
const char *  name 
)

_tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductAssociation_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 _tGeneProductAssociation_unsetName_t().

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_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 _tGeneProductAssociation_t_t

◆ GeneProductAssociation_unsetId()

int GeneProductAssociation_unsetId ( GeneProductAssociation_t gpa)

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

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_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 _tGeneProductAssociation_t_t

◆ GeneProductAssociation_unsetName()

int GeneProductAssociation_unsetName ( GeneProductAssociation_t gpa)

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

@_tparam_t _tgpa_t _tthe_t _tGeneProductAssociation_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 _tGeneProductAssociation_t_t