ecschema-editing

Classes

Name Description
BaseDiagnostic The abstract base class for all IDiagnostic implementations.
ClassDiagnostic An IDiagnostic implementation used for ECClass diagnostics.
CustomAttributeContainerDiagnostic An IDiagnostic implementation used for CustomAttributeContainerProps diagnostics.
FormatDiagnosticReporter An abstract SuppressionDiagnosticReporter implementation that formats the
LoggingDiagnosticReporter An IDiagnosticReporter for logging IDiagnostic objects.
PropertyDiagnostic An IDiagnostic implementation used for PropertyDiagnostic.Property diagnostics.
RelationshipConstraintDiagnostic An IDiagnostic implementation used for RelationshipConstraintDiagnostic.RelationshipConstraint diagnostics.
SchemaDiagnostic An IDiagnostic implementation used for SchemaDiagnostic.Schema diagnostics.
SchemaItemDiagnostic An IDiagnostic implementation used for SchemaItemDiagnostic.SchemaItem diagnostics.
SchemaMerger Class to merge two schemas together.
SchemaValidater Applies EC Rules, see ECRuleSet, to a given Schema and reports any violations.
SchemaValidationVisitor A SchemaWalkerVisitor interface implementation that is used to validate ECObjects schemas using
SuppressionDiagnosticReporter An abstract base class for IDiagnosticReporter implementation that used the

Constants

Name Description
DiagnosticCodes The unique diagnostic codes for ECObjects rules.
Diagnostics The list of IDiagnostic implementation classes used by the EC rule implementations.
ECRuleSet All schema validation rules that fall under the category of ECObjects.
SchemaCompareCodes The unique diagnostic codes for Schema comparison.
SchemaCompareDiagnostics The list of IDiagnostic implementation classes used by the Schema comparison framework.

Enumerations

Name Description
DiagnosticCategory Defines the possible diagnostic categories.
DiagnosticType Defines the possible diagnostic types.

Global Functions

Name Description
createClassDiagnosticClass Helper method for creating ClassDiagnostic child classes.
createCustomAttributeContainerDiagnosticClass Helper method for creating CustomAttributeContainerDiagnostic child classes.
createPropertyDiagnosticClass Helper method for creating PropertyDiagnostic child classes.
createRelationshipConstraintDiagnosticClass Helper method for creating RelationshipConstraintDiagnostic child classes.
createSchemaDiagnosticClass Helper method for creating SchemaDiagnostic child classes.
createSchemaItemDiagnosticClass Helper method for creating SchemaItemDiagnostic child classes.
diagnosticCategoryToString
diagnosticTypeToString

Interfaces

Name Description
BaseRuleSuppressionMap Interface used to represent elements of a rule suppression
IDiagnostic The interface implemented by all diagnostics used during schema validation.
IDiagnosticReporter Interface used to report IDiagnostic objects created during schema validation.
IRuleSet Interface used to represent logical collection of IRule instances.
IRuleSuppressionMap Interface used to represent elements of a rule suppression
IRuleSuppressionSet Interface used to represent logical collection of ISuppressionRule instances.
SchemaMergeContext Defines the context of a Schema merging run.

Type Aliases

Name Description
AnyDiagnostic Type which encapsulates all possible diagnostics.
BaseRule
BaseSuppressionRule
IRule
ISuppressionRule

Last Updated: 25 October, 2023