libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
CVTerm.cpp File Reference

CVTerm_t I/O. More...

Include dependency graph for CVTerm.cpp:

Functions

BiolQualifierType_t BiolQualifierType_fromString (const char *s)
 _tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tand_t _treturns_t _ta_t _tbiol_t _tqualifier_t _trepresenting_t _tthe_t _tstring_t.
 
const char * BiolQualifierType_toString (BiolQualifierType_t type)
 _tThis_t _tmethod_t _ttakes_t _ta_t _tbiol_t _tqualifier_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.
 
int CVTerm_addNestedCVTerm (CVTerm_t *cvt, const CVTerm_t *term)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tto_t _tthe_t _tlist_t _tof_t _tnested_t _tCVTerm_t_t'_ts_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.
 
int CVTerm_addResource (CVTerm_t *term, const char *resource)
 _tAdds_t _ta_t _tresource_t _tto_t _tthe_t _tCVTerm_t_t.
 
CVTerm_tCVTerm_clone (const CVTerm_t *c)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t
 
CVTerm_tCVTerm_createFromNode (const XMLNode_t *node)
 _tCreate_t _ta_t _tnew_t _tCVTerm_t_t _tfrom_t _tthe_t _tgiven_t #_tXMLNode_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
CVTerm_tCVTerm_createWithQualifierType (QualifierType_t type)
 @_tendcond_t
 
void CVTerm_free (CVTerm_t *term)
 _tFrees_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t.
 
BiolQualifierType_t CVTerm_getBiologicalQualifierType (CVTerm_t *term)
 _tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t #_tBiolQualifierType_t_t.
 
const List_tCVTerm_getListNestedCVTerms (const CVTerm_t *cvt)
 _tReturns_t _ta_t _tlist_t _tof_t _tCVTerm_t_t _tstructures_t _tcontained_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.
 
ModelQualifierType_t CVTerm_getModelQualifierType (CVTerm_t *term)
 _tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t #_tModelQualifierType_t_t _ttype_t.
 
const CVTerm_tCVTerm_getNestedCVTerm (const CVTerm_t *cvt, unsigned int n)
 _tReturns_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tCVTerm_t_t _tstructure_t.
 
unsigned int CVTerm_getNumNestedCVTerms (const CVTerm_t *cvt)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tCVTerm_t_t _tstructures_t _tnested_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.
 
unsigned int CVTerm_getNumResources (CVTerm_t *term)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tresources_t _tfor_t _tthis_t CVTerm_t_t.
 
QualifierType_t CVTerm_getQualifierType (CVTerm_t *term)
 _tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tits_t #_tQualifierType_t_t _ttype_t.
 
XMLAttributes_tCVTerm_getResources (CVTerm_t *term)
 _tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tresources_t.
 
char * CVTerm_getResourceURI (CVTerm_t *cv, unsigned int n)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t _tnth_t _tresource_t _tfor_t _tthis_t CVTerm_t_t.
 
int CVTerm_hasRequiredAttributes (CVTerm_t *cvt)
 _tChecks_t _tif_t _tthe_t _tCVTerm_t_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t.
 
CVTerm_tCVTerm_removeNestedCVTerm (CVTerm_t *cvt, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int CVTerm_removeResource (CVTerm_t *term, const char *resource)
 _tRemoves_t _ta_t _tresource_t _tfrom_t _tthe_t _tCVTerm_t_t.
 
int CVTerm_setBiologicalQualifierType (CVTerm_t *term, BiolQualifierType_t type)
 _tSets_t _tthe_t #_tBiolQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
int CVTerm_setBiologicalQualifierTypeByString (CVTerm_t *term, const char *qualifier)
 _tSets_t _tthe_t #_tBiolQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
int CVTerm_setModelQualifierType (CVTerm_t *term, ModelQualifierType_t type)
 _tSets_t _tthe_t #_tModelQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
int CVTerm_setModelQualifierTypeByString (CVTerm_t *term, const char *qualifier)
 _tSets_t _tthe_t #_tModelQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
int CVTerm_setQualifierType (CVTerm_t *term, QualifierType_t type)
 _tSets_t _tthe_t #_tQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
ModelQualifierType_t ModelQualifierType_fromString (const char *s)
 _tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tand_t _treturns_t _ta_t _tmodel_t _tqualifier_t _trepresenting_t _tthe_t _tstring_t.
 
const char * ModelQualifierType_toString (ModelQualifierType_t type)
 _tThis_t _tmethod_t _ttakes_t _ta_t _tmodel_t _tqualifier_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.
 

Variables

static const char * BIOL_QUALIFIER_STRINGS []
 
static const char * MODEL_QUALIFIER_STRINGS []
 

Detailed Description

CVTerm_t I/O.

Author
Sarah Keating

Copyright (C) 2019 jointly by the following organizations: 1. California Institute of Technology, Pasadena, CA, USA 2. University of Heidelberg, Heidelberg, Germany

Copyright (C) 2013-2018 jointly by the following organizations: 1. California Institute of Technology, Pasadena, CA, USA 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK 3. University of Heidelberg, Heidelberg, Germany

Copyright (C) 2009-2013 jointly by the following organizations: 1. California Institute of Technology, Pasadena, CA, USA 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK

Copyright (C) 2006-2008 by the California Institute of Technology, Pasadena, CA, USA

Copyright (C) 2002-2005 jointly by the following organizations: 1. California Institute of Technology, Pasadena, CA, USA 2. Japan Science and Technology Agency, Japan

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation. A copy of the license agreement is provided in the file named "LICENSE.txt" included with this software distribution. It is also available online at http://sbml.org/software/libsbml/license.html

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Function Documentation

◆ BiolQualifierType_fromString()

BiolQualifierType_t BiolQualifierType_fromString ( const char *  s)

_tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tand_t _treturns_t _ta_t _tbiol_t _tqualifier_t _trepresenting_t _tthe_t _tstring_t.

_tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tas_t _targument_t _tand_t _treturns_t _ta_t _tbiol_t _tqualifier_t _ttype_t _tcorresponding_t _tto_t _tthat_t _tstring_t. _tFor_t _texample_t, _tpassing_t _tit_t _tthe_t _tstring_t <_tcode_t>"_thasVersion_t"</_tcode_t> _twill_t _treturn_t _tthe_t _tqualifier_t @_tsbmlconstant_t{_tBQB_HAS_VERSION_t, _tBiolQualifierType_t_t}.

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _ttranslate_t _tto_t _ta_t @_tif_t _tclike_t #_tBiolQualifierType_t_t _tvalue_t@_telse_t _tlibSBML_t _tconstant_t _tvalue_t _trepresenting_t _ta_t _tbiological_t _tqualifier_t@_tendif_t.

@_treturn_t _ta_t _tlibSBML_t _tqualifier_t _tenumeration_t _tvalue_t _tfor_t _tthe_t _tgiven_t _thuman_t _treadable_t _tqualifier_t _tname_t.

@_tif_t _tconly_t @_tmemberof_t _tCVTerm_t_t @_tendif_t

◆ BiolQualifierType_toString()

const char * BiolQualifierType_toString ( BiolQualifierType_t  type)

_tThis_t _tmethod_t _ttakes_t _ta_t _tbiol_t _tqualifier_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.

_tThis_t _tmethod_t _ttakes_t _ta_t _tbiol_t _tqualifier_t _ttype_t _tas_t _targument_t _tand_t _treturns_t _ta_t _tstring_t _tname_t _tcorresponding_t _tto_t _tthat_t _tcode_t. _tFor_t _texample_t, _tpassing_t _tit_t _tthe_t _tqualifier_t @_tsbmlconstant_t{_tBQB_HAS_VERSION_t, _tBiolQualifierType_t_t} _twill_t _treturn_t _tthe_t _tstring_t <_tcode_t>"_thasVersion_t"</_tcode_t>.

@_tparam_t _ttype_t _tthe_t @_tif_t _tclike_t #_tBiolQualifierType_t_t@_tendif_t _tvalue_t _tto_t _ttranslate_t. @_tifnot_t _tclike_t _tThe_t _tvalue_t _tshould_t _tbe_t _ta_t _tconstant_t _twhose_t _tname_t _tbegins_t _twith_t @_tc_t _tBQB__t, _tsuch_t _tas_t (_tfor_t _texample_t) @_tsbmlconstant_t{_tBQB_IS_t, _tBiolQualifierType_t_t}.@_tendif_t

@_treturn_t _ta_t _thuman_t _treadable_t _tqualifier_t _tname_t _tfor_t _tthe_t _tgiven_t _ttype_t.

@_tnote_t _tThe_t _tcaller_t _tdoes_t _tnot_t _town_t _tthe_t _treturned_t _tstring_t _tand_t _tis_t _ttherefore_t _tnot_t _tallowed_t _tto_t _tmodify_t _tit_t.

@_tif_t _tconly_t @_tmemberof_t _tCVTerm_t_t @_tendif_t

◆ CVTerm_addNestedCVTerm()

int CVTerm_addNestedCVTerm ( CVTerm_t cvt,
const CVTerm_t term 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tto_t _tthe_t _tlist_t _tof_t _tnested_t _tCVTerm_t_t'_ts_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tadd_t _tthe_t _tCVTerm_t_t _tto_t. @_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tto_t _tassign_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 _tCVTerm_t_t

◆ CVTerm_addResource()

int CVTerm_addResource ( CVTerm_t term,
const char *  resource 
)

_tAdds_t _ta_t _tresource_t _tto_t _tthe_t _tCVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tresource_t _tstring_t _trepresenting_t _tthe_t _tresource_t _te_t._tg_t. _thttp_t://_twww_t._tgeneontology_t._torg_t/#_tGO_t:_t0005892_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}

@_tnote_t _tthis_t _tmethod_t _tadds_t _tthe_t _tname_t "_trdf_t:_tresource_t" _tto_t _tthe_t _tattribute_t _tprior_t _tto_t _tadding_t _tit_t _tto_t _tthe_t _tresources_t _tin_t _tthis_t _tCVTerm_t_t.

@_tmemberof_t _tCVTerm_t_t

Examples
addCVTerms.c, addingEvidenceCodes_1.c, and addingEvidenceCodes_2.c.

◆ CVTerm_clone()

CVTerm_t * CVTerm_clone ( const CVTerm_t term)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

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

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_createFromNode()

CVTerm_t * CVTerm_createFromNode ( const XMLNode_t node)

_tCreate_t _ta_t _tnew_t _tCVTerm_t_t _tfrom_t _tthe_t _tgiven_t #_tXMLNode_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

_tRDFAnnotations_t _twithin_t _ta_t _tmodel_t _tare_t _tstored_t _tas_t _ta_t _tList_t_t _tof_t _tCVTerm_t_t'_ts_t. _tThis_t _tallows_t _tthe_t _tuser_t _tto_t _tinteract_t _twith_t _tthe_t _tCVTerm_t_t'_ts_t _tdirectly_t. _tWhen_t _tLibSBML_t _treads_t _tin_t _ta_t _tmodel_t _tcontaining_t _tRDFAnnotations_t _tit_t _tparses_t _tthem_t _tinto_t _ta_t List_t _tof_t _tCVTerm_t_t'_ts_t _tand_t _twhen_t _twriting_t _ta_t _tmodel_t _tit_t _tparses_t _tthe_t _tCVTerm_t_t'_ts_t _tinto_t _tthe_t _tappropriate_t _tannotation_t _tstructure_t. _tThis_t _tfunction_t _tcreates_t _ta_t _tCVTerm_t_t _tfrom_t _tthe_t #_tXMLNode_t_t _tsupplied_t.

@_tparam_t _tnode_t _tan_t #_tXMLNode_t_t _trepresenting_t _ta_t _tCVTerm_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tCVTerm_t_t _tstructure_t.

@_tnote_t _tthis_t _tmethod_t _tassumes_t _tthat_t _tthe_t #_tXMLNode_t_t _tis_t _tof_t _tthe_t _tcorrect_t _tform_t

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_createWithQualifierType()

CVTerm_t * CVTerm_createWithQualifierType ( QualifierType_t  type)

@_tendcond_t

_tCreates_t _ta_t _tnew_t _tCVTerm_t_t _twith_t _tthe_t _tgiven_t #_tQualifierType_t_t _tvalue_t @_tp_t _ttype_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tcond_t _tdoxygenIgnored_t

Examples
addCVTerms.c, addingEvidenceCodes_1.c, and addingEvidenceCodes_2.c.

◆ CVTerm_free()

void CVTerm_free ( CVTerm_t c)

_tFrees_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tCVTerm_t_t

Examples
addCVTerms.c, addingEvidenceCodes_1.c, and addingEvidenceCodes_2.c.

◆ CVTerm_getBiologicalQualifierType()

BiolQualifierType_t CVTerm_getBiologicalQualifierType ( CVTerm_t term)

_tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t #_tBiolQualifierType_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t #_tBiolQualifierType_t_t _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t #_tBiolQualifierType_t_t _tvalue_t _tof_t _tthis_t _tCVTerm_t_t _tor_t @_tsbmlconstant_t{_tBQB_UNKNOWN_t, _tBiolQualifierType_t_t} (_tdefault_t).

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getListNestedCVTerms()

const List_t * CVTerm_getListNestedCVTerms ( const CVTerm_t cvt)

_tReturns_t _ta_t _tlist_t _tof_t _tCVTerm_t_t _tstructures_t _tcontained_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tgetListNestedCVTerms_t _tfrom_t.

@_treturn_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tfor_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getModelQualifierType()

ModelQualifierType_t CVTerm_getModelQualifierType ( CVTerm_t term)

_tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t #_tModelQualifierType_t_t _ttype_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t #_tModelQualifierType_t_t _tis_t _tsought_t.

@_treturn_t _tthe_t #_tModelQualifierType_t_t _tvalue_t _tof_t _tthis_t _tCVTerm_t_t _tor_t @_tsbmlconstant_t{_tBQM_UNKNOWN_t, _tModelQualifierType_t_t} (_tdefault_t).

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getNestedCVTerm()

const CVTerm_t * CVTerm_getNestedCVTerm ( const CVTerm_t cvt,
unsigned int  n 
)

_tReturns_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tget_t _tCVTerm_t_t'_ts_t _tfrom_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tCVTerm_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tfor_t _tthis_t _tCVTerm_t_t _tstructure_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getNumNestedCVTerms()

unsigned int CVTerm_getNumNestedCVTerms ( const CVTerm_t cvt)

_tReturns_t _tthe_t _tnumber_t _tof_t _tCVTerm_t_t _tstructures_t _tnested_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tget_t _tthe_t _tnumber_t _tof_t _tnested_t _tCVTerms_t _tfrom_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tCVTerm_t_t _tstructures_t _tnested_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tnote_t _tthis_t _tdoes_t _tnot_t _trecurse_t _tthrough_t _tpotentially_t _tnested_t _tCVTerm_t _tobjects_t _twithin_t _ta_t _tgiven_t _tnested_t _tCVTerm_t. _tIt_t _treturns_t _tthe_t _tnumber_t _tof_t _tterms_t _timmediately_t _tnested_t _twithin_t _tthis_t _tCVTerm_t_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getNumResources()

unsigned int CVTerm_getNumResources ( CVTerm_t term)

_tReturns_t _tthe_t _tnumber_t _tof_t _tresources_t _tfor_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t _tresources_t _tare_t _tsought_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tresources_t _tin_t _tthe_t _tset_t _tof_t _tXMLAttributes_t _tof_t _tthis_t CVTerm_t_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getQualifierType()

QualifierType_t CVTerm_getQualifierType ( CVTerm_t term)

_tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tits_t #_tQualifierType_t_t _ttype_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t #_tQualifierType_t_t _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t #_tQualifierType_t_t _tvalue_t _tof_t _tthis_t _tCVTerm_t_t _tor_t @_tsbmlconstant_t{_tUNKNOWN_QUALIFIER_t, _tQualifierType_t_t} (_tdefault_t).

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getResources()

XMLAttributes_t * CVTerm_getResources ( CVTerm_t term)

_tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tresources_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t _tresources_t _tare_t _tsought_t.

@_treturn_t _tthe_t _tXMLAttributes_t_t _tthat_t _tstore_t _tthe_t _tresources_t _tof_t _tthis_t _tCVTerm_t_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getResourceURI()

char * CVTerm_getResourceURI ( CVTerm_t term,
unsigned int  n 
)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t _tnth_t _tresource_t _tfor_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _tresource_t _tto_t _tquery_t.

@_treturn_t _tstring_t _trepresenting_t _tthe_t _tvalue_t _tof_t _tthe_t _tnth_t _tresource_t _tin_t _tthe_t _tset_t _tof_t _tXMLAttributes_t _tof_t _tthis_t CVTerm_t_t.

@_tnote_t _tSince_t _tthe_t _tvalues_t _tof_t _tthe_t _tresource_t _tattributes_t _tin_t _ta_t _tCVTerm_t_t _tare_t _tURIs_t _tthis_t _tis_t _ta_t _tconvenience_t _tfunction_t _tto_t _tfacilitate_t _tinteraction_t _twith_t _tthe_t _tCVTerm_t_t _tstructure_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_hasRequiredAttributes()

int CVTerm_hasRequiredAttributes ( CVTerm_t term)

_tChecks_t _tif_t _tthe_t _tCVTerm_t_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t.

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

◆ CVTerm_removeNestedCVTerm()

CVTerm_t * CVTerm_removeNestedCVTerm ( CVTerm_t cvt,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tget_t _tCVTerm_t_t'_ts_t _tfrom_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tCVTerm_t_t _tto_t _tretrieve_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tfor_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_removeResource()

int CVTerm_removeResource ( CVTerm_t term,
const char *  resource 
)

_tRemoves_t _ta_t _tresource_t _tfrom_t _tthe_t _tCVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t. @_tparam_t _tresource_t _tstring_t _trepresenting_t _tthe_t _tresource_t _te_t._tg_t. _thttp_t://_twww_t._tgeneontology_t._torg_t/#_tGO_t:_t0005892_t

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INDEX_EXCEEDS_SIZE_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 _tCVTerm_t_t

◆ CVTerm_setBiologicalQualifierType()

int CVTerm_setBiologicalQualifierType ( CVTerm_t term,
BiolQualifierType_t  type 
)

_tSets_t _tthe_t #_tBiolQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttype_t _tthe_t #_tBiolQualifierType_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_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tif_t _tthe_t #_tQualifierType_t_t _tfor_t _tthis_t _tstructure_t _tis_t _tnot_t @_tsbmlconstant_t{_tBIOLOGICAL_QUALIFIER_t, _tQualifierType_t_t} _tthen_t _tthe_t #_tBiolQualifierType_t_t _twill_t _tdefault_t _tto_t @_tsbmlconstant_t{_tBQB_UNKNOWN_t, _tBiolQualifierType_t_t}.

@_tmemberof_t _tCVTerm_t_t

Examples
addCVTerms.c, addingEvidenceCodes_1.c, and addingEvidenceCodes_2.c.

◆ CVTerm_setBiologicalQualifierTypeByString()

int CVTerm_setBiologicalQualifierTypeByString ( CVTerm_t term,
const char *  qualifier 
)

_tSets_t _tthe_t #_tBiolQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tqualifier_t _tthe_t _tstring_t _trepresenting_t _ta_t _tbiol_t _tqualifier_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}

@_tnote_t _tif_t _tthe_t #_tQualifierType_t_t _tfor_t _tthis_t _tstructure_t _tis_t _tnot_t @_tsbmlconstant_t{_tBIOLOGICAL_QUALIFIER_t, _tQualifierType_t_t} _tthen_t _tthe_t #_tBiolQualifierType_t_t _twill_t _tdefault_t _tto_t @_tsbmlconstant_t{_tBQB_UNKNOWN_t, _tBiolQualifierType_t_t}.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_setModelQualifierType()

int CVTerm_setModelQualifierType ( CVTerm_t term,
ModelQualifierType_t  type 
)

_tSets_t _tthe_t #_tModelQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttype_t _tthe_t #_tModelQualifierType_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_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tif_t _tthe_t #_tQualifierType_t_t _tfor_t _tthis_t _tstructure_t _tis_t _tnot_t @_tsbmlconstant_t{_tMODEL_QUALIFIER_t, _tQualifierType_t_t} _tthen_t _tthe_t #_tModelQualifierType_t_t _twill_t _tdefault_t _tto_t @_tsbmlconstant_t{_tBQM_UNKNOWN_t, _tModelQualifierType_t_t}.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_setModelQualifierTypeByString()

int CVTerm_setModelQualifierTypeByString ( CVTerm_t term,
const char *  qualifier 
)

_tSets_t _tthe_t #_tModelQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tqualifier_t _tthe_t _tstring_t _trepresenting_t _ta_t _tmodel_t _tqualifier_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}

@_tnote_t _tif_t _tthe_t #_tQualifierType_t_t _tfor_t _tthis_t _tstructure_t _tis_t _tnot_t @_tsbmlconstant_t{_tMODEL_QUALIFIER_t, _tQualifierType_t_t} _tthen_t _tthe_t #_tModelQualifierType_t_t _twill_t _tdefault_t _tto_t @_tsbmlconstant_t{_tBQM_UNKNOWN_t, _tModelQualifierType_t_t}.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_setQualifierType()

int CVTerm_setQualifierType ( CVTerm_t term,
QualifierType_t  type 
)

_tSets_t _tthe_t #_tQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttype_t _tthe_t _tQualifierType_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 _tCVTerm_t_t

◆ ModelQualifierType_fromString()

ModelQualifierType_t ModelQualifierType_fromString ( const char *  s)

_tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tand_t _treturns_t _ta_t _tmodel_t _tqualifier_t _trepresenting_t _tthe_t _tstring_t.

_tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tas_t _targument_t _tand_t _treturns_t _ta_t _tmodel_t _tqualifier_t _ttype_t _tcorresponding_t _tto_t _tthat_t _tstring_t. _tFor_t _texample_t, _tpassing_t _tit_t _tthe_t _tstring_t <_tcode_t>"_tisDescribedBy_t"</_tcode_t> _twill_t _treturn_t _tthe_t _tqualifier_t @_tsbmlconstant_t{_tBQM_IS_DESCRIBED_BY_t, _tModelQualifierType_t_t}.

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _ttranslate_t _tto_t _ta_t @_tif_t _tclike_t #_tModelQualifierType_t_t _tvalue_t@_telse_t _tlibSBML_t _tconstant_t _tvalue_t _trepresenting_t _ta_t _tmodel_t _tqualifier_t@_tendif_t.

@_treturn_t _ta_t _tlibSBML_t _tqualifier_t _tenumeration_t _tvalue_t _tfor_t _tthe_t _tgiven_t _thuman_t _treadable_t _tqualifier_t _tname_t.

@_tif_t _tconly_t @_tmemberof_t _tCVTerm_t_t @_tendif_t

◆ ModelQualifierType_toString()

const char * ModelQualifierType_toString ( ModelQualifierType_t  type)

_tThis_t _tmethod_t _ttakes_t _ta_t _tmodel_t _tqualifier_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.

_tThis_t _tmethod_t _ttakes_t _ta_t _tmodel_t _tqualifier_t _ttype_t _tas_t _targument_t _tand_t _treturns_t _ta_t _tstring_t _tname_t _tcorresponding_t _tto_t _tthat_t _tcode_t. _tFor_t _texample_t, _tpassing_t _tit_t _tthe_t _tqualifier_t @_tsbmlconstant_t{_tBQM_IS_DESCRIBED_BY_t, _tModelQualifierType_t_t} _twill_t _treturn_t _tthe_t _tstring_t <_tcode_t>"_tisDescribedBy_t"</_tcode_t>.

@_tparam_t _ttype_t _tthe_t @_tif_t _tclike_t _tModelQualifierType_t_t@_tendif_t _tvalue_t _tto_t _ttranslate_t. @_tifnot_t _tclike_t _tThe_t _tvalue_t _tshould_t _tbe_t _ta_t _tlibSBML_t _tconstant_t _twhose_t _tname_t _tbegins_t _twith_t @_tc_t _tBQM__t, _tsuch_t _tas_t (_tfor_t _texample_t) @_tsbmlconstant_t{_tBQM_IS_t, _tBiolQualifierType_t_t}.@_tendif_t

@_treturn_t _ta_t _thuman_t _treadable_t _tqualifier_t _tname_t _tfor_t _tthe_t _tgiven_t _tqualifier_t _ttype_t.

@_tnote_t _tThe_t _tcaller_t _tdoes_t _tnot_t _town_t _tthe_t _treturned_t _tstring_t _tand_t _tis_t _ttherefore_t _tnot_t _tallowed_t _tto_t _tmodify_t _tit_t.

@_tif_t _tconly_t @_tmemberof_t _tCVTerm_t_t @_tendif_t

Variable Documentation

◆ BIOL_QUALIFIER_STRINGS

const char* BIOL_QUALIFIER_STRINGS[]
static
Initial value:
=
{
"is"
, "hasPart"
, "isPartOf"
, "isVersionOf"
, "hasVersion"
, "isHomologTo"
, "isDescribedBy"
, "isEncodedBy"
, "encodes"
, "occursIn"
, "hasProperty"
, "isPropertyOf"
, "hasTaxon"
}

◆ MODEL_QUALIFIER_STRINGS

const char* MODEL_QUALIFIER_STRINGS[]
static
Initial value:
=
{
"is"
, "isDescribedBy"
, "isDerivedFrom"
, "isInstanceOf"
, "hasInstance"
}