Skip to main content

Crate openbim_dt

Crate openbim_dt 

Source
Expand description

openbim-dt — ISO 23387 data templates.

§What this is

The concept vocabulary that describes properties themselves: property definitions, groups of properties, quantity kinds, dimensions, units, object types, and the reference machinery binding them to external dictionaries such as bSDD.

§Why it is a crate and not part of openbim-loin

LOIN does not own ISO 23387. The ISO 7817-3 schema imports the ISO 23387 namespace and uses its types. Data-template tooling and dictionary clients also need the vocabulary without acquiring a LOIN dependency.

The dependency direction is therefore openbim-loin to openbim-dt, never the reverse.

§Status

The crate implements validated lexical contracts, a bounded namespace-aware parser, semantic XML round trips with unknown-content retention, owned type contracts and typed global/local DT element views, diagnostics, and a CLI.

It does not claim XML Schema or clause-level ISO conformance, byte-identical output, ISO 23386 governance workflows, or ISO 12006-3 mapping. Parsing and validation are deliberately separate operations.

The ISO XSD is not vendored here. Redistribution rights do not follow from possessing a standards document or annex, so restricted references remain local and outside Git, crate packages, and documentation artifacts.

Structs§

AnyUri
XML Schema 1.0 anyURI after whitespace collapsing.
Attribute
One XML attribute with both lexical and resolved namespace identity.
Concept
Owned core of ISO 23387 ConceptType for reuse by dependent standards.
ConceptRef
Shared borrowed view for every ConceptType-derived element.
DataTemplate
ISO 23387 DataTemplateType.
DataTemplateRef
Borrowed data-template view.
DataType
ISO 23387 DataTypeType.
DataTypeRef
Borrowed data-type constraint view.
DataValue
One ordered simple value in ISO 23387 ValueListType.
DateTime
XML Schema dateTime value after whitespace collapsing and lexical validation.
Decimal
XML Schema decimal preserving its whitespace-collapsed validated lexeme.
Diagnostic
One semantic validation finding.
Dimension
Seven SI base-dimension exponents in Annex E declaration order.
Document
A well-formed XML document with one root element.
Element
An XML element retaining names, namespace resolution, attributes, and order.
GroupOfProperties
ISO 23387 GroupOfPropertiesType; the constructor enforces its non-empty property-reference sequence.
Guid
An ISO 23387 GUID, preserving its validated source spelling.
Language
XML Schema language used by DT and importing standards.
Library
Borrowed ISO 23387 library view.
ModelError
Typed-element conversion failure.
MultiLanguageText
ISO 23387 multilingual text.
MultilingualTextRef
Borrowed multilingual text typed by ISO 23387.
ObjectType
ISO 23387 ObjectTypeType.
ParseError
XML parse failure with a stable category and byte position.
ParseOptions
Resource limits applied before or during XML parsing.
PositiveInteger
XML Schema positiveInteger, preserved after whitespace collapse.
Property
ISO 23387 PropertyType.
PropertyRef
Borrowed property view.
QuantityKind
ISO 23387 QuantityKindType.
Rational
ISO 23387 rational value preserving the validated source lexeme.
Reference
An ISO 23387 reference by GUID, URI, or both.
ReferenceDocument
ISO 23387 ReferenceDocumentType.
ReferenceRef
Borrowed reference typed by ISO 23387.
Subject
Owned SubjectType core shared by object types, groups, and data templates.
Unit
ISO 23387 UnitType, with all required scalar/reference fields present.
ValueError
A value rejected by an ISO 23387 lexical contract.
ValueList
One language-specific ISO 23387 ValueListType.
XmlDeclaration
XML declaration values retained by the document model.

Enums§

Base
Unit logarithm base with forward-compatible retention.
DataTypeConstraint
One constraint carried by DataTypeType.
DataTypeName
ISO 23387 property data-type names with forward-compatible retention.
DiagnosticCode
Stable validation categories.
ElementKind
Recognized ISO 23387 element kinds, including local Library children.
LibraryItem
One child retained by a library, including forward-compatible extensions.
Node
XML node kinds retained by the document model.
ParseErrorKind
Stable category for a parse failure.
Scale
Unit scale with forward-compatible retention.
Severity
Validation severity; parsing itself remains non-normalizing and permissive.
ValueErrorKind
Lexical contracts checked by ValueError.
WriteError
XML serialization failure.

Constants§

DRAFT_PLACEHOLDER_NAMESPACE
A placeholder namespace found in pre-release ISO 23387 schema drafts.
NAMESPACE
The XML namespace declared by ISO 23387 edition 2.

Type Aliases§

DataTemplateElement
DimensionElement
GroupOfPropertiesElement
LibraryElement
ObjectTypeElement
PropertyElement
QuantityKindElement
ReferenceDocumentElement
SubjectElement
UnitElement