Constraint.cpp File Reference

Implementations of Constraint_t and ListOfConstraints_t. More...

Include dependency graph for Constraint.cpp:

Functions
Constraint_t *	Constraint_clone (const Constraint_t *c)
	_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tConstraint_t_t _tstructure_t.
Constraint_t *	Constraint_create (unsigned int level, unsigned int version)
	@_tendcond_t
Constraint_t *	Constraint_createWithNS (SBMLNamespaces_t *sbmlns)
	_tCreates_t _ta_t _tnew_t _tConstraint_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
void	Constraint_free (Constraint_t *c)
	_tFrees_t _tthe_t _tgiven_t _tConstraint_t_t _tstructure_t.
const ASTNode_t *	Constraint_getMath (const Constraint_t *c)
	_tGet_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tConstraint_t_t
const XMLNode_t *	Constraint_getMessage (const Constraint_t *c)
	_tGet_t _tthe_t _tmessage_t, _tif_t _tany_t, _tassociated_t _twith_t _tthis_t _tConstraint_t_t
char *	Constraint_getMessageMarkdown (const Constraint_t *c)
	_tGet_t _tthe_t _tmessage_t _tstring_t, _tif_t _tany_t, _tassociated_t _twith_t _tthis_t _tConstraint_t_t, _tin_t _tmarkdown_t _tform_t.
char *	Constraint_getMessageString (const Constraint_t *c)
	_tGet_t _tthe_t _tmessage_t _tstring_t, _tif_t _tany_t, _tassociated_t _twith_t _tthis_t _tConstraint_t_t
const XMLNamespaces_t *	Constraint_getNamespaces (Constraint_t *c)
	_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tConstraint_t_t _tstructure_t.
int	Constraint_isSetMath (const Constraint_t *c)
	_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _ta_t _tmathematical_t _tformula_t _tis_t _tdefined_t _tfor_t _tthis_t _tConstraint_t_t.
int	Constraint_isSetMessage (const Constraint_t *c)
	_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _ta_t _tmessage_t _tis_t _tdefined_t _tfor_t _tthis_t _tConstraint_t_t.
int	Constraint_setMath (Constraint_t *c, const ASTNode_t *math)
	_tSets_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tConstraint_t_t.
int	Constraint_setMessage (Constraint_t *c, const XMLNode_t *xhtml)
	_tSets_t _tthe_t _tmessage_t _tof_t _tthis_t _tConstraint_t_t.
int	Constraint_setMessageFromMarkdown (Constraint_t *c, const char *markdown)
	_tSets_t _tthe_t _tmessage_t _tof_t _tthis_t _tConstraint_t_t _tfrom_t _ta_t _tmarkdown_t-_tformatted_t _tstring_t.
int	Constraint_setMessageString (Constraint_t *c, const char *message)
	_tSets_t _tthe_t _tmessage_t _tof_t _tthis_t _tConstraint_t_t.
int	Constraint_unsetMessage (Constraint_t *c)
	_tUnsets_t _tthe_t "_tmessage_t" _tsubelement_t _tof_t _tthis_t _tConstraint_t_t.

Detailed Description

Implementations of Constraint_t and ListOfConstraints_t.

Author

Ben Bornstein

Function Documentation

Constraint_clone()

Constraint_t * Constraint_clone

(

const Constraint_t *

c

)

_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tConstraint_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t _tto_t _tcopy_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tConstraint_t_t.

@_tmemberof_t _tConstraint_t_t

Constraint_create()

Constraint_t * Constraint_create	(	unsigned int	level,
		unsigned int	version )

@_tendcond_t

_tCreates_t _ta_t _tnew_t _tConstraint_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tvalues_t.

@_tcond_t _tdoxygenIgnored_t

Constraint_createWithNS()

Constraint_t * Constraint_createWithNS

(

SBMLNamespaces_t *

sbmlns

)

_tCreates_t _ta_t _tnew_t _tConstraint_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tsbmlns_t _tSBMLNamespaces_t_t, _ta_t _tpointer_t _tto_t _tan_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tassign_t _tto_t _tthis_t _tConstraint_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tConstraint_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tConstraint_t_t

Constraint_free()

void Constraint_free

(

Constraint_t *

c

)

_tFrees_t _tthe_t _tgiven_t _tConstraint_t_t _tstructure_t.

@_tmemberof_t _tConstraint_t_t

Constraint_getMath()

const ASTNode_t * Constraint_getMath

(

const Constraint_t *

c

)

_tGet_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tConstraint_t_t

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_treturn_t _tthe_t _tmath_t _tfor_t _tthis_t _tConstraint_t_t, _tas_t _tan_t _tASTNode_t_t.

@_tmemberof_t _tConstraint_t_t

Constraint_getMessage()

const XMLNode_t * Constraint_getMessage

(

const Constraint_t *

c

)

_tGet_t _tthe_t _tmessage_t, _tif_t _tany_t, _tassociated_t _twith_t _tthis_t _tConstraint_t_t

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_treturn_t _tthe_t _tmessage_t _tfor_t _tthis_t _tConstraint_t_t, _tas_t _tan_t _tXMLNode_t_t.

@_tmemberof_t _tConstraint_t_t

Constraint_getMessageMarkdown()

char * Constraint_getMessageMarkdown

(

const Constraint_t *

c

)

_tGet_t _tthe_t _tmessage_t _tstring_t, _tif_t _tany_t, _tassociated_t _twith_t _tthis_t _tConstraint_t_t, _tin_t _tmarkdown_t _tform_t.

_tThe_t _tstring_t _tis_t _towned_t _tby_t _tthe_t _tcaller_t _tand_t _tshould_t _tbe_t _tfreed_t (_twith_t _tfree_t()) _twhen_t _tno_t _tlonger_t _tneeded_t. _tThe_t _tHTML_t _tis_t _ttranslated_t _tby_t '_thtml2md_t', _thttps_t://_tgithub._tcom_t/_ttim_t-_tgromeyer_t/_thtml2md_t/

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_treturn_t _tthe_t _tmessage_t _tfor_t _tthis_t _tConstraint_t_t, _tas_t _ta_t _tmarkdown_t-_tformatted_t _tstring_t (_tchar_t*). @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tthe_t _tmessage_t _tis_t _tnot_t _tset_t.

@_tnote_t _treturned_t _tchar_t* _tshould_t _tbe_t _tfreed_t _twith_t _tsafe_free_t() _tby_t _tthe_t _tcaller_t.

@_tmemberof_t _tConstraint_t_t

Constraint_getMessageString()

char * Constraint_getMessageString

(

const Constraint_t *

c

)

_tGet_t _tthe_t _tmessage_t _tstring_t, _tif_t _tany_t, _tassociated_t _twith_t _tthis_t _tConstraint_t_t

_tThe_t _tstring_t _tis_t _towned_t _tby_t _tthe_t _tcaller_t _tand_t _tshould_t _tbe_t _tfreed_t (_twith_t _tfree_t()) _twhen_t _tno_t _tlonger_t _tneeded_t.

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_treturn_t _tthe_t _tmessage_t _tfor_t _tthis_t _tConstraint_t_t, _tas_t _ta_t _tstring_t (_tchar_t*). @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tthe_t _tmessage_t _tis_t _tnot_t _tset_t.

@_tnote_t _treturned_t _tchar_t* _tshould_t _tbe_t _tfreed_t _twith_t _tsafe_free_t() _tby_t _tthe_t _tcaller_t.

@_tmemberof_t _tConstraint_t_t

Constraint_getNamespaces()

const XMLNamespaces_t * Constraint_getNamespaces

(

Constraint_t *

c

)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tConstraint_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tXMLNamespaces_t_t _tstructure_t _tassociated_t _twith_t _tthis_t _tstructure_t

@_tmemberof_t _tConstraint_t_t

Constraint_isSetMath()

int Constraint_isSetMath

(

const Constraint_t *

c

)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _ta_t _tmathematical_t _tformula_t _tis_t _tdefined_t _tfor_t _tthis_t _tConstraint_t_t.

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_treturn_t @_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tmath_t" _tsubelement_t _tfor_t _tthis_t _tConstraint_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tConstraint_t_t

Constraint_isSetMessage()

int Constraint_isSetMessage

(

const Constraint_t *

c

)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _ta_t _tmessage_t _tis_t _tdefined_t _tfor_t _tthis_t _tConstraint_t_t.

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tmessage_t" _tsubelement_t _tfor_t _tthis_t _tConstraint_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tConstraint_t_t

Constraint_setMath()

int Constraint_setMath	(	Constraint_t *	c,
		const ASTNode_t *	math )

_tSets_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tConstraint_t_t.

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_tparam_t _tmath_t _tan_t _tASTNode_t_t _texpression_t _tto_t _tbe_t _tassigned_t _tas_t _tthe_t "_tmath_t" _tsubelement_t _tof_t _tthis_t _tConstraint_t_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}

@_tmemberof_t _tConstraint_t_t

Constraint_setMessage()

int Constraint_setMessage	(	Constraint_t *	c,
		const XMLNode_t *	xhtml )

_tSets_t _tthe_t _tmessage_t _tof_t _tthis_t _tConstraint_t_t.

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_tparam_t _txhtml_t _tan_t _tXML_t _ttree_t _tcontaining_t _tXHTML_t _tcontent_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}

@_tmemberof_t _tConstraint_t_t

Constraint_setMessageFromMarkdown()

int Constraint_setMessageFromMarkdown	(	Constraint_t *	c,
		const char *	markdown )

_tSets_t _tthe_t _tmessage_t _tof_t _tthis_t _tConstraint_t_t _tfrom_t _ta_t _tmarkdown_t-_tformatted_t _tstring_t.

_tMarkdown_t _tparser_t _tis_t '_tmaddy_t' (_thttps_t://_tgithub._tcom_t/_tprogsource_t/_tmaddy_t).

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_tparam_t _tmarkdown_t _ta_t _tstring_t _tcontaining_t _tthe_t _tmessage_t _tin_t _tmarkdown_t _tformat_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}

@_tmemberof_t _tConstraint_t_t

Constraint_setMessageString()

int Constraint_setMessageString	(	Constraint_t *	c,
		const char *	message )

_tSets_t _tthe_t _tmessage_t _tof_t _tthis_t _tConstraint_t_t.

@_tparam_t _tc_t _tthe_t _tConstraint_t_t _tstructure_t.

@_tparam_t _tmessage_t _ta_t _tstring_t _tcontaining_t _tXHTML_t _tcontent_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}

@_tmemberof_t _tConstraint_t_t

Constraint_unsetMessage()

int Constraint_unsetMessage

(

Constraint_t *

c

)

_tUnsets_t _tthe_t "_tmessage_t" _tsubelement_t _tof_t _tthis_t _tConstraint_t_t.

@_tparam_t _tc_t _tthe_t _tConstraint_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}

@_tmemberof_t _tConstraint_t_t