libSBML C API
libSBML 5.20.4 C API
|
Implementation of the GeneProductRef_t class. More...
Functions | |
GeneProductRef_t * | GeneProductRef_clone (GeneProductRef_t *gpr) |
_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
GeneProductRef_t * | GeneProductRef_create (unsigned int level, unsigned int version, unsigned int pkgVersion) |
_tCreates_t _ta_t _tnew_t _tGeneProductRef_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. | |
void | GeneProductRef_free (GeneProductRef_t *gpr) |
_tFrees_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
const char * | GeneProductRef_getGeneProduct (const GeneProductRef_t *gpr) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tgeneProduct_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
const char * | GeneProductRef_getId (const GeneProductRef_t *gpr) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
const char * | GeneProductRef_getName (const GeneProductRef_t *gpr) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
int | GeneProductRef_hasRequiredAttributes (const GeneProductRef_t *gpr) |
_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 _tGeneProductRef_t_t _tstructure_t _thave_t _tbeen_t _tset_t. | |
int | GeneProductRef_isSetGeneProduct (const GeneProductRef_t *gpr) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t'_ts_t "_tgeneProduct_t" _tis_t _tset_t. | |
int | GeneProductRef_isSetId (const GeneProductRef_t *gpr) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t'_ts_t "_tid_t" _tis_t _tset_t. | |
int | GeneProductRef_isSetName (const GeneProductRef_t *gpr) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t. | |
int | GeneProductRef_setGeneProduct (GeneProductRef_t *gpr, const char *geneProduct) |
_tSets_t _tthe_t "_tgeneProduct_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
int | GeneProductRef_setId (GeneProductRef_t *gpr, const char *id) |
_tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
int | GeneProductRef_setName (GeneProductRef_t *gpr, const char *name) |
_tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
int | GeneProductRef_unsetGeneProduct (GeneProductRef_t *gpr) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tgeneProduct_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
int | GeneProductRef_unsetId (GeneProductRef_t *gpr) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
int | GeneProductRef_unsetName (GeneProductRef_t *gpr) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t. | |
Implementation of the GeneProductRef_t class.
GeneProductRef_t * GeneProductRef_clone | ( | GeneProductRef_t * | gpr | ) |
_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.
@_treturns_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _ta_t _tfailure_t _toccurred_t.
@_tmemberof_t _tGeneProductRef_t_t
GeneProductRef_t * GeneProductRef_create | ( | unsigned int | level, |
unsigned int | version, | ||
unsigned int | pkgVersion | ||
) |
_tCreates_t _ta_t _tnew_t _tGeneProductRef_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 _tGeneProductRef_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 _tGeneProductRef_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 _tGeneProductRef_t_t _tstructure_t.
@_treturns_t _tthe_t _tnewly_t-_tcreated_t _tGeneProductRef_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 _tGeneProductRef_t_t
void GeneProductRef_free | ( | GeneProductRef_t * | gpr | ) |
_tFrees_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.
@_tmemberof_t _tGeneProductRef_t_t
const char * GeneProductRef_getGeneProduct | ( | const GeneProductRef_t * | gpr | ) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tgeneProduct_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t.
@_treturn_t _tthe_t _tgeneProduct_t _tof_t _tthis_t _tstructure_t.
@_tmemberof_t _tGeneProductRef_t_t
const char * GeneProductRef_getId | ( | const GeneProductRef_t * | gpr | ) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t.
@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tstructure_t.
@_tmemberof_t _tGeneProductRef_t_t
const char * GeneProductRef_getName | ( | const GeneProductRef_t * | gpr | ) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t.
@_treturn_t _tthe_t _tname_t _tof_t _tthis_t _tstructure_t.
@_tmemberof_t _tGeneProductRef_t_t
int GeneProductRef_hasRequiredAttributes | ( | const GeneProductRef_t * | gpr | ) |
_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 _tGeneProductRef_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_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 _tGeneProductRef_t_t
int GeneProductRef_isSetGeneProduct | ( | const GeneProductRef_t * | gpr | ) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t'_ts_t "_tgeneProduct_t" _tis_t _tset_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tgeneProduct_t" _tof_t _tthis_t _tGeneProductRef_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tGeneProductRef_t_t
int GeneProductRef_isSetId | ( | const GeneProductRef_t * | gpr | ) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t'_ts_t "_tid_t" _tis_t _tset_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tid_t" _tof_t _tthis_t _tGeneProductRef_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tGeneProductRef_t_t
int GeneProductRef_isSetName | ( | const GeneProductRef_t * | gpr | ) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tname_t" _tof_t _tthis_t _tGeneProductRef_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tGeneProductRef_t_t
int GeneProductRef_setGeneProduct | ( | GeneProductRef_t * | gpr, |
const char * | geneProduct | ||
) |
_tSets_t _tthe_t "_tgeneProduct_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tgeneProduct_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 _tGeneProductRef_unsetGeneProduct_t().
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgeneProduct_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tgeneProduct_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 _tgeneProduct_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tgeneProduct_t" _tattribute_t.
@_tmemberof_t _tGeneProductRef_t_t
int GeneProductRef_setId | ( | GeneProductRef_t * | gpr, |
const char * | id | ||
) |
_tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_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 _tGeneProductRef_unsetId_t().
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_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 _tGeneProductRef_t_t
int GeneProductRef_setName | ( | GeneProductRef_t * | gpr, |
const char * | name | ||
) |
_tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_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 _tGeneProductRef_unsetName_t().
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_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 _tGeneProductRef_t_t
int GeneProductRef_unsetGeneProduct | ( | GeneProductRef_t * | gpr | ) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tgeneProduct_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_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 _tGeneProductRef_t_t
int GeneProductRef_unsetId | ( | GeneProductRef_t * | gpr | ) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_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 _tGeneProductRef_t_t
int GeneProductRef_unsetName | ( | GeneProductRef_t * | gpr | ) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tGeneProductRef_t_t _tstructure_t.
@_tparam_t _tgpr_t _tthe_t _tGeneProductRef_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 _tGeneProductRef_t_t