CompSBMLDocumentPlugin.cpp File Reference

Implementation of CompSBMLDocumentPlugin_t, the plugin class of comp package for the SBase_t element. More...

Include dependency graph for CompSBMLDocumentPlugin.cpp:

Functions
int	CompSBMLDocumentPlugin_addExternalModelDefinition (CompSBMLDocumentPlugin_t *csbmldp, const ExternalModelDefinition_t *emd)
	_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tExternalModelDefinition_t_t _tto_t _tthis_t _tCompSBMLDocumentPlugin_t_t.
int	CompSBMLDocumentPlugin_addModelDefinition (CompSBMLDocumentPlugin_t *csbmldp, const ModelDefinition_t *md)
	_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tModelDefinition_t_t _tto_t _tthis_t _tCompSBMLDocumentPlugin_t_t.
ExternalModelDefinition_t *	CompSBMLDocumentPlugin_createExternalModelDefinition (CompSBMLDocumentPlugin_t *csbmldp)
	_tCreates_t _ta_t _tnew_t _tExternalModelDefinition_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tExternalModelDefinition_t_t _tobject_t _tcreated_t.
ModelDefinition_t *	CompSBMLDocumentPlugin_createModelDefinition (CompSBMLDocumentPlugin_t *csbmldp)
	_tCreates_t _ta_t _tnew_t _tModelDefinition_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tModelDefinition_t_t _tobject_t _tcreated_t.
ExternalModelDefinition_t *	CompSBMLDocumentPlugin_getExternalModelDefinition (CompSBMLDocumentPlugin_t *csbmldp, unsigned int n)
	_tGet_t _tan_t _tExternalModelDefinition_t_t _tfrom_t _tthe_t _tCompSBMLDocumentPlugin_t_t.
ExternalModelDefinition_t *	CompSBMLDocumentPlugin_getExternalModelDefinitionById (CompSBMLDocumentPlugin_t *csbmldp, const char *sid)
	_tGet_t _tan_t _tExternalModelDefinition_t_t _tfrom_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
ListOfExternalModelDefinitions_t *	CompSBMLDocumentPlugin_getListOfExternalModelDefinitions (CompSBMLDocumentPlugin_t *csbmldp)
	_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tExternalModelDefinition_t_t _tobjects_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t.
ListOfModelDefinitions_t *	CompSBMLDocumentPlugin_getListOfModelDefinitions (CompSBMLDocumentPlugin_t *csbmldp)
	_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tModelDefinition_t_t _tobjects_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t.
ModelDefinition_t *	CompSBMLDocumentPlugin_getModelDefinition (CompSBMLDocumentPlugin_t *csbmldp, unsigned int n)
	_tGet_t _ta_t _tModelDefinition_t_t _tfrom_t _tthe_t _tCompSBMLDocumentPlugin_t_t.
unsigned int	CompSBMLDocumentPlugin_getNumExternalModelDefinitions (CompSBMLDocumentPlugin_t *csbmldp)
	_tGet_t _tthe_t _tnumber_t _tof_t _tExternalModelDefinition_t_t _tobjects_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t.
unsigned int	CompSBMLDocumentPlugin_getNumModelDefinitions (CompSBMLDocumentPlugin_t *csbmldp)
	_tGet_t _tthe_t _tnumber_t _tof_t _tModelDefinition_t_t _tobjects_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t.
ExternalModelDefinition_t *	CompSBMLDocumentPlugin_removeExternalModelDefinition (CompSBMLDocumentPlugin_t *csbmldp, unsigned int n)
	_tRemoves_t _tthe_t _tnth_t _tExternalModelDefinition_t_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
ExternalModelDefinition_t *	CompSBMLDocumentPlugin_removeExternalModelDefinitionById (CompSBMLDocumentPlugin_t *csbmldp, const char *sid)
	_tRemoves_t _tthe_t _tExternalModelDefinition_t_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
ModelDefinition_t *	CompSBMLDocumentPlugin_removeModelDefinition (CompSBMLDocumentPlugin_t *csbmldp, unsigned int n)
	_tRemoves_t _tthe_t _tnth_t _tModelDefinition_t_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

Detailed Description

Implementation of CompSBMLDocumentPlugin_t, the plugin class of comp package for the SBase_t element.

Author

Lucian Smith

Function Documentation

CompSBMLDocumentPlugin_addExternalModelDefinition()

int CompSBMLDocumentPlugin_addExternalModelDefinition	(	CompSBMLDocumentPlugin_t *	csbmldp,
		const ExternalModelDefinition_t *	emd
	)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tExternalModelDefinition_t_t _tto_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tExternalModelDefinition_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _temd_t _tthe_t _tExternalModelDefinition_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 _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_addModelDefinition()

int CompSBMLDocumentPlugin_addModelDefinition	(	CompSBMLDocumentPlugin_t *	csbmldp,
		const ModelDefinition_t *	md
	)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tModelDefinition_t_t _tto_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tModelDefinition_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tmd_t _tthe_t _tModelDefinition_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 _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_createExternalModelDefinition()

ExternalModelDefinition_t * CompSBMLDocumentPlugin_createExternalModelDefinition

(

CompSBMLDocumentPlugin_t *

csbmldp

)

_tCreates_t _ta_t _tnew_t _tExternalModelDefinition_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tExternalModelDefinition_t_t _tobject_t _tcreated_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tExternalModelDefinition_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tExternalModelDefinition_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_createModelDefinition()

ModelDefinition_t * CompSBMLDocumentPlugin_createModelDefinition

(

CompSBMLDocumentPlugin_t *

csbmldp

)

_tCreates_t _ta_t _tnew_t _tModelDefinition_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tModelDefinition_t_t _tobject_t _tcreated_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tModelDefinition_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tModelDefinition_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

Examples

spec_example1.c.

CompSBMLDocumentPlugin_getExternalModelDefinition()

ExternalModelDefinition_t * CompSBMLDocumentPlugin_getExternalModelDefinition	(	CompSBMLDocumentPlugin_t *	csbmldp,
		unsigned int	n
	)

_tGet_t _tan_t _tExternalModelDefinition_t_t _tfrom_t _tthe_t _tCompSBMLDocumentPlugin_t_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_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 _tExternalModelDefinition_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tExternalModelDefinition_t_t _tin_t _tthe_t _tListOfExternalModelDefinitions_t _twithin_t _tthis_t _tCompSBMLDocumentPlugin_t. _tIf_t _tthe_t _tindex_t @_tp_t _tn_t _tis_t _tinvalid_t, @_tc_t _tNULL_t _tis_t _treturned_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_getExternalModelDefinitionById()

ExternalModelDefinition_t * CompSBMLDocumentPlugin_getExternalModelDefinitionById	(	CompSBMLDocumentPlugin_t *	csbmldp,
		const char *	sid
	)

_tGet_t _tan_t _tExternalModelDefinition_t_t _tfrom_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_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 _tExternalModelDefinition_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tExternalModelDefinition_t_t _tin_t _tthe_t _tListOfExternalModelDefinitions_t _twithin_t _tthis_t _tCompSBMLDocumentPlugin_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tExternalModelDefinition_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_getListOfExternalModelDefinitions()

ListOfExternalModelDefinitions_t * CompSBMLDocumentPlugin_getListOfExternalModelDefinitions

(

CompSBMLDocumentPlugin_t *

csbmldp

)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tExternalModelDefinition_t_t _tobjects_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tstructure_t _twhose_t _tListOfExternalModelDefinitions_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfExternalModelDefinitions_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tCompSBMLDocumentPlugin_addExternalModelDefinition_t() @_tsee_t _tCompSBMLDocumentPlugin_createExternalModelDefinition_t() @_tsee_t _tCompSBMLDocumentPlugin_getExternalModelDefinitionById_t() @_tsee_t _tCompSBMLDocumentPlugin_getExternalModelDefinition_t() @_tsee_t _tCompSBMLDocumentPlugin_getNumExternalModelDefinitions_t() @_tsee_t _tCompSBMLDocumentPlugin_removeExternalModelDefinitionById_t() @_tsee_t _tCompSBMLDocumentPlugin_removeExternalModelDefinition_t()

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_getListOfModelDefinitions()

ListOfModelDefinitions_t * CompSBMLDocumentPlugin_getListOfModelDefinitions

(

CompSBMLDocumentPlugin_t *

csbmldp

)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tModelDefinition_t_t _tobjects_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tstructure_t _twhose_t _tListOfModelDefinitions_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfModelDefinitions_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tCompSBMLDocumentPlugin_addModelDefinition_t() @_tsee_t _tCompSBMLDocumentPlugin_createModelDefinition_t() @_tsee_t _tCompSBMLDocumentPlugin_getModelDefinitionById_t() @_tsee_t _tCompSBMLDocumentPlugin_getModelDefinition_t() @_tsee_t _tCompSBMLDocumentPlugin_getNumModelDefinitions_t() @_tsee_t _tCompSBMLDocumentPlugin_removeModelDefinitionById_t() @_tsee_t _tCompSBMLDocumentPlugin_removeModelDefinition_t()

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_getModelDefinition()

ModelDefinition_t * CompSBMLDocumentPlugin_getModelDefinition	(	CompSBMLDocumentPlugin_t *	csbmldp,
		unsigned int	n
	)

_tGet_t _ta_t _tModelDefinition_t_t _tfrom_t _tthe_t _tCompSBMLDocumentPlugin_t_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_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 _tModelDefinition_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tModelDefinition_t_t _tin_t _tthe_t _tListOfModelDefinitions_t _twithin_t _tthis_t _tCompSBMLDocumentPlugin_t. _tIf_t _tthe_t _tindex_t @_tp_t _tn_t _tis_t _tinvalid_t, @_tc_t _tNULL_t _tis_t _treturned_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_getNumExternalModelDefinitions()

unsigned int CompSBMLDocumentPlugin_getNumExternalModelDefinitions

(

CompSBMLDocumentPlugin_t *

csbmldp

)

_tGet_t _tthe_t _tnumber_t _tof_t _tExternalModelDefinition_t_t _tobjects_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tExternalModelDefinition_t_t _tobjects_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_getNumModelDefinitions()

unsigned int CompSBMLDocumentPlugin_getNumModelDefinitions

(

CompSBMLDocumentPlugin_t *

csbmldp

)

_tGet_t _tthe_t _tnumber_t _tof_t _tModelDefinition_t_t _tobjects_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tModelDefinition_t_t _tobjects_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_removeExternalModelDefinition()

ExternalModelDefinition_t * CompSBMLDocumentPlugin_removeExternalModelDefinition	(	CompSBMLDocumentPlugin_t *	csbmldp,
		unsigned int	n
	)

_tRemoves_t _tthe_t _tnth_t _tExternalModelDefinition_t_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_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 _tExternalModelDefinition_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tExternalModelDefinition_t_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_removeExternalModelDefinitionById()

ExternalModelDefinition_t * CompSBMLDocumentPlugin_removeExternalModelDefinitionById	(	CompSBMLDocumentPlugin_t *	csbmldp,
		const char *	sid
	)

_tRemoves_t _tthe_t _tExternalModelDefinition_t_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_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 _tExternalModelDefinition_t_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tExternalModelDefinition_t_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tExternalModelDefinition_t_t _texists_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t

CompSBMLDocumentPlugin_removeModelDefinition()

ModelDefinition_t * CompSBMLDocumentPlugin_removeModelDefinition	(	CompSBMLDocumentPlugin_t *	csbmldp,
		unsigned int	n
	)

_tRemoves_t _tthe_t _tnth_t _tModelDefinition_t_t _tfrom_t _tthis_t _tCompSBMLDocumentPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tcsbmldp_t _tthe_t _tCompSBMLDocumentPlugin_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 _tModelDefinition_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tModelDefinition_t_t _tin_t _tthis_t _tCompSBMLDocumentPlugin_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tCompSBMLDocumentPlugin_t_t