Schema¶
The CIM Elements are organized in profiles and namespaces:
- class cimpyorm.Model.Elements.Base.CIMProfile(name, uri, short)[source]¶
A CIM Profile instance, usually contained in one file.
This class holds a profile found in a CIM Schema in a SQLAlchemy ORM.
- Parameters
name – The profile’s name.
- properties¶
The CIM Properties defined in this profile.
- classes¶
The CIM Classes used in this profile (not necessarily defined in it).
- definitions = {'classes': <RelationshipProperty at 0x7f5bedec6c20; no key>}¶
The CIM Classes defined in this profile.
- datatypes¶
The CIM Datatypes defined in this profile.
- namespaces¶
The CIM namespaces contained in this profile.
- class cimpyorm.Model.Elements.Base.CIMNamespace(short, full_name)[source]¶
A CIM Namespace instance.
This class holds a namespace found in a CIM Schema in a SQLAlchemy ORM.
- Parameters
short – The namespace’s short name.
full_name – The namespace’s full URI.
- profiles¶
The CIM profiles that contain this namespace
SchemaElements¶
All elements described in a CIM Schema inherit from a common mixin (ElementMixin), that provides
some common functionality, such as relationships to
CIMProfile and
CIMNamespace objects.
- class cimpyorm.Model.Elements.Base.ElementMixin(schema_elements=None)[source]¶
Mixin for schema entities.
This provides common functionality to associate individual SchemaElements (such as classes and properties) with namespaces and profiles. The namespace is read from the XMLS-description of the element, the profile is provided externally.
- Parameters
schema_elements – The XML-Description (an
etree.Element) defining this ElementMixin.profile – Profile name the element is defined in.
- profile¶
The profile this element was defined in.
- namespace¶
The namespace this element is associated with.
CIMClass¶
The CIM Class represents a class defined in the CIM Schema.
- class cimpyorm.Model.Elements.Class.CIMClass(schema_elements=None)[source]¶
A CIM Schema Class (such as Terminal, IdentifiedObject, …).
The class definition is read from its XMLS-description.
- Parameters
schema_elements – The XML-Description (an
etree.Element) defining this CIMClass.profile – Profile name the element is defined in.
- package¶
The package that contains this class definition.
- parent¶
If this class inherits from a parent class, it is referenced here.
- property all_props¶
Return all properties (native and inherited) defined for this CIMClass.
- defined_in¶
- name¶
- namespace¶
- namespace_name¶
- profile¶
CIMProp¶
The CIM Class represents a class defined in the CIM Schema.