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

Definition of the UserDefinedConstraint_t class. More...

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

Functions

int UserDefinedConstraint_addUserDefinedConstraintComponent (UserDefinedConstraint_t *udc, const UserDefinedConstraintComponent_t *udcc)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tUserDefinedConstraintComponent_t_t _tto_t _tthis_t _tUserDefinedConstraint_t_t.
 
UserDefinedConstraint_tUserDefinedConstraint_clone (const UserDefinedConstraint_t *udc)
 _tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tUserDefinedConstraint_t_t _tobject_t.
 
UserDefinedConstraint_tUserDefinedConstraint_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tUserDefinedConstraint_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.
 
UserDefinedConstraintComponent_tUserDefinedConstraint_createUserDefinedConstraintComponent (UserDefinedConstraint_t *udc)
 _tCreates_t _ta_t _tnew_t _tUserDefinedConstraintComponent_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tUserDefinedConstraint_t_t _tobject_t _tand_t _treturns_t _tthe_t _tUserDefinedConstraintComponent_t_t _tobject_t _tcreated_t.
 
void UserDefinedConstraint_free (UserDefinedConstraint_t *udc)
 _tFrees_t _tthis_t _tUserDefinedConstraint_t_t _tobject_t.
 
char * UserDefinedConstraint_getId (const UserDefinedConstraint_t *udc)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
ListOf_tUserDefinedConstraint_getListOfUserDefinedConstraintComponents (UserDefinedConstraint_t *udc)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tUserDefinedConstraintComponent_t_t _tobjects_t _tfrom_t _tthis_t _tUserDefinedConstraint_t_t.
 
char * UserDefinedConstraint_getLowerBound (const UserDefinedConstraint_t *udc)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tlowerBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
char * UserDefinedConstraint_getName (const UserDefinedConstraint_t *udc)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
unsigned int UserDefinedConstraint_getNumUserDefinedConstraintComponents (UserDefinedConstraint_t *udc)
 _tGet_t _tthe_t _tnumber_t _tof_t _tUserDefinedConstraintComponent_t_t _tobjects_t _tin_t _tthis_t _tUserDefinedConstraint_t_t.
 
char * UserDefinedConstraint_getUpperBound (const UserDefinedConstraint_t *udc)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tupperBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
UserDefinedConstraintComponent_tUserDefinedConstraint_getUserDefinedConstraintComponent (UserDefinedConstraint_t *udc, unsigned int n)
 _tGet_t _tan_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthe_t _tUserDefinedConstraint_t_t.
 
UserDefinedConstraintComponent_tUserDefinedConstraint_getUserDefinedConstraintComponentById (UserDefinedConstraint_t *udc, const char *sid)
 _tGet_t _tan_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthe_t _tUserDefinedConstraint_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
UserDefinedConstraintComponent_tUserDefinedConstraint_getUserDefinedConstraintComponentByVariable (UserDefinedConstraint_t *udc, const char *sid)
 _tGet_t _tan_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthe_t _tUserDefinedConstraint_t_t _tbased_t _ton_t _tthe_t _tVariable_t _tto_t _twhich_t _tit_t _trefers_t.
 
int UserDefinedConstraint_hasRequiredAttributes (const UserDefinedConstraint_t *udc)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tUserDefinedConstraint_t_t _tobject_t _thave_t _tbeen_t _tset_t.
 
int UserDefinedConstraint_hasRequiredElements (const UserDefinedConstraint_t *udc)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _telements_t _tfor_t _tthis_t _tUserDefinedConstraint_t_t _tobject_t _thave_t _tbeen_t _tset_t.
 
int UserDefinedConstraint_isSetId (const UserDefinedConstraint_t *udc)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tUserDefinedConstraint_t_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.
 
int UserDefinedConstraint_isSetLowerBound (const UserDefinedConstraint_t *udc)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tUserDefinedConstraint_t_t'_ts_t "_tlowerBound_t" _tattribute_t _tis_t _tset_t.
 
int UserDefinedConstraint_isSetName (const UserDefinedConstraint_t *udc)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tUserDefinedConstraint_t_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.
 
int UserDefinedConstraint_isSetUpperBound (const UserDefinedConstraint_t *udc)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tUserDefinedConstraint_t_t'_ts_t "_tupperBound_t" _tattribute_t _tis_t _tset_t.
 
UserDefinedConstraintComponent_tUserDefinedConstraint_removeUserDefinedConstraintComponent (UserDefinedConstraint_t *udc, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthis_t _tUserDefinedConstraint_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
UserDefinedConstraintComponent_tUserDefinedConstraint_removeUserDefinedConstraintComponentById (UserDefinedConstraint_t *udc, const char *sid)
 _tRemoves_t _tthe_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthis_t _tUserDefinedConstraint_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int UserDefinedConstraint_setId (UserDefinedConstraint_t *udc, const char *id)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
int UserDefinedConstraint_setLowerBound (UserDefinedConstraint_t *udc, const char *lowerBound)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tlowerBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
int UserDefinedConstraint_setName (UserDefinedConstraint_t *udc, const char *name)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
int UserDefinedConstraint_setUpperBound (UserDefinedConstraint_t *udc, const char *upperBound)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tupperBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
int UserDefinedConstraint_unsetId (UserDefinedConstraint_t *udc)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
int UserDefinedConstraint_unsetLowerBound (UserDefinedConstraint_t *udc)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tlowerBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
int UserDefinedConstraint_unsetName (UserDefinedConstraint_t *udc)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 
int UserDefinedConstraint_unsetUpperBound (UserDefinedConstraint_t *udc)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tupperBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.
 

Detailed Description

Definition of the UserDefinedConstraint_t class.

Author
SBMLTeam

Function Documentation

◆ UserDefinedConstraint_addUserDefinedConstraintComponent()

int UserDefinedConstraint_addUserDefinedConstraintComponent ( UserDefinedConstraint_t udc,
const UserDefinedConstraintComponent_t udcc 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tUserDefinedConstraintComponent_t_t _tto_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tUserDefinedConstraintComponent_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tudcc_t _tthe_t _tUserDefinedConstraintComponent_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 _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_clone()

UserDefinedConstraint_t * UserDefinedConstraint_clone ( const UserDefinedConstraint_t udc)

_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tUserDefinedConstraint_t_t _tobject_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t.

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

@_tcopydetails_t _tdoc_returned_owned_pointer_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_create()

UserDefinedConstraint_t * UserDefinedConstraint_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_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 _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t.

@_tcopydetails_t _tdoc_note_setting_lv_pkg_t

@_tcopydetails_t _tdoc_returned_owned_pointer_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_createUserDefinedConstraintComponent()

UserDefinedConstraintComponent_t * UserDefinedConstraint_createUserDefinedConstraintComponent ( UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tUserDefinedConstraintComponent_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tUserDefinedConstraintComponent_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_free()

void UserDefinedConstraint_free ( UserDefinedConstraint_t udc)

_tFrees_t _tthis_t _tUserDefinedConstraint_t_t _tobject_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t.

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getId()

char * UserDefinedConstraint_getId ( const UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_returned_owned_char_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getListOfUserDefinedConstraintComponents()

ListOf_t * UserDefinedConstraint_getListOfUserDefinedConstraintComponents ( UserDefinedConstraint_t udc)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tUserDefinedConstraintComponent_t_t _tobjects_t _tfrom_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _twhose_t _tListOfUserDefinedConstraintComponents_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfUserDefinedConstraintComponents_t _tfrom_t _tthis_t _tUserDefinedConstraint_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tUserDefinedConstraint_addUserDefinedConstraintComponent_t() @_tsee_t _tUserDefinedConstraint_createUserDefinedConstraintComponent_t() @_tsee_t _tUserDefinedConstraint_getUserDefinedConstraintComponentById_t() @_tsee_t _tUserDefinedConstraint_getUserDefinedConstraintComponent_t() @_tsee_t _tUserDefinedConstraint_getNumUserDefinedConstraintComponents_t() @_tsee_t _tUserDefinedConstraint_removeUserDefinedConstraintComponentById_t() @_tsee_t _tUserDefinedConstraint_removeUserDefinedConstraintComponent_t()

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getLowerBound()

char * UserDefinedConstraint_getLowerBound ( const UserDefinedConstraint_t udc)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tlowerBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _twhose_t _tlowerBound_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tlowerBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_returned_owned_char_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getName()

char * UserDefinedConstraint_getName ( const UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_returned_owned_char_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getNumUserDefinedConstraintComponents()

unsigned int UserDefinedConstraint_getNumUserDefinedConstraintComponents ( UserDefinedConstraint_t udc)

_tGet_t _tthe_t _tnumber_t _tof_t _tUserDefinedConstraintComponent_t_t _tobjects_t _tin_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tUserDefinedConstraintComponent_t_t _tobjects_t _tin_t _tthis_t _tUserDefinedConstraint_t_t.

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getUpperBound()

char * UserDefinedConstraint_getUpperBound ( const UserDefinedConstraint_t udc)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tupperBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _twhose_t _tupperBound_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tupperBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_returned_owned_char_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getUserDefinedConstraintComponent()

UserDefinedConstraintComponent_t * UserDefinedConstraint_getUserDefinedConstraintComponent ( UserDefinedConstraint_t udc,
unsigned int  n 
)

_tGet_t _tan_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthe_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraintComponent_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tUserDefinedConstraintComponent_t_t _tin_t _tthe_t _tListOfUserDefinedConstraintComponents_t _twithin_t _tthis_t _tUserDefinedConstraint_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getUserDefinedConstraintComponentById()

UserDefinedConstraintComponent_t * UserDefinedConstraint_getUserDefinedConstraintComponentById ( UserDefinedConstraint_t udc,
const char *  sid 
)

_tGet_t _tan_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthe_t _tUserDefinedConstraint_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tUserDefinedConstraintComponent_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tUserDefinedConstraintComponent_t_t _tin_t _tthe_t _tListOfUserDefinedConstraintComponents_t _twithin_t _tthis_t _tUserDefinedConstraint_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tUserDefinedConstraintComponent_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_getUserDefinedConstraintComponentByVariable()

UserDefinedConstraintComponent_t * UserDefinedConstraint_getUserDefinedConstraintComponentByVariable ( UserDefinedConstraint_t udc,
const char *  sid 
)

_tGet_t _tan_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthe_t _tUserDefinedConstraint_t_t _tbased_t _ton_t _tthe_t _tVariable_t _tto_t _twhich_t _tit_t _trefers_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthe_t _tUserDefinedConstraintComponent_t_t _tobject_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tfirst_t _tUserDefinedConstraintComponent_t_t _tin_t _tthis_t _tUserDefinedConstraint_t_t _tbased_t _ton_t _tthe_t _tgiven_t _tvariable_t _tattribute_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tUserDefinedConstraintComponent_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_hasRequiredAttributes()

int UserDefinedConstraint_hasRequiredAttributes ( const UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_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 _tattributes_t _tfor_t _tthe_t _tUserDefinedConstraint_t_t _tobject_t _tare_t: @_tli_t "_tlowerBound_t" @_tli_t "_tupperBound_t"

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_hasRequiredElements()

int UserDefinedConstraint_hasRequiredElements ( const UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t _tobject_t _tare_t: @_tli_t "_tuserDefinedConstraintComponent_t"

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_isSetId()

int UserDefinedConstraint_isSetId ( const UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_isSetLowerBound()

int UserDefinedConstraint_isSetLowerBound ( const UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t.

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

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_isSetName()

int UserDefinedConstraint_isSetName ( const UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_isSetUpperBound()

int UserDefinedConstraint_isSetUpperBound ( const UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t.

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

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_removeUserDefinedConstraintComponent()

UserDefinedConstraintComponent_t * UserDefinedConstraint_removeUserDefinedConstraintComponent ( UserDefinedConstraint_t udc,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthis_t _tUserDefinedConstraint_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraintComponent_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tUserDefinedConstraintComponent_t_t _tin_t _tthis_t _tUserDefinedConstraint_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_removeUserDefinedConstraintComponentById()

UserDefinedConstraintComponent_t * UserDefinedConstraint_removeUserDefinedConstraintComponentById ( UserDefinedConstraint_t udc,
const char *  sid 
)

_tRemoves_t _tthe_t _tUserDefinedConstraintComponent_t_t _tfrom_t _tthis_t _tUserDefinedConstraint_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tUserDefinedConstraintComponent_t_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tUserDefinedConstraintComponent_t_t _tin_t _tthis_t _tUserDefinedConstraint_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tUserDefinedConstraintComponent_t_t _texists_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_setId()

int UserDefinedConstraint_setId ( UserDefinedConstraint_t udc,
const char *  id 
)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_unsetId_t().

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_setLowerBound()

int UserDefinedConstraint_setLowerBound ( UserDefinedConstraint_t udc,
const char *  lowerBound 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tlowerBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t.

@_tparam_t _tlowerBound_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tlowerBound_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 _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_setName()

int UserDefinedConstraint_setName ( UserDefinedConstraint_t udc,
const char *  name 
)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_unsetName_t().

@_tmemberof_t _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_setUpperBound()

int UserDefinedConstraint_setUpperBound ( UserDefinedConstraint_t udc,
const char *  upperBound 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tupperBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tstructure_t.

@_tparam_t _tupperBound_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tupperBound_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 _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_unsetId()

int UserDefinedConstraint_unsetId ( UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_unsetLowerBound()

int UserDefinedConstraint_unsetLowerBound ( UserDefinedConstraint_t udc)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tlowerBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_unsetName()

int UserDefinedConstraint_unsetName ( UserDefinedConstraint_t udc)

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

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t

◆ UserDefinedConstraint_unsetUpperBound()

int UserDefinedConstraint_unsetUpperBound ( UserDefinedConstraint_t udc)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tupperBound_t" _tattribute_t _tof_t _tthis_t _tUserDefinedConstraint_t_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_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 _tUserDefinedConstraint_t_t