libSBML C++ API  5.18.0
CompSBMLError.h File Reference

Represents SBML errors and other diagnostics. More...

This graph shows which files directly or indirectly include this file:

Enumerations

enum  CompSBMLErrorCode_t {
  CompUnknown = 1010100,
  CompNSUndeclared = 1010101,
  CompElementNotInNs = 1010102,
  CompDuplicateComponentId = 1010301,
  CompUniqueModelIds = 1010302,
  CompUniquePortIds = 1010303,
  CompInvalidSIdSyntax = 1010304,
  CompInvalidSubmodelRefSyntax = 1010308,
  CompInvalidDeletionSyntax = 1010309,
  CompInvalidConversionFactorSyntax = 1010310,
  CompInvalidNameSyntax = 1010311,
  CompReplacedUnitsShouldMatch = 1010501,
  CompOneListOfReplacedElements = 1020101,
  CompLOReplaceElementsAllowedElements = 1020102,
  CompLOReplacedElementsAllowedAttribs = 1020103,
  CompEmptyLOReplacedElements = 1020104,
  CompOneReplacedByElement = 1020105,
  CompAttributeRequiredMissing = 1020201,
  CompAttributeRequiredMustBeBoolean = 1020202,
  CompRequiredTrueIfElementsRemain = 1020203,
  CompRequiredFalseIfAllElementsReplaced = 1020204,
  CompOneListOfModelDefinitions = 1020205,
  CompEmptyLOModelDefs = 1020206,
  CompLOModelDefsAllowedElements = 1020207,
  CompLOExtModelDefsAllowedElements = 1020208,
  CompLOModelDefsAllowedAttributes = 1020209,
  CompLOExtModDefsAllowedAttributes = 1020210,
  CompOneListOfExtModelDefinitions = 1020211,
  CompAttributeRequiredMustBeTrue = 1020212,
  CompExtModDefAllowedCoreAttributes = 1020301,
  CompExtModDefAllowedElements = 1020302,
  CompExtModDefAllowedAttributes = 1020303,
  CompReferenceMustBeL3 = 1020304,
  CompModReferenceMustIdOfModel = 1020305,
  CompExtModMd5DoesNotMatch = 1020306,
  CompInvalidSourceSyntax = 1020307,
  CompInvalidModelRefSyntax = 1020308,
  CompInvalidMD5Syntax = 1020309,
  CompCircularExternalModelReference = 1020310,
  CompOneListOfOnModel = 1020501,
  CompNoEmptyListOfOnModel = 1020502,
  CompLOSubmodelsAllowedElements = 1020503,
  CompLOPortsAllowedElements = 1020504,
  CompLOSubmodelsAllowedAttributes = 1020505,
  CompLOPortsAllowedAttributes = 1020506,
  CompSubmodelAllowedCoreAttributes = 1020601,
  CompSubmodelAllowedElements = 1020602,
  CompOneListOfDeletionOnSubmodel = 1020603,
  CompSubmodelNoEmptyLODeletions = 1020604,
  CompLODeletionsAllowedElements = 1020605,
  CompLODeletionAllowedAttributes = 1020606,
  CompSubmodelAllowedAttributes = 1020607,
  CompModReferenceSyntax = 1020608,
  CompInvalidTimeConvFactorSyntax = 1020613,
  CompInvalidExtentConvFactorSyntax = 1020614,
  CompSubmodelMustReferenceModel = 1020615,
  CompSubmodelCannotReferenceSelf = 1020616,
  CompModCannotCircularlyReferenceSelf = 1020617,
  CompTimeConversionMustBeParameter = 1020622,
  CompExtentConversionMustBeParameter = 1020623,
  CompPortRefMustReferencePort = 1020701,
  CompIdRefMustReferenceObject = 1020702,
  CompUnitRefMustReferenceUnitDef = 1020703,
  CompMetaIdRefMustReferenceObject = 1020704,
  CompParentOfSBRefChildMustBeSubmodel = 1020705,
  CompInvalidPortRefSyntax = 1020706,
  CompInvalidIdRefSyntax = 1020707,
  CompInvalidUnitRefSyntax = 1020708,
  CompInvalidMetaIdRefSyntax = 1020709,
  CompOneSBaseRefOnly = 1020710,
  CompDeprecatedSBaseRefSpelling = 1020711,
  CompSBaseRefMustReferenceObject = 1020712,
  CompSBaseRefMustReferenceOnlyOneObject = 1020713,
  CompNoMultipleReferences = 1020714,
  CompPortMustReferenceObject = 1020801,
  CompPortMustReferenceOnlyOneObject = 1020802,
  CompPortAllowedAttributes = 1020803,
  CompPortReferencesUnique = 1020804,
  CompDeletionMustReferenceObject = 1020901,
  CompDeletionMustReferOnlyOneObject = 1020902,
  CompDeletionAllowedAttributes = 1020903,
  CompReplacedElementMustRefObject = 1021001,
  CompReplacedElementMustRefOnlyOne = 1021002,
  CompReplacedElementAllowedAttributes = 1021003,
  CompReplacedElementSubModelRef = 1021004,
  CompReplacedElementDeletionRef = 1021005,
  CompReplacedElementConvFactorRef = 1021006,
  CompReplacedElementSameReference = 1021010,
  CompReplacedElementNoDelAndConvFact = 1021011,
  CompReplacedByMustRefObject = 1021101,
  CompReplacedByMustRefOnlyOne = 1021102,
  CompReplacedByAllowedAttributes = 1021103,
  CompReplacedBySubModelRef = 1021104,
  CompMustReplaceSameClass = 1021201,
  CompMustReplaceIDs = 1021202,
  CompMustReplaceMetaIDs = 1021203,
  CompMustReplacePackageIDs = 1021204,
  CompUnresolvedReference = 1090101,
  CompNoModelInReference = 1090102,
  CompExtModDefBad = 1090103,
  CompModelFlatteningFailed = 1090104,
  CompFlatModelNotValid = 1090105,
  CompLineNumbersUnreliable = 1090106,
  CompFlatteningNotRecognisedReqd = 1090107,
  CompFlatteningNotRecognisedNotReqd = 1090108,
  CompFlatteningNotImplementedNotReqd = 1090109,
  CompFlatteningNotImplementedReqd = 1090110,
  CompFlatteningWarning = 1090111,
  CompDeprecatedDeleteFunction = 1090112,
  CompDeprecatedReplaceFunction = 1090113,
  CompDeletedReplacement = 1090114,
  CompIdRefMayReferenceUnknownPackage = 1090115,
  CompMetaIdRefMayReferenceUnknownPkg = 1090116
}
 Codes for all SBML-level errors and warnings from the 'comp' package. More...
 

Detailed Description

Represents SBML errors and other diagnostics.

Author
Michael Hucka
Sarah Keating

Enumeration Type Documentation

Codes for all SBML-level errors and warnings from the 'comp' package.

These are distinguished from other SBML error codes by having a number between 1000000 and 1099999.

Calling programs may wish to check which enumeration a given SBMLError object's error identifier is actually from:
  • 0010000 to 0099999: SBMLErrorCode_t (a problem with the SBML core specification)
  • 1000000 to 1099999: CompSBMLErrorCode_t (a problem with the SBML Level 3 Hierarchical Model Composition package specification).
  • 2000000 to 2099999: FbcSBMLErrorCode_t (a problem with the SBML Level 3 Flux Balance Constraints package specification).
  • 3000000 to 3099999: QualSBMLErrorCode_t (a problem with the SBML Level 3 Qualitative Models package specification).
  • 6000000 to 6099999: LayoutSBMLErrorCode_t (a problem with the SBML Level 3 Layout package specification).
Other error code ranges are reserved for other packages.
Enumerator
CompUnknown 

Unknown error from comp

CompNSUndeclared 

The comp ns is not correctly declared

CompElementNotInNs 

Element not in comp namespace

CompDuplicateComponentId 

Duplicate 'id' attribute value

CompUniqueModelIds 

Model and ExternalModelDefinitions must have unique ids

CompUniquePortIds 

Ports must have unique ids

CompInvalidSIdSyntax 

Invalid SId syntax

CompInvalidSubmodelRefSyntax 

Invalid submodelRef syntax

CompInvalidDeletionSyntax 

Invalid deletion syntax

CompInvalidConversionFactorSyntax 

Invalid conversionFactor syntax

CompInvalidNameSyntax 

Invalid name syntax

CompReplacedUnitsShouldMatch 

Units of replaced elements should match replacement units.

CompOneListOfReplacedElements 

Only one <listOfReplacedElements> allowed.

CompLOReplaceElementsAllowedElements 

Allowed children of <listOfReplacedElements>

CompLOReplacedElementsAllowedAttribs 

Allowed <listOfReplacedElements> attributes

CompEmptyLOReplacedElements 

<listOfReplacedElements> must not be empty

CompOneReplacedByElement 

Only one <replacedBy> object allowed.

CompAttributeRequiredMissing 

Required comp:required attribute on <sbml>

CompAttributeRequiredMustBeBoolean 

The comp:required attribute must be Boolean

CompRequiredTrueIfElementsRemain 

The comp:required attribute must be 'true' if math changes. NOTE: Deprecated

CompRequiredFalseIfAllElementsReplaced 

The comp:required attribute must be 'false' if math does not change. NOTE: Deprecated

CompOneListOfModelDefinitions 

Only one <listOfModelDefinitions> allowed.

CompEmptyLOModelDefs 

<listOfModelDefinitions> and <listOfExternalModelDefinitions> must not be empty

CompLOModelDefsAllowedElements 

Only <modelDefinitions> in <listOfModelDefinitions>

CompLOExtModelDefsAllowedElements 

Only <externalModelDefinitions> in <listOfExternalModelDefinitions>

CompLOModelDefsAllowedAttributes 

Allowed <listOfModelDefinitions> attributes

CompLOExtModDefsAllowedAttributes 

Allowed <listOfExternalModelDefinitions> attributes

CompOneListOfExtModelDefinitions 

Only one <listOfExternalModelDefinitions> allowed.

CompAttributeRequiredMustBeTrue 

The comp:required attribute must be 'true'

CompExtModDefAllowedCoreAttributes 

Allowed <externalModelDefinitions> core attributes

CompExtModDefAllowedElements 

Allowed <externalModelDefinitions> elements

CompExtModDefAllowedAttributes 

Allowed <externalModelDefinitions> attributes

CompReferenceMustBeL3 

External models must be L3

CompModReferenceMustIdOfModel 

'modelRef' must be the 'id' of a model in the 'source' document

CompExtModMd5DoesNotMatch 

MD5 checksum does not match the 'source' document

CompInvalidSourceSyntax 

The 'comp:source' attribute must be of type 'anyURI'

CompInvalidModelRefSyntax 

The 'comp:modelRef' attribute must have the syntax of 'SId'

CompInvalidMD5Syntax 

The 'comp:md5' attribute must have the syntax of 'string'

CompCircularExternalModelReference 

Circular reference in <externalModelDefinition>

CompOneListOfOnModel 

Only one <listOfSubmodels> and one <listOfPorts> allowed

CompNoEmptyListOfOnModel 

No empty listOf elements allowed

CompLOSubmodelsAllowedElements 

Allowed elements on <listOfSubmodels>

CompLOPortsAllowedElements 

Allowed elements on <listOfPorts>

CompLOSubmodelsAllowedAttributes 

Allowed attributes on <listOfSubmodels>

CompLOPortsAllowedAttributes 

Allowed attributes on <listOfPorts>

CompSubmodelAllowedCoreAttributes 

Allowed core attributes on <submodel>

CompSubmodelAllowedElements 

Allowed elements on <submodel>

CompOneListOfDeletionOnSubmodel 

Only one <listOfDeletions> on a <submodel> allowed

CompSubmodelNoEmptyLODeletions 

No empty listOfDeletions elements allowed

CompLODeletionsAllowedElements 

Allowed elements on <listOfDeletions>

CompLODeletionAllowedAttributes 

Allowed <listOfDeletions> attributes

CompSubmodelAllowedAttributes 

Allowed <submodel> attributes

CompModReferenceSyntax 

'comp:modelRef' must conform to SId syntax

CompInvalidTimeConvFactorSyntax 

'comp:timeConversionFactor' must conform to SId syntax

CompInvalidExtentConvFactorSyntax 

'comp:extentConversionFactor' must conform to SId syntax

CompSubmodelMustReferenceModel 

The 'comp:modelRef' attribute must reference a model

CompSubmodelCannotReferenceSelf 

The 'comp:modelRef' attribute cannot reference own model

CompModCannotCircularlyReferenceSelf 

<model> may not reference <submodel> that references itself.

CompTimeConversionMustBeParameter 

The 'comp:timeConversionFactor' must reference a parameter

CompExtentConversionMustBeParameter 

The 'comp:extentConversionFactor' must reference a parameter

CompPortRefMustReferencePort 

The 'comp:portRef' attribute must be the 'id' of a <port>

CompIdRefMustReferenceObject 

The 'comp:idRef' attribute must be the 'id' of a model element

CompUnitRefMustReferenceUnitDef 

The 'comp:unitRef' attribute must be the 'id' of a UnitDefinition

CompMetaIdRefMustReferenceObject 

The 'comp:metaIdRef' attribute must be the 'metaid' of an object

CompParentOfSBRefChildMustBeSubmodel 

If <sBaseRef> has a child <sBaseRef> its parent must be a <submodel>

CompInvalidPortRefSyntax 

The 'comp:portRef' attribute must have the syntax of an SBML SId

CompInvalidIdRefSyntax 

The 'comp:idRef' attribute must have the syntax of an SBML SId

CompInvalidUnitRefSyntax 

The 'comp:unitRef' attribute must have the syntax of an SBML SId

CompInvalidMetaIdRefSyntax 

The 'comp:metaIdRef' attribute must have the syntax of an XML ID

CompOneSBaseRefOnly 

Only one <sbaseRef>

CompDeprecatedSBaseRefSpelling 

The spelling 'sbaseRef' is deprecated

CompSBaseRefMustReferenceObject 

An SBaseRef must reference an object.

CompSBaseRefMustReferenceOnlyOneObject 

An SBaseRef must reference only one other object.

CompNoMultipleReferences 

Objects may not be referenced by mutiple SBaseRef constructs.

CompPortMustReferenceObject 

Port must reference an object

CompPortMustReferenceOnlyOneObject 

Port must reference only one other object.

CompPortAllowedAttributes 

Allowed attributes on a Port

CompPortReferencesUnique 

Port definitions must be unique.

CompDeletionMustReferenceObject 

Deletion must reference an object

CompDeletionMustReferOnlyOneObject 

Deletion must reference only one other object.

CompDeletionAllowedAttributes 

Allowed attributes on a Deletion

CompReplacedElementMustRefObject 

ReplacedElement must reference an object

CompReplacedElementMustRefOnlyOne 

ReplacedElement must reference only one other object.

CompReplacedElementAllowedAttributes 

Allowed attributes on <replacedElement>

CompReplacedElementSubModelRef 

The 'comp:submodelRef' attribute must point to a <submodel>

CompReplacedElementDeletionRef 

The 'comp:deletion' attribute must point to a <deletion>

CompReplacedElementConvFactorRef 

The 'comp:conversionFactor attribute must point to a <parameter>

CompReplacedElementSameReference 

No <replacedElement> refer to same object

CompReplacedElementNoDelAndConvFact 

No <replacedElement> with deletion and conversionfactor

CompReplacedByMustRefObject 

ReplacedBy must reference an object

CompReplacedByMustRefOnlyOne 

ReplacedBy must reference only one other object.

CompReplacedByAllowedAttributes 

Allowed attributes on <replacedBy>

CompReplacedBySubModelRef 

The 'comp:submodelRef' attribute must point to a <submodel>

CompMustReplaceSameClass 

Replaced classes must match.

CompMustReplaceIDs 

Replaced IDs must be replaced with IDs.

CompMustReplaceMetaIDs 

Replaced metaids must be replaced with metaids.

CompMustReplacePackageIDs 

Replaced package IDs must be replaced with package IDs.

CompUnresolvedReference 

Unresolved reference.

CompNoModelInReference 

No model in referenced document.

CompExtModDefBad 

Referenced <externalModelDefinition> unresolvable.

CompModelFlatteningFailed 

Model failed to flatten.

CompFlatModelNotValid 

Flat model not valid.

CompLineNumbersUnreliable 

Line numbers unreliable.

CompFlatteningNotRecognisedReqd 

Flattening not implemented for required package.

CompFlatteningNotRecognisedNotReqd 

Flattening not implemented for unrequired package.

CompFlatteningNotImplementedNotReqd 

Flattening not implemented for unrequired package.

CompFlatteningNotImplementedReqd 

Flattening not implemented for required package.

CompFlatteningWarning 

Flattening reference may come from package.

CompDeprecatedDeleteFunction 

The performDeletions functions is deprecated.

CompDeprecatedReplaceFunction 

The performReplacementsAndConversions fuctions is deprecated.

CompDeletedReplacement 

Element deleted before a subelement could be replaced.

CompIdRefMayReferenceUnknownPackage 

The 'comp:idRef' attribute must be the 'id' of a model element

CompMetaIdRefMayReferenceUnknownPkg 

The 'comp:metaIdRef' attribute must be the 'metaid' of a model element