ISchemaPartVisitor Interface
Interface to allow schema traversal/deserialization workflows to visit each part, item, class, etc. that exists in a given schema.
Properties
Name | Type | Description | |
---|---|---|---|
visitClass | (ecClass: AnyClass) => Promise<void> | undefined | Called for each AnyClass instance. | |
visitClassSync | (ecClass: AnyClass) => void | undefined | Called for each AnyClass instance. | |
visitConstant | (constant: Constant) => Promise<void> | undefined | Called for each Constant instance. | |
visitConstantSync | (constant: Constant) => void | undefined | Called for each Constant instance. | |
visitCustomAttributeClass | (customAttributeClass: CustomAttributeClass) => Promise<void> | undefined | Called for each CustomAttributeClass instance. | |
visitCustomAttributeClassSync | (customAttributeClass: CustomAttributeClass) => void | undefined | Called for each CustomAttributeClass instance. | |
visitCustomAttributeContainer | (customAttributeContainer: CustomAttributeContainerProps) => Promise<void> | undefined | Called for each CustomAttribute container in the schema. | |
visitCustomAttributeContainerSync | (customAttributeContainer: CustomAttributeContainerProps) => void | undefined | Called for each CustomAttribute container in the schema. | |
visitEmptySchema | (schema: Schema) => Promise<void> | undefined | Called for a partially loaded schema. | |
visitEmptySchemaSync | (schema: Schema) => void | undefined | Called for a partially loaded schema. | |
visitEntityClass | (entityClass: EntityClass) => Promise<void> | undefined | Called for each EntityClass instance. | |
visitEntityClassSync | (entityClass: EntityClass) => void | undefined | Called for each EntityClass instance. | |
visitEnumeration | (enumeration: Enumeration) => Promise<void> | undefined | Called for each Enumeration instance. | |
visitEnumerationSync | (enumeration: Enumeration) => void | undefined | Called for each Enumeration instance. | |
visitFormat | (format: Format) => Promise<void> | undefined | Called for each Format instance. | |
visitFormatSync | (format: Format) => void | undefined | Called for each Format instance. | |
visitFullSchema | (schema: Schema) => Promise<void> | undefined | Called for a fully loaded schema. | |
visitFullSchemaSync | (schema: Schema) => void | undefined | Called for a fully loaded schema. | |
visitInvertedUnit | (invertedUnit: InvertedUnit) => Promise<void> | undefined | Called for each InvertedUnit instance. | |
visitInvertedUnitSync | (invertedUnit: InvertedUnit) => void | undefined | Called for each InvertedUnit instance. | |
visitKindOfQuantity | (koq: KindOfQuantity) => Promise<void> | undefined | Called for each KindOfQuantity instance. | |
visitKindOfQuantitySync | (koq: KindOfQuantity) => void | undefined | Called for each KindOfQuantity instance. | |
visitMixin | (mixin: Mixin) => Promise<void> | undefined | Called for each Mixin instance. | |
visitMixinSync | (mixin: Mixin) => void | undefined | Called for each Mixin instance. | |
visitPhenomenon | (phenomena: Phenomenon) => Promise<void> | undefined | Called for each Phenomenon instance. | |
visitPhenomenonSync | (phenomena: Phenomenon) => void | undefined | Called for each Phenomenon instance. | |
visitProperty | (property: AnyProperty) => Promise<void> | undefined | Called for each AnyProperty instance of an ECClass. | |
visitPropertyCategory | (category: PropertyCategory) => Promise<void> | undefined | Called for each PropertyCategory instance. | |
visitPropertyCategorySync | (category: PropertyCategory) => void | undefined | Called for each PropertyCategory instance. | |
visitPropertySync | (property: AnyProperty) => void | undefined | Called for each AnyProperty instance of an ECClass. | |
visitRelationshipClass | (relationshipClass: RelationshipClass) => Promise<void> | undefined | Called for each RelationshipClass instance. | |
visitRelationshipClassSync | (relationshipClass: RelationshipClass) => void | undefined | Called for each RelationshipClass instance. | |
visitRelationshipConstraint | (relationshipConstraint: RelationshipConstraint) => Promise<void> | undefined | Called for each RelationshipConstraint of each RelationshipClass. | |
visitRelationshipConstraintSync | (relationshipConstraint: RelationshipConstraint) => void | undefined | Called for each RelationshipConstraint of each RelationshipClass. | |
visitSchemaItem | (schemaItem: SchemaItem) => Promise<void> | undefined | Called for each SchemaItem instance. | |
visitSchemaItemSync | (schemaItem: SchemaItem) => void | undefined | Called for each SchemaItem instance. | |
visitStructClass | (structClass: StructClass) => Promise<void> | undefined | Called for each StructClass instance. | |
visitStructClassSync | (structClass: StructClass) => void | undefined | Called for each StructClass instance. | |
visitUnit | (unit: Unit) => Promise<void> | undefined | Called for each Unit instance. | |
visitUnitSync | (unit: Unit) => void | undefined | Called for each Unit instance. | |
visitUnitSystem | (unitSystem: UnitSystem) => Promise<void> | undefined | Called for each UnitSystem instance. | |
visitUnitSystemSync | (unitSystem: UnitSystem) => void | undefined | Called for each UnitSystem instance. |
Defined in
Last Updated: 21 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.