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

Implementation of the Member_t class. More...

Include dependency graph for Member.cpp:

Functions

Member_tMember_clone (const Member_t *m)
 _tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tMember_t_t _tobject_t.
 
Member_tMember_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tMember_t_t _tusing_t _tthe_t _tgiven_t _tSBML_t _tLevel_t, _tVersion_t _tand_t &_tldquo_t;_tgroups_t&_trdquo_t; _tpackage_t _tversion_t.
 
void Member_free (Member_t *m)
 _tFrees_t _tthis_t _tMember_t_t _tobject_t.
 
char * Member_getId (const Member_t *m)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
char * Member_getIdRef (const Member_t *m)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tidRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
char * Member_getMetaIdRef (const Member_t *m)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaIdRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
char * Member_getName (const Member_t *m)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
int Member_hasRequiredAttributes (const Member_t *m)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tMember_t_t _tobject_t _thave_t _tbeen_t _tset_t.
 
int Member_isSetId (const Member_t *m)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.
 
int Member_isSetIdRef (const Member_t *m)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tidRef_t" _tattribute_t _tis_t _tset_t.
 
int Member_isSetMetaIdRef (const Member_t *m)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tmetaIdRef_t" _tattribute_t _tis_t _tset_t.
 
int Member_isSetName (const Member_t *m)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.
 
int Member_setId (Member_t *m, const char *id)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
int Member_setIdRef (Member_t *m, const char *idRef)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tidRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
int Member_setMetaIdRef (Member_t *m, const char *metaIdRef)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaIdRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
int Member_setName (Member_t *m, const char *name)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
int Member_unsetId (Member_t *m)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
int Member_unsetIdRef (Member_t *m)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tidRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
int Member_unsetMetaIdRef (Member_t *m)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaIdRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 
int Member_unsetName (Member_t *m)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.
 

Detailed Description

Implementation of the Member_t class.

Author
SBMLTeam

Function Documentation

◆ Member_clone()

Member_t * Member_clone ( const Member_t m)

_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tMember_t_t _tobject_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

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

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tMember_t_t

◆ Member_create()

Member_t * Member_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tMember_t_t _tusing_t _tthe_t _tgiven_t _tSBML_t _tLevel_t, _tVersion_t _tand_t &_tldquo_t;_tgroups_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 _tMember_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 _tMember_t_t.

@_tparam_t _tpkgVersion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tGroups_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tMember_t_t.

@_tcopydetails_t _tdoc_note_setting_lv_pkg_t

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tMember_t_t

◆ Member_free()

void Member_free ( Member_t m)

_tFrees_t _tthis_t _tMember_t_t _tobject_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_tmemberof_t _tMember_t_t

◆ Member_getId()

char * Member_getId ( const Member_t m)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t _twhose_t _tid_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tMember_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tMember_t_t

◆ Member_getIdRef()

char * Member_getIdRef ( const Member_t m)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tidRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t _twhose_t _tidRef_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tidRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tMember_t_t

◆ Member_getMetaIdRef()

char * Member_getMetaIdRef ( const Member_t m)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaIdRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t _twhose_t _tmetaIdRef_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaIdRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tMember_t_t

◆ Member_getName()

char * Member_getName ( const Member_t m)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t _twhose_t _tname_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tMember_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tMember_t_t

◆ Member_hasRequiredAttributes()

int Member_hasRequiredAttributes ( const Member_t m)

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

@_tparam_t _tm_t _tthe_t _tMember_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 _tMember_t_t _thave_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tMember_t_t

◆ Member_isSetId()

int Member_isSetId ( const Member_t m)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tid_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tMember_t_t

◆ Member_isSetIdRef()

int Member_isSetIdRef ( const Member_t m)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tidRef_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tidRef_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tMember_t_t

◆ Member_isSetMetaIdRef()

int Member_isSetMetaIdRef ( const Member_t m)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tmetaIdRef_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tmetaIdRef_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tMember_t_t

◆ Member_isSetName()

int Member_isSetName ( const Member_t m)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMember_t_t'_ts_t "_tname_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tMember_t_t

◆ Member_setId()

int Member_setId ( Member_t m,
const char *  id 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_tparam_t _tid_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tto_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}

_tCalling_t _tthis_t _tfunction_t _twith_t @_tp_t _tid_t = @_tc_t _tNULL_t _tor_t _tan_t _tempty_t _tstring_t _tis_t _tequivalent_t _tto_t _tcalling_t _tMember_unsetId_t().

@_tmemberof_t _tMember_t_t

◆ Member_setIdRef()

int Member_setIdRef ( Member_t m,
const char *  idRef 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tidRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_tparam_t _tidRef_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tidRef_t" _tattribute_t _tto_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}

@_tmemberof_t _tMember_t_t

◆ Member_setMetaIdRef()

int Member_setMetaIdRef ( Member_t m,
const char *  metaIdRef 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaIdRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_tparam_t _tmetaIdRef_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tmetaIdRef_t" _tattribute_t _tto_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}

@_tmemberof_t _tMember_t_t

◆ Member_setName()

int Member_setName ( Member_t m,
const char *  name 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_t_t _tstructure_t.

@_tparam_t _tname_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tto_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_OBJECT_t, _tOperationReturnValues_t_t}

_tCalling_t _tthis_t _tfunction_t _twith_t @_tp_t _tname_t = @_tc_t _tNULL_t _tor_t _tan_t _tempty_t _tstring_t _tis_t _tequivalent_t _tto_t _tcalling_t _tMember_unsetName_t().

@_tmemberof_t _tMember_t_t

◆ Member_unsetId()

int Member_unsetId ( Member_t m)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_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 _tMember_t_t

◆ Member_unsetIdRef()

int Member_unsetIdRef ( Member_t m)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tidRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_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 _tMember_t_t

◆ Member_unsetMetaIdRef()

int Member_unsetMetaIdRef ( Member_t m)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaIdRef_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_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 _tMember_t_t

◆ Member_unsetName()

int Member_unsetName ( Member_t m)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tMember_t_t.

@_tparam_t _tm_t _tthe_t _tMember_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 _tMember_t_t