Module: Chemicalml::Cml::Schema3

Extended by:
VersionedParser
Defined in:
lib/chemicalml/cml/schema3.rb,
lib/chemicalml/cml/schema3/map.rb,
lib/chemicalml/cml/schema3/atom.rb,
lib/chemicalml/cml/schema3/band.rb,
lib/chemicalml/cml/schema3/bond.rb,
lib/chemicalml/cml/schema3/join.rb,
lib/chemicalml/cml/schema3/link.rb,
lib/chemicalml/cml/schema3/list.rb,
lib/chemicalml/cml/schema3/name.rb,
lib/chemicalml/cml/schema3/peak.rb,
lib/chemicalml/cml/schema3/unit.rb,
lib/chemicalml/cml/schema3/angle.rb,
lib/chemicalml/cml/schema3/array.rb,
lib/chemicalml/cml/schema3/eigen.rb,
lib/chemicalml/cml/schema3/label.rb,
lib/chemicalml/cml/schema3/line3.rb,
lib/chemicalml/cml/schema3/stmml.rb,
lib/chemicalml/cml/schema3/table.rb,
lib/chemicalml/cml/schema3/xaxis.rb,
lib/chemicalml/cml/schema3/yaxis.rb,
lib/chemicalml/cml/schema3/action.rb,
lib/chemicalml/cml/schema3/amount.rb,
lib/chemicalml/cml/schema3/kpoint.rb,
lib/chemicalml/cml/schema3/length.rb,
lib/chemicalml/cml/schema3/matrix.rb,
lib/chemicalml/cml/schema3/object.rb,
lib/chemicalml/cml/schema3/plane3.rb,
lib/chemicalml/cml/schema3/point3.rb,
lib/chemicalml/cml/schema3/region.rb,
lib/chemicalml/cml/schema3/sample.rb,
lib/chemicalml/cml/schema3/scalar.rb,
lib/chemicalml/cml/schema3/system.rb,
lib/chemicalml/cml/schema3/any_cml.rb,
lib/chemicalml/cml/schema3/context.rb,
lib/chemicalml/cml/schema3/crystal.rb,
lib/chemicalml/cml/schema3/formula.rb,
lib/chemicalml/cml/schema3/isotope.rb,
lib/chemicalml/cml/schema3/lattice.rb,
lib/chemicalml/cml/schema3/product.rb,
lib/chemicalml/cml/schema3/sphere3.rb,
lib/chemicalml/cml/schema3/torsion.rb,
lib/chemicalml/cml/schema3/vector3.rb,
lib/chemicalml/cml/schema3/atom_set.rb,
lib/chemicalml/cml/schema3/bond_set.rb,
lib/chemicalml/cml/schema3/document.rb,
lib/chemicalml/cml/schema3/electron.rb,
lib/chemicalml/cml/schema3/fragment.rb,
lib/chemicalml/cml/schema3/gradient.rb,
lib/chemicalml/cml/schema3/metadata.rb,
lib/chemicalml/cml/schema3/molecule.rb,
lib/chemicalml/cml/schema3/particle.rb,
lib/chemicalml/cml/schema3/property.rb,
lib/chemicalml/cml/schema3/reactant.rb,
lib/chemicalml/cml/schema3/reaction.rb,
lib/chemicalml/cml/schema3/spectrum.rb,
lib/chemicalml/cml/schema3/symmetry.rb,
lib/chemicalml/cml/schema3/z_matrix.rb,
lib/chemicalml/cml/schema3/abundance.rb,
lib/chemicalml/cml/schema3/atom_type.rb,
lib/chemicalml/cml/schema3/band_list.rb,
lib/chemicalml/cml/schema3/basis_set.rb,
lib/chemicalml/cml/schema3/bond_type.rb,
lib/chemicalml/cml/schema3/dimension.rb,
lib/chemicalml/cml/schema3/mechanism.rb,
lib/chemicalml/cml/schema3/parameter.rb,
lib/chemicalml/cml/schema3/peak_list.rb,
lib/chemicalml/cml/schema3/potential.rb,
lib/chemicalml/cml/schema3/spectator.rb,
lib/chemicalml/cml/schema3/substance.rb,
lib/chemicalml/cml/schema3/table_row.rb,
lib/chemicalml/cml/schema3/unit_list.rb,
lib/chemicalml/cml/schema3/unit_type.rb,
lib/chemicalml/cml/schema3/array_list.rb,
lib/chemicalml/cml/schema3/atom_array.rb,
lib/chemicalml/cml/schema3/bond_array.rb,
lib/chemicalml/cml/schema3/cml_module.rb,
lib/chemicalml/cml/schema3/definition.rb,
lib/chemicalml/cml/schema3/dictionary.rb,
lib/chemicalml/cml/schema3/identifier.rb,
lib/chemicalml/cml/schema3/peak_group.rb,
lib/chemicalml/cml/schema3/table_cell.rb,
lib/chemicalml/cml/schema3/transform3.rb,
lib/chemicalml/cml/schema3/action_list.rb,
lib/chemicalml/cml/schema3/atom_parity.rb,
lib/chemicalml/cml/schema3/bond_stereo.rb,
lib/chemicalml/cml/schema3/description.rb,
lib/chemicalml/cml/schema3/kpoint_list.rb,
lib/chemicalml/cml/schema3/observation.rb,
lib/chemicalml/cml/schema3/isotope_list.rb,
lib/chemicalml/cml/schema3/product_list.rb,
lib/chemicalml/cml/schema3/table_header.rb,
lib/chemicalml/cml/schema3/configuration.rb,
lib/chemicalml/cml/schema3/documentation.rb,
lib/chemicalml/cml/schema3/fragment_list.rb,
lib/chemicalml/cml/schema3/metadata_list.rb,
lib/chemicalml/cml/schema3/molecule_list.rb,
lib/chemicalml/cml/schema3/property_list.rb,
lib/chemicalml/cml/schema3/reactant_list.rb,
lib/chemicalml/cml/schema3/reaction_list.rb,
lib/chemicalml/cml/schema3/reaction_step.rb,
lib/chemicalml/cml/schema3/spectrum_data.rb,
lib/chemicalml/cml/schema3/spectrum_list.rb,
lib/chemicalml/cml/schema3/table_content.rb,
lib/chemicalml/cml/schema3/atom_type_list.rb,
lib/chemicalml/cml/schema3/bond_type_list.rb,
lib/chemicalml/cml/schema3/cell_parameter.rb,
lib/chemicalml/cml/schema3/condition_list.rb,
lib/chemicalml/cml/schema3/lattice_vector.rb,
lib/chemicalml/cml/schema3/parameter_list.rb,
lib/chemicalml/cml/schema3/peak_structure.rb,
lib/chemicalml/cml/schema3/potential_form.rb,
lib/chemicalml/cml/schema3/potential_list.rb,
lib/chemicalml/cml/schema3/spectator_list.rb,
lib/chemicalml/cml/schema3/substance_list.rb,
lib/chemicalml/cml/schema3/table_row_list.rb,
lib/chemicalml/cml/schema3/unit_type_list.rb,
lib/chemicalml/cml/schema3/reaction_scheme.rb,
lib/chemicalml/cml/schema3/reactive_centre.rb,
lib/chemicalml/cml/schema3/dictionary_entry.rb,
lib/chemicalml/cml/schema3/transition_state.rb,
lib/chemicalml/cml/schema3/table_header_cell.rb,
lib/chemicalml/cml/schema3/reaction_step_list.rb,
lib/chemicalml/cml/schema3/mechanism_component.rb,
lib/chemicalml/cml/schema3/atomic_basis_function.rb

Overview

Schema 3 wire classes. Each is a Lutaml::Model::Serializable subclass that includes the shared declaration mixin from Chemicalml::Cml::Base::*, the Chemicalml::Cml::Visitable walker interface, and extends Schema3::Context for the lutaml_default_register class method.

Wire classes are defined in individual files loaded lazily via autoload — per the project rule, no const_set eager generation. Adding a new CML element means adding one entry to Elements::ALL, one Base::* mixin, one Role::* module, and one per-schema class file.

Defined Under Namespace

Modules: Configuration, Context Classes: Abundance, Action, ActionList, Amount, Angle, AnyCml, Array, ArrayList, Atom, AtomArray, AtomParity, AtomSet, AtomType, AtomTypeList, AtomicBasisFunction, Band, BandList, BasisSet, Bond, BondArray, BondSet, BondStereo, BondType, BondTypeList, CellParameter, ConditionList, Crystal, Definition, Description, Dictionary, DictionaryEntry, Dimension, Document, Documentation, Eigen, Electron, Formula, Fragment, FragmentList, Gradient, Identifier, Isotope, IsotopeList, Join, Kpoint, KpointList, Label, Lattice, LatticeVector, Length, Line3, Link, List, Map, Matrix, Mechanism, MechanismComponent, Metadata, MetadataList, Module, Molecule, MoleculeList, Name, Object, Observation, Parameter, ParameterList, Particle, Peak, PeakGroup, PeakList, PeakStructure, Plane3, Point3, Potential, PotentialForm, PotentialList, Product, ProductList, Property, PropertyList, Reactant, ReactantList, Reaction, ReactionList, ReactionScheme, ReactionStep, ReactionStepList, ReactiveCentre, Region, Sample, Scalar, Spectator, SpectatorList, Spectrum, SpectrumData, SpectrumList, Sphere3, Stmml, Substance, SubstanceList, Symmetry, System, Table, TableCell, TableContent, TableHeader, TableHeaderCell, TableRow, TableRowList, Torsion, Transform3, TransitionState, Unit, UnitList, UnitType, UnitTypeList, Vector3, Xaxis, Yaxis, ZMatrix

Constant Summary collapse

SCHEMA = 
Chemicalml::Schema::Registry.lookup(:schema3)

Constants included from VersionedParser

VersionedParser::KNOWN_ROOTS

Class Method Summary collapse

Methods included from VersionedParser

configuration, document_class, parse

Class Method Details

.ensure_registered! ⇒ Object 



150
151
152
 
# File 'lib/chemicalml/cml/schema3.rb', line 150

def self.ensure_registered!
  Configuration.ensure_registered!
end

.schema ⇒ Object 



146
147
148
 
# File 'lib/chemicalml/cml/schema3.rb', line 146

def self.schema
  SCHEMA
end