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

ModelHistory_t I/O. More...

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

Functions

int ModelHistory_addCreator (ModelHistory_t *mh, ModelCreator_t *mc)
 _tAdds_t _ta_t _tcopy_t _tof_t _ta_t _tModelCreator_t_t _tstructure_t _tto_t _tthe_t _tModelHistory_t_t _tstructure_t.
 
int ModelHistory_addModifiedDate (ModelHistory_t *mh, Date_t *date)
 _tAdds_t _ta_t _tcopy_t _tof_t _ta_t _tDate_t_t _tstructure_t _tto_t _tthe_t _tlist_t _tof_t _tmodifiedDates_t _tin_t _tthe_t _tModelHistory_t_t _tstructure_t.
 
ModelHistory_tModelHistory_clone (const ModelHistory_t *mh)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tModelHistory_t_t _tstructure_t
 
ModelHistory_tModelHistory_create ()
 _tCreates_t _ta_t _tnew_t _tModelHistory_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
void ModelHistory_free (ModelHistory_t *mh)
 _tDestroys_t _tthis_t _tModelHistory_t_t.
 
Date_tModelHistory_getCreatedDate (ModelHistory_t *mh)
 _tReturns_t _tthe_t _tcreatedDate_t _tfrom_t _tthe_t _tModelHistory_t_t.
 
ModelCreator_tModelHistory_getCreator (ModelHistory_t *mh, unsigned int n)
 _tGet_t _tthe_t _tnth_t _tModelCreator_t_t _tstructure_t _tin_t _tthis_t _tModelHistory_t_t.
 
List_tModelHistory_getListCreators (ModelHistory_t *mh)
 _tGet_t _tthe_t _tList_t_t _tof_t _tModelCreator_t_t _tstructures_t _tin_t _tthis_t _tModelHistory_t.
 
List_tModelHistory_getListModifiedDates (ModelHistory_t *mh)
 _tGet_t _tthe_t _tList_t_t _tof_t _tDate_t_t _tstructures_t _tin_t _tthe_t _tlist_t _tof_t _tModifiedDates_t _tin_t _tthis_t _tModelHistory_t_t.
 
Date_tModelHistory_getModifiedDate (ModelHistory_t *mh)
 _tReturns_t _tthe_t _tmodifiedDate_t _tfrom_t _tthe_t _tModelHistory_t_t.
 
Date_tModelHistory_getModifiedDateFromList (ModelHistory_t *mh, unsigned int n)
 _tGet_t _tthe_t _tnth_t _tDate_t_t _tstructure_t _tin_t _tthe_t _tlist_t _tof_t _tModifiedDates_t _tin_t _tthis_t _tModelHistory_t_t.
 
unsigned int ModelHistory_getNumCreators (ModelHistory_t *mh)
 _tGet_t _tthe_t _tnumber_t _tof_t _tModelCreator_t_t _tstructures_t _tin_t _tthis_t _tModelHistory_t.
 
unsigned int ModelHistory_getNumModifiedDates (ModelHistory_t *mh)
 _tGet_t _tthe_t _tnumber_t _tof_t _tmodified_t _tDate_t_t _tstructures_t _tin_t _tthe_t _tlist_t _tof_t _tModifiedDates_t _tin_t _tthis_t _tModelHistory_t_t.
 
int ModelHistory_hasRequiredAttributes (ModelHistory_t *mh)
 _tChecks_t _tif_t _tthe_t _tmodel_t _thistory_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t.
 
int ModelHistory_isSetCreatedDate (ModelHistory_t *mh)
 _tPredicate_t _tindicating_t _twhether_t _tthis_t _tModelHistory_t_t'_ts_t _tcreatedDate_t _tis_t _tset_t.
 
int ModelHistory_isSetModifiedDate (ModelHistory_t *mh)
 _tPredicate_t _tindicating_t _twhether_t _tthis_t _tModelHistory_t_t'_ts_t _tmodifiedDate_t _tis_t _tset_t.
 
int ModelHistory_setCreatedDate (ModelHistory_t *mh, Date_t *date)
 _tSets_t _tthe_t _tcreatedDate_t.
 
int ModelHistory_setModifiedDate (ModelHistory_t *mh, Date_t *date)
 _tSets_t _tthe_t _tmodifiedDate_t.
 

Detailed Description

ModelHistory_t I/O.

Author
Sarah Keating

Function Documentation

◆ ModelHistory_addCreator()

int ModelHistory_addCreator ( ModelHistory_t mh,
ModelCreator_t mc 
)

_tAdds_t _ta_t _tcopy_t _tof_t _ta_t _tModelCreator_t_t _tstructure_t _tto_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t. @_tparam_t _tmc_t _tthe_t _tModelCreator_t_t _tstructure_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_addModifiedDate()

int ModelHistory_addModifiedDate ( ModelHistory_t mh,
Date_t date 
)

_tAdds_t _ta_t _tcopy_t _tof_t _ta_t _tDate_t_t _tstructure_t _tto_t _tthe_t _tlist_t _tof_t _tmodifiedDates_t _tin_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t. @_tparam_t _tdate_t _tthe_t _tDate_t_t _tstructure_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_clone()

ModelHistory_t * ModelHistory_clone ( const ModelHistory_t mh)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tModelHistory_t_t _tstructure_t

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tModelHistory_t_t _tstructure_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_create()

ModelHistory_t * ModelHistory_create ( )

_tCreates_t _ta_t _tnew_t _tModelHistory_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_treturn_t _tpointer_t _tto_t _tnewly_t _tcreated_t _tModelHistory_t_t _tstructure_t.

@_tmemberof_t _tModelHistory_t_t

_tCreates_t _ta_t _tnew_t _tModelHistory_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tcond_t _tdoxygenIgnored_t

◆ ModelHistory_free()

void ModelHistory_free ( ModelHistory_t mh)

_tDestroys_t _tthis_t _tModelHistory_t_t.

@_tparam_t _tmh_t _tModelHistory_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_getCreatedDate()

Date_t * ModelHistory_getCreatedDate ( ModelHistory_t mh)

_tReturns_t _tthe_t _tcreatedDate_t _tfrom_t _tthe_t _tModelHistory_t_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_treturn_t _tDate_t_t _tstructure_t _trepresenting_t _tthe_t _tcreatedDate_t _tfrom_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_getCreator()

ModelCreator_t * ModelHistory_getCreator ( ModelHistory_t mh,
unsigned int  n 
)

_tGet_t _tthe_t _tnth_t _tModelCreator_t_t _tstructure_t _tin_t _tthis_t _tModelHistory_t_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t. @_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _tindicating_t _twhich_t _tModelCreator_t_t.

@_treturn_t _tthe_t _tnth_t _tModelCreator_t _tof_t _tthis_t _tModelHistory_t_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_getListCreators()

List_t * ModelHistory_getListCreators ( ModelHistory_t mh)

_tGet_t _tthe_t _tList_t_t _tof_t _tModelCreator_t_t _tstructures_t _tin_t _tthis_t _tModelHistory_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tList_t_t _tstructure_t _tof_t _tModelCreators_t _tfor_t _tthis_t _tModelHistory_t_t _tstructure_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_getListModifiedDates()

List_t * ModelHistory_getListModifiedDates ( ModelHistory_t mh)

_tGet_t _tthe_t _tList_t_t _tof_t _tDate_t_t _tstructures_t _tin_t _tthe_t _tlist_t _tof_t _tModifiedDates_t _tin_t _tthis_t _tModelHistory_t_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tList_t_t _tstructure_t _tof_t _tDates_t _tfor_t _tthis_t _tModelHistory_t_t _tstructure_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_getModifiedDate()

Date_t * ModelHistory_getModifiedDate ( ModelHistory_t mh)

_tReturns_t _tthe_t _tmodifiedDate_t _tfrom_t _tthe_t _tModelHistory_t_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_treturn_t _tDate_t_t _tstructure_t _trepresenting_t _tthe_t _tmodifiedDate_t _tfrom_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_getModifiedDateFromList()

Date_t * ModelHistory_getModifiedDateFromList ( ModelHistory_t mh,
unsigned int  n 
)

_tGet_t _tthe_t _tnth_t _tDate_t_t _tstructure_t _tin_t _tthe_t _tlist_t _tof_t _tModifiedDates_t _tin_t _tthis_t _tModelHistory_t_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t. @_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _tindicating_t _twhich_t _tDate_t_t.

@_treturn_t _tthe_t _tnth_t _tDate_t_t _tin_t _tthe_t _tlist_t _tof_t _tModifiedDates_t _tof_t _tthis_t _tModelHistory_t_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t.

@_tnote_t _tA_t _tbug_t _tin_t _tlibSBML_t _tmeant_t _tthat_t _toriginally_t _ta_t _tModelHistory_t_t _tstructure_t _tcontained_t _tonly_t _tone_t _tinstance_t _tof_t _ta_t _tDate_t_t. _tIn_t _tfact_t _tthe_t _tMIRIAM_t _tannotation_t _texpects_t _tzero_t _tor_t _tmore_t _tmodified_t _tdates_t _tand_t _tthus_t _tthe_t _timplementation_t _twas_t _tchanged_t. _tTo_t _tavoid_t _timpacting_t _texisting_t _tcode_t _tthere_t _tis_t _ta_t _tdistinction_t _tbetween_t _tthe_t _tfunction_t _tModelHistory_getModifiedDate_t() _twhich_t _trequires_t _tno_t _tindex_t _tvalue_t _tand_t _tthis_t _tfunction_t _tthat_t _tindexes_t _tinto_t _ta_t _tlist_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_getNumCreators()

unsigned int ModelHistory_getNumCreators ( ModelHistory_t mh)

_tGet_t _tthe_t _tnumber_t _tof_t _tModelCreator_t_t _tstructures_t _tin_t _tthis_t _tModelHistory_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tModelCreators_t _tin_t _tthis_t _tModelHistory_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_getNumModifiedDates()

unsigned int ModelHistory_getNumModifiedDates ( ModelHistory_t mh)

_tGet_t _tthe_t _tnumber_t _tof_t _tmodified_t _tDate_t_t _tstructures_t _tin_t _tthe_t _tlist_t _tof_t _tModifiedDates_t _tin_t _tthis_t _tModelHistory_t_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tDates_t _tin_t _tthe_t _tlist_t _tof_t _tModifiedDates_t _tin_t _tthis_t _tModelHistory_t_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_hasRequiredAttributes()

int ModelHistory_hasRequiredAttributes ( ModelHistory_t mh)

_tChecks_t _tif_t _tthe_t _tmodel_t _thistory_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tModelHistory_t_t _thas_t _tall_t _tthe_t _trequired_t _telements_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _twill_t _tbe_t _treturned_t, _tincluding_t _tif_t _tan_t _tinvalid_t _tCVTerm_t_t _twas_t _tprovided_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_isSetCreatedDate()

int ModelHistory_isSetCreatedDate ( ModelHistory_t mh)

_tPredicate_t _tindicating_t _twhether_t _tthis_t _tModelHistory_t_t'_ts_t _tcreatedDate_t _tis_t _tset_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t _tto_t _tbe_t _tqueried_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tcreatedDate_t _tof_t _tthis_t _tModelHistory_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_isSetModifiedDate()

int ModelHistory_isSetModifiedDate ( ModelHistory_t mh)

_tPredicate_t _tindicating_t _twhether_t _tthis_t _tModelHistory_t_t'_ts_t _tmodifiedDate_t _tis_t _tset_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t _tto_t _tbe_t _tqueried_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tmodifiedDate_t _tof_t _tthis_t _tModelHistory_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tModelHistory_t_t

◆ ModelHistory_setCreatedDate()

int ModelHistory_setCreatedDate ( ModelHistory_t mh,
Date_t date 
)

_tSets_t _tthe_t _tcreatedDate_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t. @_tparam_t _tdate_t _tthe_t _tDate_t_t _tstructure_t _trepresenting_t _tthe_t _tdate_t _tthe_t _tModelHistory_t_t _twas_t _tcreated_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 _tModelHistory_t_t

◆ ModelHistory_setModifiedDate()

int ModelHistory_setModifiedDate ( ModelHistory_t mh,
Date_t date 
)

_tSets_t _tthe_t _tmodifiedDate_t.

@_tparam_t _tmh_t _tthe_t _tModelHistory_t_t _tstructure_t. @_tparam_t _tdate_t _tthe_t _tDate_t_t _tstructure_t _trepresenting_t _tthe_t _tdate_t _tthe_t _tModelHistory_t_t _twas_t _tmodified_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tModelHistory_t_t