The Pan Galactic Engineering Framework Ontology

version: 3.3.0

Classes:

• Class: Identifiable
  Base Class: [none]
  

  Definition:

  The class of things able to be assigned a unique, persistent identifier (a.k.a. OID). Objects that are used, but not created or managed, by an application must be members of subclasses of Identifiable so that their information can be accessed by an application and stored in a database; classes of objects whose information is managed by an Organization must be subclasses of ManagedObject, which identifies the organizational ownership of objects within an application.

  Local Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: RequirementAncestry
  Base Class: Identifiable
  

  Definition:

  A RequirementAncestry relationship is a parent / child relationship between two Requirements. A Requirement can, and often does, beget multiple child Requirements, and a Requirement that has parent Requirements can have more than one parent; hence, this is a many-to-many relationship.

  Local Properties:
  • child_requirement (Requirement): The child Requirement in a RequirementAncestry relationship.
  • parent_requirement (Requirement): The parent Requirement in a RequirementAncestry relationship.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Modelable
  Base Class: Identifiable
  

  Definition:

  A Modelable object is any object of sufficient domain interest to warrant being modeled: it has properties to indicate who created it (an Actor) and who last modified it.

  Local Properties:
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • url (str): The Universal Resource Locator for an object.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: DisciplineRole
  Base Class: Identifiable
  

  Definition:

  A DisciplineRole is the relationship between a Role and a Discipline. DisciplineRole is a many-to-many relationship in that a Role may be associated with multiple Disciplines and a Discipline may have several Roles related to it.

  Local Properties:
  • related_role (Role): The role referenced by a DisciplineRole relationship.
  • related_to_discipline (Discipline): The Discipline to which a role is related by a DisciplineRole relationship.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: ParameterRelation
  Base Class: Identifiable
  

  Definition:

  A ParameterRelation links a Relation (that holds among one or more parameters) to the definitions of those parameters (ParameterDefinition). So a ParameterRelation is a many-to-many relationship between Relations and ParameterDefinitions. For a given Relation, its formulation (cf.) holds the mathematical expressions connecting the related parameters. Note that this model does not specify the context in which the Relation holds -- namely, the objects of which its parameters are attributes -- so this must be supplied as additional information in order to evaluate a Relation instance.

  Local Properties:
  • correlates_parameter (ParameterDefinition): The ParameterDefinitions correlated by the Relation to which a ParameterRelation relationship points.
  • referenced_relation (Relation): The Relation to which a ParameterRelation relationship points.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Relation
  Base Class: Identifiable
  

  Definition:

  A mathematical Relation that holds among two or more parameters.

  Local Properties:
  • correlates_parameters (ParameterRelation) [inverse of referenced_relation]: The ParameterRelation relationships that a Relation has to the parameters it correlates.
  • formulation (str): The mathematical expression(s) (e.g. inequality, equation, set of simultaneous equations, etc.) that define the Relation.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Flow
  Base Class: Modelable
  

  Definition:

  A flow represents the stuff (e.g. energy, electrons, water, data, etc.) that a port is designed to accommodate.

  Local Properties:
  • end_port (Port): The Port to which a Flow flows.
  • end_port_context (Acu): The Assembly Component Usage (Acu) context of the end_port for a Flow. For example, a Flow that represents an electrical connection between the ports of two components in an assembled product is defined within the context of the usages of those components within the assembled product, so those usages represent the start_port_context and end_port_context of the ports for that Flow; conversely, the Flow belongs to the internal (white box) model of the assembled product, which is the assembly attribute of those two contexts.
  • start_port (Port): The Port from which a Flow originates.
  • start_port_context (Acu): The Assembly Component Usage (Acu) context of the start_port for a Flow. For example, a Flow that represents an electrical connection between the ports of two components in an assembled product is defined within the context of the usages of those components within the assembled product, so those usages represent the start_port_context and end_port_context for that Flow; conversely, the Flow belongs to the internal (white box) model of the assembled product, which is the assembly attribute of those two contexts.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: DocumentReference
  Base Class: Identifiable
  

  Definition:

  A DocumentReference is the relationship between a Document and a Modelable instance. DocumentReference is a many-to-many relationship in that a Document may be associated with multiple Modelables and a Modelable may have several Documents related to it.

  Local Properties:
  • document (Document): The Document referenced by a DocumentReference relationship.
  • related_item (Modelable): The Modelable instance referenced by a DocumentReference relationship.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Actor
  Base Class: Identifiable
  

  Definition:

  A well-defined, persistent, and identifiable entity that can create and modify Identifiable things. Subclasses include Person, Organization, and Project. (Other subclasses may be added, such as Application or ArtificialLifeForm.)

  Local Properties:
  • created_objects (Modelable) [inverse of creator]: Objects created by this agent.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Port
  Base Class: Modelable
  

  Definition:

  A port is the abstraction of a product interface (as opposed to the component that implements the interface, such as a connector, etc.) through which some stuff (e.g. energy, electrons, water, data, etc.) flows into and/or out of the product.

  Local Properties:
  • of_product (Product): The Product that owns a Port.
  • type_of_port (PortType): The characterization of a port by what flows through it (e.g., power, control, communications, analog or digital data, etc.).
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: ActivityType
  Base Class: Identifiable
  

  Definition:

  The type of an Activity. Examples are "Operation", "Event", "Cycle".

  Local Properties:
  • activities_of_type (Activity) [inverse of activity_type]: All Activities of this type.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Discipline
  Base Class: Identifiable
  

  Definition:

  A named subject matter area (e.g. a specific engineering discipline, such as Avionics or Flight Dynamics, or a scientific discipline, such as Solid State Physics, and may be even more specific, such as Surface Physics). The intent of defining Disciplines in the context of a collaborative modeling activity is to define the roles and points of view of the participants and their models.

  Local Properties:
  • related_roles (DisciplineRole) [inverse of related_to_discipline]: The roles related to a Discipline.
  • relevant_product_types (DisciplineProductType) [inverse of used_in_discipline]: The relationships that a Discipline has to its ProductTypes.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: VerificationTest
  Base Class: Modelable
  

  Definition:

  A VerificationTest is a many-to-many relationship between Tests and Requirements.

  Local Properties:
  • test (Test): The Test used in this Verification Test.
  • verifies (Requirement): Requirement that this Verification Test is intended to verify.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: ManagedObject
  Base Class: Modelable
  

  Definition:

  Managed Objects are those whose information is maintained by an Organization (the "owner").

  Local Properties:
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: ModelType
  Base Class: Identifiable
  

  Definition:

  A type of Model -- e.g., MCAD (e.g. STEP AP203), ECAD (e.g. circuit schematic, STEP AP210, etc.), Structural Analysis (e.g. NASTRAN), System (e.g. SysML), etc.

  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: DisciplineProductType
  Base Class: Identifiable
  

  Definition:

  A Discipline ProductType is a relationship between a Discipline and a type of Product that is used by practitioners of that Discipline. The two classes have a many-to-many relationship: one Discipline will typically use many ProductTypes, and one ProductType can be used by many Disciplines.

  Local Properties:
  • relevant_product_type (ProductType): The ProductType to which a DisciplineProductType relationship points.
  • used_in_discipline (Discipline): The Discipline to which a DisciplineProductType relationship points.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Requirement
  Base Class: ManagedObject
  

  Definition:

  A requirement is the specification of a goal or constraint to be satisfied by a product.

  Local Properties:
  • allocated_to (Modelable): The item to which this requirement is allocated.
  • child_requirements (RequirementAncestry) [inverse of parent_requirement]: The children of a parent Requirement in a RequirementAncestry relationship.
  • computable_form (Relation): The computable_form of a requirement is a Relation, which can usually be thought of as a mathematical constraint applied to a parameter or a set of parameters.
  • justification (str): Detailed justification for a Requirement.
  • parent_requirements (RequirementAncestry) [inverse of child_requirement]: The parents of a child Requirement in a RequirementAncestry relationship.
  • rationale (str): The reason behind a Requirement.
  • rqt_compliance (str): The extent to which the mission, system, or component to which the Requirement is allocated meets the Requirement.
  • rqt_constraint_type (str): The type of constraint specified by a Requirement: a specified maximum or minimum, a specified value with a tolerance, or an allowable range specified by a pair of maximum and minimum values.
  • rqt_level (int): The level of a requirement within the hierarchy of a system's requirements.
  • rqt_maximum_value (float): For a Requirement whose constraint has a maximum, the value of the maximum.
  • rqt_minimum_value (float): For a Requirement whose constraint has a minimum, the value of the minimum.
  • rqt_object (str): The final element in a performance Requirement RDF-style "triple", composed of some combination of values and units.
  • rqt_predicate (str): The middle element in a performance Requirement RDF-style "triple", composed of a verb phrase "shall [be]" and some form of constraint expression (e.g., "less than", etc.).
  • rqt_subject (str): The initial element in a performance Requirement RDF-style "triple", composed of the name of the system/subsystem or function to which the Requirement is allocated and the dimensions of the parameter to be constrained (e.g. "Mass").
  • rqt_target_value (float): For a Requirement whose constraint is expressed as a specific value (possibly with a symmetric or asymmetric tolerance), the value.
  • rqt_tolerance (float): For a Requirement whose constraint is a specified value with a symmetric tolerance, the value of the tolerance.
  • rqt_tolerance_lower (float): For a requirement whose constraint is a specified value with an asymmetric tolerance, the value of the lower tolerance limit.
  • rqt_tolerance_type (str): The type of tolerance (symmetric or asymmetric) specified for a Requirement with specified value.
  • rqt_tolerance_upper (float): For a Requirement whose constraint is a specified value with an asymmetric tolerance, the value of the upper tolerance limit.
  • rqt_type (str): The type of a Requirement: functional or performance.
  • rqt_units (str): For a performance Requirement, the units in which all related constraint values are expressed.
  • validated (bool): Specifies whether a requirement is correct.
  • verification_method (str): The method used to verify a Requirement: test, analysis, or inspection.
  • verification_tests (VerificationTest) [inverse of verifies]: Verification Tests that contribute to verifying this requirement.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: ProductType
  Base Class: ManagedObject
  

  Definition:

  A functional category or classification of a product.

  Local Properties:
  • products_of_type (Product) [inverse of product_type]: The products classified as being in a functional category.
  • used_in_disciplines (DisciplineProductType) [inverse of relevant_product_type]: The relationships that a ProductType has to the Disciplines that use it.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: ActivityControl
  Base Class: ManagedObject
  

  Definition:

  A flow control in a sequence of Activities. Subclasses include "Decision" and "Merge".

  Local Properties:
  • antecedent (Activity): The antecedent is the activity that immediately precedes an activity control object in a sequence of activities.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: ContinuousProductType
  Base Class: ProductType
  

  Definition:

  A functional category or classification of a continuous product (e.g., fuel, coating, paint, etc.).

  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • products_of_type (Product) [inverse of product_type]: The products classified as being in a functional category.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • used_in_disciplines (DisciplineProductType) [inverse of relevant_product_type]: The relationships that a ProductType has to the Disciplines that use it.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: Decision
  Base Class: ActivityControl
  

  Definition:

  A point in a sequence of activities in which the following activity is determined based on a condition (a boolean-valued Relation).

  Local Properties:
  • alternative_activity (Activity): The activity following a Decision if its condition evaluates as false.
  • condition (Relation): The determinant of a Decision: a boolean-valued Relation.
  • next_activity (Activity): The activity following a Decision if its condition evaluates as true.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • antecedent (Activity): The antecedent is the activity that immediately precedes an activity control object in a sequence of activities.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: DigitalFile
  Base Class: Modelable
  

  Definition:

  The class of file-like objects.

  Local Properties:
  • checksum (str): A sha-256 hash generated from the file contents
  • file_role (str): The purpose of a file relative to a representation to which it is related. Example values are: attachment, content, stylesheet, DTD, etc.
  • file_sequence (int): An integer that can be used to specify the ordering of this file within an ordered set of files -- attachments, for example. NOTE: file_sequence is intepreted as applying within file_sequence_context (which see).
  • file_sequence_context (str): The name of the attribute within the context of which the file_sequence attribute is meaningful. If the value of the file_sequence_context attribute is role, and the value of file_role is attachment, then file_sequence is the position of this file within the set of files that have a file role of attachment.
  • file_size (int): The size of the file in bytes.
  • mime_type (str): The MIME type/subtype of file content, specifying the format of a file and aiding an application in choosing an appropriate tool to process its content.
  • user_file_name (str): The user's local name for the file.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: Product
  Base Class: ManagedObject
  

  Definition:

  Product objects represent either black box entities, such as vendor parts, knowledge of whose internal components and characteristics may or may not be available to a Project that is using them, or white box entities, such as systems, whose internals may be known. The intent of the Product class is to contain all designed artifacts whose evolution is explicitly tracked in specifiable increments that are managed by the owner of the subject knowledgebase. The versions of a Product may all share the same identifier (id) and be differentiated by their version attribute. Note that the Product class also contains objects that may have evolved in a version structure, but whose version structure is regarded as opaque and is not represented explicitly in the subject knowledgebase. E.g., a Product that is purchased from a vendor will often have versions or models but the owner of the subject knowledgebase does not control the versioning or create new versions; the versions do not share a common identifier (id) but may be related by other attributes, such as a generic part number or a common root string in the manufacturer part number.

  Local Properties:
  • components (Acu) [inverse of assembly]: The slots or roles (assembly component usages [Acu]) of the products used to assemble this product.
  • fsc_code (str): The Federal Supply Classification (FSC) code for a product (this is also the first four digits of the National Stock Number or NSN).
  • ports (Port) [inverse of of_product]: The Ports owned by a Product.
  • product_type (ProductType): The functional category in which a product has been classified.
  • projects_using_system (ProjectSystemUsage) [inverse of system]: The projects that are using or developing a system.
  • purpose (str): The reason for creating this artifact.
  • q_components (Qacu) [inverse of q_assembly]: The slots or roles (quantified assembly component usages [Qacu]) of the continuous products used to assemble this product.
  • specification_number (str): The identifier of the specification document that applies to a product.
  • where_used (Acu) [inverse of component]: Where this product is used (assembly component usages) in any assemblies.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: Role
  Base Class: Identifiable
  

  Definition:

  A function or position that can be assigned to a person within a context. The context will typically be an organization or a project. A role will typically have an associated set of privileges.

  Local Properties:
  • assignments_of_role (RoleAssignment) [inverse of assigned_role]: The RoleAssignment relationships in which a role has been assigned.
  • related_to_disciplines (DisciplineRole) [inverse of related_role]: The DisciplineRole relationships in which a role is referenced.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Activity
  Base Class: ManagedObject
  

  Definition:

  A named, structured procedural concept which is realized and applied systematically to achieve an objective.

  Local Properties:
  • activity_type (ActivityType): The type of an Activity.
  • of_system (Modelable): The system or component usage of which this is an Activity.
  • sub_activities (Activity) [inverse of sub_activity_of]: The Activities which are sub-activities of an Activity.
  • sub_activity_of (Activity): The Activity of which an Activity is a sub-activity.
  • sub_activity_sequence (int): An integer indicating the sequential position of an Activity within the Activity of which it is a sub-activity.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: ParameterContext
  Base Class: ManagedObject
  

  Definition:

  A metadata tag that defines a family of related parameters. A Parameter Context has an associated range datatype and may define a computation method or generating function, if applicable.

  Local Properties:
  • computed (bool): Specifies whether a parameter in this ParameterContext is to have its value computed (and therefore treated as a derived quantity).
  • context_datatype (str): The datatype of a ParameterContext.
  • context_dimensions (str): The dimensional specification for a ParameterContext.
  • context_type (str): Specifies whether the context is prescriptive or descriptive. Prescriptive contexts apply to requirements and design constraints; descriptive contexts apply to test data, analysis results, and data sheets that provide attributes of vendor parts.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: Test
  Base Class: Activity
  

  Definition:

  A Test is a type of activity consisting of a specified environment, specified inputs and measurable expected results (synonymous to SysML: testCase, modeled by a SysML Interaction).

  Local Properties:
  • verifies_requirements (VerificationTest) [inverse of test]: Requirements this Verification Test contributes to verifying.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • activity_type (ActivityType): The type of an Activity.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • of_system (Modelable): The system or component usage of which this is an Activity.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • sub_activities (Activity) [inverse of sub_activity_of]: The Activities which are sub-activities of an Activity.
  • sub_activity_of (Activity): The Activity of which an Activity is a sub-activity.
  • sub_activity_sequence (int): An integer indicating the sequential position of an Activity within the Activity of which it is a sub-activity.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: DigitalProduct
  Base Class: Product
  

  Definition:

  A digital product is a non-hardware product that is computer-sensible -- i.e., can be stored in a computer, written on a digital medium, and transmitted over a network link.

  Local Properties:
  • has_files (RepresentationFile) [inverse of of_object]: RepresentationFiles related to a DigitalProduct.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • components (Acu) [inverse of assembly]: The slots or roles (assembly component usages [Acu]) of the products used to assemble this product.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • fsc_code (str): The Federal Supply Classification (FSC) code for a product (this is also the first four digits of the National Stock Number or NSN).
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • ports (Port) [inverse of of_product]: The Ports owned by a Product.
  • product_type (ProductType): The functional category in which a product has been classified.
  • projects_using_system (ProjectSystemUsage) [inverse of system]: The projects that are using or developing a system.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • purpose (str): The reason for creating this artifact.
  • q_components (Qacu) [inverse of q_assembly]: The slots or roles (quantified assembly component usages [Qacu]) of the continuous products used to assemble this product.
  • specification_number (str): The identifier of the specification document that applies to a product.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).
  • where_used (Acu) [inverse of component]: Where this product is used (assembly component usages) in any assemblies.

  ---

• Class: ProductInstance
  Base Class: ManagedObject
  

  Definition:

  A physical object that is purported to be a physical realization of a part concept, or, formally, of a part specification.

  Local Properties:
  • instance_of (Product): The product of which a specific physical object is a realization.
  • lot_date_code (str): An alphanumeric string used by a manufacturer to identify the collection (lot) of part instances of which a specific part instance was a member.
  • part_manufacturer (Organization): The organization that was primarily responsible for producing a physical part.
  • part_model_number (str): The identifier for a part model, a somewhat arbitrary identifier usually specified by the manufacturer.
  • part_vendor (Organization): The organization from which a part instance was procured.
  • serial_number (str): An identifier assigned by a manufacturer to a specific part instance.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: DataElementDefinition
  Base Class: ManagedObject
  

  Definition:

  A data element definition specifies the datatype and textual description of a data element (an assignable property).

  Local Properties:
  • domain_class (str): The name of the domain class of a DataElementDefinition.
  • label (str): A label for display, for example as a header when the data element occurs as a column in a table.
  • range_datatype (str): The name of the range datatype of a DataElementDefinition.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: RepresentationFile
  Base Class: DigitalFile
  

  Definition:

  A file-like object that contains all or part of a representation of a DigitalProduct.

  Local Properties:
  • of_object (DigitalProduct): The DigitalProduct (usually a model or a document) that a representation file is related to.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • checksum (str): A sha-256 hash generated from the file contents
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • file_role (str): The purpose of a file relative to a representation to which it is related. Example values are: attachment, content, stylesheet, DTD, etc.
  • file_sequence (int): An integer that can be used to specify the ordering of this file within an ordered set of files -- attachments, for example. NOTE: file_sequence is intepreted as applying within file_sequence_context (which see).
  • file_sequence_context (str): The name of the attribute within the context of which the file_sequence attribute is meaningful. If the value of the file_sequence_context attribute is role, and the value of file_role is attachment, then file_sequence is the position of this file within the set of files that have a file role of attachment.
  • file_size (int): The size of the file in bytes.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mime_type (str): The MIME type/subtype of file content, specifying the format of a file and aiding an application in choosing an appropriate tool to process its content.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.
  • user_file_name (str): The user's local name for the file.

  ---

• Class: RoleAssignment
  Base Class: Modelable
  

  Definition:

  A RoleAssignment is the relationship between a role and a person to which the role has been assigned. RoleAssignment is a many-to-many relationship in that a role may be assigned to multiple persons and a person may have several roles assigned to them.

  Local Properties:
  • assigned_role (Role): The role assigned in a RoleAssignment relationship.
  • assigned_to (Person): The person to whom a role is assigned in a RoleAssignment relationship.
  • role_assignment_context (Organization): The context in which a role is assigned, usually an organization or project.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: ParameterDefinition
  Base Class: DataElementDefinition
  

  Definition:

  A parameter definition specifies the dimensions of a parameter, which is a data element that represents a measurable physical property.

  Local Properties:
  • dimensions (str): The dimensional specification for a ParameterDefinition.
  • is_correlated_by (ParameterRelation) [inverse of correlates_parameter]: The relationships that a ParameterDefinition has to its correlative Relations.
  • port_type (PortType): The type of port (if any) associated with a parameter definition.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • domain_class (str): The name of the domain class of a DataElementDefinition.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • label (str): A label for display, for example as a header when the data element occurs as a column in a table.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • range_datatype (str): The name of the range datatype of a DataElementDefinition.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: Document
  Base Class: DigitalProduct
  

  Definition:

  The digital (computer-sensible) representation of a human-readable document.

  Local Properties:
  • abstract (str): A capsule summary of the content of a document.
  • content (str): The content of a document in a text-based format (usually text/plain, but may be any format with a MIME type of "text", such as text/html, text/xml, or text/tab-separated-values).
  • item_relationships (DocumentReference) [inverse of document]: The DocumentReference relationships relating Modelable items to a Document.
  • publish_datetime (datetime): Date (and time, if relevant) a Document was published.
  • structural_role (str): An indicator of whether the document is intended to be (1) stand-alone, (2) the parent in an assembly of documents, or (3) a component in another document.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • components (Acu) [inverse of assembly]: The slots or roles (assembly component usages [Acu]) of the products used to assemble this product.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • fsc_code (str): The Federal Supply Classification (FSC) code for a product (this is also the first four digits of the National Stock Number or NSN).
  • has_files (RepresentationFile) [inverse of of_object]: RepresentationFiles related to a DigitalProduct.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • ports (Port) [inverse of of_product]: The Ports owned by a Product.
  • product_type (ProductType): The functional category in which a product has been classified.
  • projects_using_system (ProjectSystemUsage) [inverse of system]: The projects that are using or developing a system.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • purpose (str): The reason for creating this artifact.
  • q_components (Qacu) [inverse of q_assembly]: The slots or roles (quantified assembly component usages [Qacu]) of the continuous products used to assemble this product.
  • specification_number (str): The identifier of the specification document that applies to a product.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).
  • where_used (Acu) [inverse of component]: Where this product is used (assembly component usages) in any assemblies.

  ---

• Class: Qacu
  Base Class: Modelable
  

  Definition:

  The Qacu (quantified assembly constituent usage) is the relationship between a continuous product (the constituent) and an assembled product (the assembly) of which it is a constituent; a Qacu is a many-to-many relationship in that an assembly may contain multiple continuous products, and any given product may be a constituent in many assemblies.

  Local Properties:
  • amount (float): The measured amount of the continuous product used, expressed in the amount_units.
  • amount_units (str): The units in which the amount of the continuous product is expressed.
  • q_assembly (Product): The assembled product to which a quantified assembly component usage (Qacu) points.
  • q_component (ContinuousProduct): The continuous product in a quantified assembly component usage (Qacu).
  • q_type_hint (ContinuousProductType): A suggested continuous product type to use in the assembly position of a Qacu (quantified assembly component usage).
  • qacu_reference_designator (str): The reference designator is a symbolic name that serves as an identifier for a component usage within the context of an assembly.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: ProjectSystemUsage
  Base Class: Modelable
  

  Definition:

  The relationship between a project and a top-level system. The role of the System in the context of the project is captured in the system_role property of the ProjectSystemUsage relationship. The ProjectSystemUsage relationship is a many-to-many relationship in that, in general, a project will have multiple top-level systems, and a given system may occur at the top level in multiple projects, albeit with possibly different configurations.

  Local Properties:
  • project (Project): The project referenced in a ProjectSystemUsage relationship.
  • system (Product): The system referenced in a ProjectSystemUsage relationship.
  • system_role (str): Role designation of a top-level System within the context of a Project.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: Acu
  Base Class: Modelable
  

  Definition:

  The Acu (assembly component usage) is the relationship between a discrete product (the component) and an assembled product (the assembly) of which it is a constituent; an Acu is a many-to-many relationship in that an assembly contains multiple products, and any given product may be used in many assemblies. N.B.: product here refers to a conceptual product, as opposed to a physical product (product instance) of a product specification -- the ACU relationship between physical products and assemblies, though related, is logically different, since a physical product can only be in one physical location in an assembly, whereas a conceptual product can be used at multiple locations (distinguished by reference designator, a property of the Acu) in an assembly.

  Local Properties:
  • assembly (Product): The assembly to which an assembly component usage (Acu) points.
  • component (Product): The component product in an assembly component usage (Acu).
  • product_type_hint (ProductType): A suggested product type for the component to use in an assembly position.
  • quantity (int): The number of instances or measured quantity of the component object(s) used.
  • reference_designator (str): The reference designator is a symbolic name that serves as an identifier for a component usage within the context of an assembly.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: Mission
  Base Class: Activity
  

  Definition:

  A Mission is an activity which is defined by a project and is accomplished by means of a collection of systems. Although an Activity typically is related to a specific object (specified by its "of_system" property) the Mission does not have a specific object, but is regarded as the parent of all activities of the project systems. It will typically be decomposed into a set of phases for which the Mission concept of operations specification will associate sets of parameter values with the states of the physical systems and components used to accomplish the Mission goal.

  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • activity_type (ActivityType): The type of an Activity.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • of_system (Modelable): The system or component usage of which this is an Activity.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • sub_activities (Activity) [inverse of sub_activity_of]: The Activities which are sub-activities of an Activity.
  • sub_activity_of (Activity): The Activity of which an Activity is a sub-activity.
  • sub_activity_sequence (int): An integer indicating the sequential position of an Activity within the Activity of which it is a sub-activity.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: Model
  Base Class: DigitalProduct
  

  Definition:

  A constructed realization of the properties and/or behaviors of a concept or a real-world thing. A Model instance can be used for analysis, simulation, description, specification, or presentation of some aspect(s) of a domain object. Model in the engineering domain generally maps to step:product_definition, but there may be other mappings for particular STEP Application Protocols and other types of models. (Note that the characteristics of any Model instance can be the subject of a Model at a higher level of abstraction. The higher-level Model instance in this context is sometimes referred to as a "meta-model" relative to the Model instance whose characteristics it models.)

  Local Properties:
  • model_definition_context (Discipline): The discipline context within which a model is being used. (In the engineering domain, this property maps to STEP product definition context.)
  • of_thing (Modelable): The thing that a model is intended to describe or simulate.
  • type_of_model (ModelType): The type of a model (for example, a SysML Block Definition Diagram, or a STEP 3D mechanical model). Types of models will typically have associated tools and file formats.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • components (Acu) [inverse of assembly]: The slots or roles (assembly component usages [Acu]) of the products used to assemble this product.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • fsc_code (str): The Federal Supply Classification (FSC) code for a product (this is also the first four digits of the National Stock Number or NSN).
  • has_files (RepresentationFile) [inverse of of_object]: RepresentationFiles related to a DigitalProduct.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • ports (Port) [inverse of of_product]: The Ports owned by a Product.
  • product_type (ProductType): The functional category in which a product has been classified.
  • projects_using_system (ProjectSystemUsage) [inverse of system]: The projects that are using or developing a system.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • purpose (str): The reason for creating this artifact.
  • q_components (Qacu) [inverse of q_assembly]: The slots or roles (quantified assembly component usages [Qacu]) of the continuous products used to assemble this product.
  • specification_number (str): The identifier of the specification document that applies to a product.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).
  • where_used (Acu) [inverse of component]: Where this product is used (assembly component usages) in any assemblies.

  ---

• Class: PortTemplate
  Base Class: Port
  

  Definition:

  A Port Template is a reusable Port definition that includes a set of parameters and parameter values which will be replicated when the Port Template is used to create a new Port instance.

  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • of_product (Product): The Product that owns a Port.
  • oid (str): Object ID (a globally unique identifier).
  • type_of_port (PortType): The characterization of a port by what flows through it (e.g., power, control, communications, analog or digital data, etc.).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: PortType
  Base Class: Modelable
  

  Definition:

  A Port Type defines a family of Ports by the type of Flow that they accommodate, e.g. electrical power. A PortType may also have an associated set of Parameters.

  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: Merge
  Base Class: ActivityControl
  

  Definition:

  A point in a sequence of activities in which the preceding activity (antecedent) was the last activity in an alternative set of activities that resulted from a Decision.

  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • antecedent (Activity): The antecedent is the activity that immediately precedes an activity control object in a sequence of activities.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: Organization
  Base Class: Modelable
  

  Definition:

  A well-defined, persistent, and identifiable collection of Person instances.

  Local Properties:
  • cage_code (str): Identifier for an organization in the DoD Commercial And Government Entity (CAGE) database.
  • city (str): The city in which an organization or facility is located.
  • country (str): The country in which an organization or facility is located.
  • name_code (str): An abbreviated name for an organization, usually formalized.
  • organizational_role_assignments (RoleAssignment) [inverse of role_assignment_context]: Role assignments of a person in the context of an organization.
  • owned_objects (ManagedObject) [inverse of owner]: The objects whose information or specification is managed by an organization.
  • parent_organization (Organization): The parent organization of an organization.
  • state_or_province (str): An Organization's state (if in the U.S.) or province.
  • street_address (str): An Organization's Street Address.
  • sub_organizations (Organization) [inverse of parent_organization]: Organizations of which this organization is the parent.
  • zip_or_postal_zone (str): An Organization's zip code (if in the U.S.) or postal zone.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • url (str): The Universal Resource Locator for an object.

  ---

• Class: Person
  Base Class: Actor
  

  Definition:

  A human being.

  Local Properties:
  • alt_email (str): Alternate email address of a person.
  • email (str): The primary email address of a person.
  • employer (Organization): The primary organization for which a person works.
  • first_name (str): Given name of a person.
  • last_name (str): The surname of a person.
  • mi_or_name (str): The middle initial or middle name of a person.
  • org (Organization): The primary organizational affiliation of a person.
  • phone (str): The primary phone number of a person.
  • preferred_name (str): Preferred name of person.
  • roles (RoleAssignment) [inverse of assigned_to]: The roles assigned to a person.
  • work_email (str): A Person's email address at an Organization.
  • work_phone (str): A Person's telephone number at an Organization.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • created_objects (Modelable) [inverse of creator]: Objects created by this agent.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).

  ---

• Class: Software
  Base Class: DigitalProduct
  

  Definition:

  Software is a digital product that can be executed within a hardware product.

  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • components (Acu) [inverse of assembly]: The slots or roles (assembly component usages [Acu]) of the products used to assemble this product.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • fsc_code (str): The Federal Supply Classification (FSC) code for a product (this is also the first four digits of the National Stock Number or NSN).
  • has_files (RepresentationFile) [inverse of of_object]: RepresentationFiles related to a DigitalProduct.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • ports (Port) [inverse of of_product]: The Ports owned by a Product.
  • product_type (ProductType): The functional category in which a product has been classified.
  • projects_using_system (ProjectSystemUsage) [inverse of system]: The projects that are using or developing a system.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • purpose (str): The reason for creating this artifact.
  • q_components (Qacu) [inverse of q_assembly]: The slots or roles (quantified assembly component usages [Qacu]) of the continuous products used to assemble this product.
  • specification_number (str): The identifier of the specification document that applies to a product.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).
  • where_used (Acu) [inverse of component]: Where this product is used (assembly component usages) in any assemblies.

  ---

• Class: PropertyDefinition
  Base Class: DataElementDefinition
  

  Definition:

  A property definition defines a data element that has a specified class as its domain.

  Local Properties:
  • domain (str): The name of the class that is the domain of a Property Definition.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • domain_class (str): The name of the domain class of a DataElementDefinition.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • label (str): A label for display, for example as a header when the data element occurs as a column in a table.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • range_datatype (str): The name of the range datatype of a DataElementDefinition.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).

  ---

• Class: HardwareProduct
  Base Class: Product
  

  Definition:

  A hardware product represents a design concept or specification that when realized (manufactured) in a physically sensible and measurable instance (i.e., product instance) manifests some specified functionality. Note that a hardware product may contain digital product elements (non-hardware), such as software and firmware, etc.

  Local Properties:
  • drawing_number (str): Identifier for a drawing (a type of specification).
  • drawing_part_number (str): If a part (product) has a drawing (a type of specification), this is the part identifier specified in the drawing.
  • generic_part_number (str): The generic identifier for a EEE part, which in some cases is specified by a standard (e.g., JEDEC for electronic parts).
  • manufacturer_part_number (str): The identifier assigned to a hardware product by its manufacturer.
  • military_specification (str): The identifier of the military specification (a.k.a. MIL Spec) that applies to a EEE part.
  • nsn (str): The National Stock Number (NSN) for a EEE part.
  • screening_specification_number (str): The identifier for a screening specification that applies to a EEE part.
  • specification_part_number (str): The identifier given to a hardware product by its specification.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • components (Acu) [inverse of assembly]: The slots or roles (assembly component usages [Acu]) of the products used to assemble this product.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • fsc_code (str): The Federal Supply Classification (FSC) code for a product (this is also the first four digits of the National Stock Number or NSN).
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • ports (Port) [inverse of of_product]: The Ports owned by a Product.
  • product_type (ProductType): The functional category in which a product has been classified.
  • projects_using_system (ProjectSystemUsage) [inverse of system]: The projects that are using or developing a system.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • purpose (str): The reason for creating this artifact.
  • q_components (Qacu) [inverse of q_assembly]: The slots or roles (quantified assembly component usages [Qacu]) of the continuous products used to assemble this product.
  • specification_number (str): The identifier of the specification document that applies to a product.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).
  • where_used (Acu) [inverse of component]: Where this product is used (assembly component usages) in any assemblies.

  ---

• Class: Template
  Base Class: Product
  

  Definition:

  A template is a named, reusable pattern or example to use in creating a type of product, document, or model. A template may contain parameter definitions and component products.

  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • components (Acu) [inverse of assembly]: The slots or roles (assembly component usages [Acu]) of the products used to assemble this product.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • fsc_code (str): The Federal Supply Classification (FSC) code for a product (this is also the first four digits of the National Stock Number or NSN).
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • ports (Port) [inverse of of_product]: The Ports owned by a Product.
  • product_type (ProductType): The functional category in which a product has been classified.
  • projects_using_system (ProjectSystemUsage) [inverse of system]: The projects that are using or developing a system.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • purpose (str): The reason for creating this artifact.
  • q_components (Qacu) [inverse of q_assembly]: The slots or roles (quantified assembly component usages [Qacu]) of the continuous products used to assemble this product.
  • specification_number (str): The identifier of the specification document that applies to a product.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).
  • where_used (Acu) [inverse of component]: Where this product is used (assembly component usages) in any assemblies.

  ---

• Class: Project
  Base Class: Organization
  

  Definition:

  An activity that has the purpose of producing and/or maintaining something, and which involves contributions from Persons and Organizations.

  Local Properties:
  • systems (ProjectSystemUsage) [inverse of project]: The top-level systems that are used or developed by a project.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • cage_code (str): Identifier for an organization in the DoD Commercial And Government Entity (CAGE) database.
  • city (str): The city in which an organization or facility is located.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • country (str): The country in which an organization or facility is located.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • name_code (str): An abbreviated name for an organization, usually formalized.
  • oid (str): Object ID (a globally unique identifier).
  • organizational_role_assignments (RoleAssignment) [inverse of role_assignment_context]: Role assignments of a person in the context of an organization.
  • owned_objects (ManagedObject) [inverse of owner]: The objects whose information or specification is managed by an organization.
  • parent_organization (Organization): The parent organization of an organization.
  • state_or_province (str): An Organization's state (if in the U.S.) or province.
  • street_address (str): An Organization's Street Address.
  • sub_organizations (Organization) [inverse of parent_organization]: Organizations of which this organization is the parent.
  • url (str): The Universal Resource Locator for an object.
  • zip_or_postal_zone (str): An Organization's zip code (if in the U.S.) or postal zone.

  ---

• Class: ContinuousProduct
  Base Class: HardwareProduct
  

  Definition:

  A hardware product that is continuous in nature (e.g., fuel, coating, paint, etc.), as opposed to discrete hardware products such as electronics boxes, spacecraft, etc. A primary characteristic of continuous products is that they are purchased and used in bulk quantities such as volumes or areas, so their quantities are specified in non-integer measures with units, in contrast to quantities of discrete products, which are always integers.

  Local Properties:
  • amount_dimensions (str): The dimensions of the amounts in which a Continuous Product is purchased or used.
  • q_where_used (Qacu) [inverse of q_component]: Where this continuous product is used (quantified assembly component usages) in any assemblies.
  Inherited Properties:
  • abbreviation (str): A human-readable abbreviated name for an object.
  • activities (Activity) [inverse of of_system]: All Activities of a system or component usage.
  • allocated_requirements (Requirement) [inverse of allocated_to]: The requirements that have been allocated to this item.
  • comment (str): General information about or views on an object. The meaning of a comment is determined by the application context.
  • components (Acu) [inverse of assembly]: The slots or roles (assembly component usages [Acu]) of the products used to assemble this product.
  • create_datetime (datetime): The date and time of creation of an object.
  • creator (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that created an object.
  • description (str): A narrative about the characteristics and identifying features of an object.
  • doc_references (DocumentReference) [inverse of related_item]: The DocumentReference relationships in which a Modelable item is referenced.
  • drawing_number (str): Identifier for a drawing (a type of specification).
  • drawing_part_number (str): If a part (product) has a drawing (a type of specification), this is the part identifier specified in the drawing.
  • frozen (bool): A flag indicating that this working version can have no further modifications or iterations. When a specified version of an object is frozen, a new version of the object can be created by cloning the specified version or another version, by cloning another object, or from a clean slate. In general, a freeze can be reversed by an administrator, for example if corrections are needed, and the object can be re-frozen after edits are done -- this should be done using caution since it can effect configuration management.
  • fsc_code (str): The Federal Supply Classification (FSC) code for a product (this is also the first four digits of the National Stock Number or NSN).
  • generic_part_number (str): The generic identifier for a EEE part, which in some cases is specified by a standard (e.g., JEDEC for electronic parts).
  • has_models (Model) [inverse of of_thing]: The known models that exist for this object.
  • id (str): An identifier that is unique within a specified namespace.
  • id_ns (str): The namespace within which an id is unique.
  • iteration (int): An identifier for incremental snapshots of working copies of a specific version of a ManagedObject. Iterations are a zero-based sequence of integers in which the unmodified version is itself the 0th iteration.
  • manufacturer_part_number (str): The identifier assigned to a hardware product by its manufacturer.
  • military_specification (str): The identifier of the military specification (a.k.a. MIL Spec) that applies to a EEE part.
  • mod_datetime (datetime): The date and time of last modification of an object.
  • modifier (Actor): The actor (person, AI, android, gremlin, hobbit, or other agent) that last modified an object.
  • name (str): A human-readable identifier for an object -- usually the one by which the object is known to the end-user, but it may be used for any type of identification, including aliases and local nomenclatures. Its meaning is dependent on the application context. This concept is analogous to a given name.
  • nsn (str): The National Stock Number (NSN) for a EEE part.
  • oid (str): Object ID (a globally unique identifier).
  • owner (Organization): The organizational entity (e.g., a project or a commecial entity) that creates and manages the information about an object. This is an important property for products, specifying the entity that controls it, and especially for systems, which are generally owned by projects that control their specification and versioning.
  • ports (Port) [inverse of of_product]: The Ports owned by a Product.
  • product_type (ProductType): The functional category in which a product has been classified.
  • projects_using_system (ProjectSystemUsage) [inverse of system]: The projects that are using or developing a system.
  • public (bool): A flag indicating whether access to this object is restricted. If true, the object is accessible to anyone. If false, access to the object is governed by whether a user has a relevant role assignment its owner organization.
  • purpose (str): The reason for creating this artifact.
  • q_components (Qacu) [inverse of q_assembly]: The slots or roles (quantified assembly component usages [Qacu]) of the continuous products used to assemble this product.
  • screening_specification_number (str): The identifier for a screening specification that applies to a EEE part.
  • specification_number (str): The identifier of the specification document that applies to a product.
  • specification_part_number (str): The identifier given to a hardware product by its specification.
  • url (str): The Universal Resource Locator for an object.
  • version (str): A user-modifiable alphanumeric string used to identify one in a series of modifications of an object.
  • version_sequence (int): An integer indicating the sequence of versions (since the version attribute itself may not have a well-defined sort order).
  • where_used (Acu) [inverse of component]: Where this product is used (assembly component usages) in any assemblies.

  ---