libSBML C API
libSBML 5.20.2 C API
|
Implementation of Port_t, the SBase_t-derived class of the comp package. More...
Functions | |
Port_t * | Port_clone (Port_t *p) |
_tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t. | |
Port_t * | Port_create (unsigned int level, unsigned int version, unsigned int pkgVersion) |
@_tcond_t _tdoxygenIgnored_t | |
void | Port_free (Port_t *p) |
_tFrees_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t. | |
char * | Port_getId (Port_t *p) |
_tTakes_t _tan_t _tPort_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t. | |
char * | Port_getName (Port_t *p) |
_tTakes_t _ta_t _tPort_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t. | |
int | Port_hasRequiredAttributes (Port_t *p) |
_tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t _thave_t _tbeen_t _tset_t. | |
int | Port_isSetId (Port_t *p) |
_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 _tPort_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t. | |
int | Port_isSetName (Port_t *p) |
_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 _tPort_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t. | |
int | Port_setId (Port_t *p, const char *id) |
_tAssigns_t _tthe_t _tidentifier_t _tof_t _tan_t _tPort_t_t _tstructure_t. | |
int | Port_setName (Port_t *p, const char *name) |
_tSets_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tname_t. | |
int | Port_unsetId (Port_t *p) |
_tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t. | |
int | Port_unsetName (Port_t *p) |
_tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t. | |
Implementation of Port_t, the SBase_t-derived class of the comp package.
_tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _tto_t _tcopy_t.
@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tPort_t_t.
@_tmemberof_t _tPort_t_t
Port_t * Port_create | ( | unsigned int | level, |
unsigned int | version, | ||
unsigned int | pkgVersion | ||
) |
@_tcond_t _tdoxygenIgnored_t
_tCreates_t _ta_t _tnew_t _tPort_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 Port_free | ( | Port_t * | p | ) |
_tFrees_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _tto_t _tfree_t.
@_tmemberof_t _tPort_t_t
char * Port_getId | ( | Port_t * | p | ) |
_tTakes_t _tan_t _tPort_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _twhose_t _tidentifier_t _tis_t _tsought_t.
@_treturn_t _tthe_t _tidentifier_t _tof_t _tthe_t _tgiven_t _tPort_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.
@_tmemberof_t _tPort_t_t
char * Port_getName | ( | Port_t * | p | ) |
_tTakes_t _ta_t _tPort_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _twhose_t _tname_t _tis_t _tsought_t.
@_treturn_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tPort_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.
@_tmemberof_t _tPort_t_t
int Port_hasRequiredAttributes | ( | Port_t * | p | ) |
_tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
@_tnote_t _tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tPort_t_t _tstructure_t _tare_t _tthat_t _tit_t _tuses_t _texactly_t _tone_t _tattribute_t _tto_t _trefer_t _tto_t _tits_t _ttarget_t, _tand_t _tthat_t '_tid_t' _tis_t _tset_t.
@_tmemberof_t _tPort_t_t
int Port_isSetId | ( | Port_t * | p | ) |
_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 _tPort_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tPort_t_t
int Port_isSetName | ( | Port_t * | p | ) |
_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 _tPort_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tPort_t_t
int Port_setId | ( | Port_t * | p, |
const char * | sid | ||
) |
_tAssigns_t _tthe_t _tidentifier_t _tof_t _tan_t _tPort_t_t _tstructure_t.
_tThis_t _tmakes_t _ta_t _tcopy_t _tof_t _tthe_t _tstring_t _tpassed_t _tin_t _tthe_t _tparameter_t @_tp_t _tsid_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tidentifier_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}
@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tan_t @_tp_t _tsid_t _tof_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tid_t" _tattribute_t.
@_tmemberof_t _tPort_t_t
int Port_setName | ( | Port_t * | p, |
const char * | name | ||
) |
_tSets_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tname_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tname_t _tthe_t _tname_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tPort_t_t'_ts_t "_tname_t" _tattribute_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}
@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tname_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tname_t" _tattribute_t.
@_tmemberof_t _tPort_t_t
int Port_unsetId | ( | Port_t * | p | ) |
_tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _tto_t _tunset_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}
@_tmemberof_t _tPort_t_t
int Port_unsetName | ( | Port_t * | p | ) |
_tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tstructure_t.
@_tparam_t _tp_t _tthe_t _tPort_t_t _tstructure_t _tto_t _tunset_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}
@_tmemberof_t _tPort_t_t