Skip to content

Cairn Documentation

Entity Types 11

The data model primitives that make up every Cairn project.

Node

Core building block โ€” system, subsystem, assembly, part, or external actor. Properties bag supports engineering params, evaluation status, the brief and the narrative.

idnametypedescriptionparentIdpropertiespositionsortOrdercreatedBy
Requirement

Functional, performance, interface, safety, environmental, or constraint requirement scoped to a node.

idnodeIdtitledescriptiontypepriorityrationaleacceptanceCriteriasortOrder
Interface

Connection between two nodes carrying typed signals with protocol, rate, and simulation metadata.

idnamesourceNodeIdtargetNodeIdsignalsprotocoldescription
State

Behavioral state in a node's state machine. Supports timing annotations for simulation.

idnametypedescriptionnodeIdpositiontypicalDurationdurationUnit
Transition

State transition with guard condition, action, and optional timing parameters.

idnodeIdsourceStateIdtargetStateIdtriggerguardactiontypicalDuration
Verification

Test, analysis, demonstration, or inspection record linked to a requirement.

idrequirementIdmethodtitledescriptionstatusresults
TraceLink

Traceability relationship: satisfies, implements, verifies, derives, depends_on, or custom.

idtypesourceIdtargetIdsourceKindtargetKindrationaleconfidencestatus
UseCase

Operational scenario with actors, preconditions, postconditions, and ordered steps. An actor is a name, linked to the external actor it matches; a requirement comes from a use case through a derives trace link.

idnodeIdtitledescriptionactorspreconditionspostconditionssteps
Property

Key-value engineering parameter with units, category, and source. Stored in node.properties.params[].

keylabelvalueunitIdcategorysourcedescription
Evaluation

Optional dendritic evaluation on a node, in its parameters: whether it was chosen, is open or was set aside, and why.

evaluationStatusdecisionTypepruneReasonfirstPrincipleevaluationPhasealternativeTocrossDependencies
Maturity

Optional technology maturity on a node, in its parameters: a stage from concept to mature (or deprecated), a confidence and the evidence.

maturity_stagematurity_confidencematurity_notes