HasNext
HasPrevious
%import "layer0.graph"
%import "animation.graph"
%import "g3d.graph"
%define symmetric()
    $subject
        $layer0.InverseOf $subject
%define tag($tagname)
    $subject
        $tagname $subject
%deflib Type _ @ "Types" : TypeLibrary
    PartOf Plant3DOntology
%deflib Relation _ @ "Relations" : RelationLibrary
    PartOf Plant3DOntology
%deflib Library Plant3DOntology
Plant3DOntology @ "Plant3D Ontology" : Ontology
    PartOf TypeSystemProject
    HasNamespace "http://www.vtt.fi/Simantics/Plant3D/1.0" : URI
    HasVersion "1.0" : Version
    HasResourceClass "org.simantics.processeditor.stubs.Plant3DResource" : String
    HasStubsPackage "org.simantics.processeditor.stubs" : String

Plant3DNamespace : Namespace
    PartOf TypeSystemNamespaces
    HasNamespace "http://www.vtt.fi/Simantics/Plant3D/1.0" : URI
    HasNamespaceRoot Plant3DOntology
    
# Project
Plant3DProjectType @ "Plant3DProjectType" <T ProjectType
Plant3DProject @ "Plant3DProject" : Plant3DProjectType <T Project
    PartOf ProjectTypes


#****************************************************************************
#
#  PBS structure and components
#
#****************************************************************************

P3DNode @ "P3DNode" <T G3DNode
    HasDescription "Base node for all 3D plant objects. Used as an identifier." : String
PBSNode <T Entity
    HasDescription "Plant Breakdown Structure super type" : String
    HasDescription "Example: Site > Plant > Area > Unit" : String
    [HasParentStructure card "0..1"]
    [HasChildStructure card "0..*"]
HasChildStructure <R IsRelatedTo
    InverseOf HasParentStructure
    HasDomain [PBSNode]
    HasRange [PBSNode]
Plant <T P3DNode <T PBSNode
    HasDescription "Root node of the scene-graph" : String
    HasDescription "Contains Equipment and Pipe Runs (Scene-graph)" : String
    HasDescription "Scene-graph structure IS NOT Plant Breakdown Structure (PBS)" : String
HasGraphics <R IsWeaklyRelatedTo
    HasDescription "link to geometric representation of component or equipment" : String
    HasRange [G3DModel]
LibraryComponent <T P3DNode <T PBSNode
    HasDescription "Base type for librarised components and equipment" : String
    [HasGraphics card "0..1"]
Equipment <T LibraryComponent
    [HasNozzle card "0..1"]
    [HasNozzleDefinition card "0..*"]
    [HasNozzleRestriction card "0..1"]
# TODO : PipeRun should link to Spec and use its information
PipeRun <T P3DNode
    HasDescription "Non visible node" : String
    HasDescription "Contains all pipeline components that contain same specification (size, ..)" : String
    [HasPipeDiameter card "1"]
    [HasTurnRadius card "1"]
    [HasControlPoints card "0..*"]
Nozzle <T LibraryComponent
    [HasPipeDiameter card "1"]
    [HasLength card "1"]
    [HasControlPoint card "0..1"]  #0..1 prevents automatic instantion of control point
PipelineComponent <T LibraryComponent
    [HasPipeDiameter card "1"]
    [HasControlPoint card "0..1"]
SingleConnectedComponent <T PipelineComponent
    HasDescription "A component that is connected to only one component" : String
DualConnectedComponent <T PipelineComponent
    HasDescription "A component that is connected to two components" : String
MultiConnectedComponent <T PipelineComponent
    HasDescription "A component that is connected to more than two components" : String
InlineComponent <T PipelineComponent
    HasDescription "Component that connects to two or more components, and maintains direction of (main) " : String
    HasDescription "pipe run. Centerline of main pipeline may have offset: with offset there is two control " : String
    HasDescription "points for main pipeline, and without offset, there is only one control point for main " : String
    HasDescription "pipeline. The component may also join two pipe runs together: then there is always one " : String
    HasDescription "control point for one pipe run." : String
    [HasLength card "1"]
EndComponent <T PipelineComponent
    HasDescription "Component that ends the pipe run" : String
    HasDescription "Component may contain other control points" : String
TurnComponent <T PipelineComponent
    HasDescription "Component that changes direction of the pipeline" : String
    HasDescription "Component that connects to two or more components, and specifies connectivity of main " : String
    HasDescription "pipe run. Is base type for elbows, pipe bends, etc., but also for components that won't " : String
    HasDescription "maintain main pipeline direction (inline component). CHECK!!!" : String
    [HasTurnAngle card "1"]
FixedLengthInlineComponent <T InlineComponent
    HasDescription "Inline component that has fixed length" : String
    [HasRotationAngle card "1"]
VariableLengthInlineComponent <T InlineComponent
    HasDescription "Inline component whose length can be changed" : String
FixedAngleTurnComponent <T TurnComponent
    HasDescription "Turn Component that has specific turning angle that cannot be changed" : String
    [HasRotationAngle card "1"]
VariableAngleTurnComponent <T TurnComponent
    HasDescription "Turn Component whose turning angle can be modified" : String
    HasDescription "Contains always one control point (there are no contradictory cases / how to calculate?)" : String
    [HasTurnRadius card "1"]
SizeChangeComponent <T FixedLengthInlineComponent
    HasDescription "Component that changes pipe run along main pipeline. (Spec change)" : String
OffsetComponent <T FixedLengthInlineComponent
    HasDescription "Component that offsets the center of piperun." : String  
CodedComponent <T PipelineComponent
    HasDescription "Currently used with non-customizable / hard-coded components" : String
NonVisibleComponent <T PipelineComponent
    HasDescription "(Pseudo) Component that cannot bee seen." : String

#****************************************************************************
#
#  Pipe Control Points
#
#****************************************************************************

# control point base type
PipeControlPoint <T Entity
    HasDescription "Base type" : String
    [HasLocalPosition card "1"]
    [HasWorldPosition card "1"]
    [HasLocalOrientation card "1"]
    [HasWorldOrientation card "1"]
    [HasNext card "0..1"]
    [HasPrevious card "0..1"]
    [HasNext card "0..1"]
    [HasSubPoint card "0..*"]
    [SubPointOf card "0..1"]
    [HasPipeDiameter card "1"]
    [ControlPointOf card "0..1"]
    [ControlPointOfPipeRun card "0..1"]

# divide to path leg ends and inline
PathLegEndControlPoint <T PipeControlPoint
    HasDescription "A control point that ends path leg." : String
InlineControlPoint <T PipeControlPoint
    [HasLength card "1"]

# turns
TurnControlPoint <T PathLegEndControlPoint
    [HasTurnAngle card "1"]
    [HasLength card "1"]                               # TODO : should this be length or something else?
   
FixedAngleTurnControlPoint <T TurnControlPoint         #is this unnecessary ( Fixed angle could be created with EndComponent + Directed as a subpoint)?   
    HasDescription "While variable angle turn control point is positioned by path legs, user is responsible for rotating fixed angle turn components." : String
    [HasRotationAngle card "1"]
    [IsReversed card "1"]
VariableAngleTurnControlPoint <T TurnControlPoint
    [HasTurnRadius card "1"]
    [HasTurnAxis card "1"]                             # this was for update purposes
# inline
VariableLengthControlPoint <T InlineControlPoint
FixedLengthControlPoint <T InlineControlPoint
   [HasRotationAngle card "1"]

RunEndControlPoint <T PathLegEndControlPoint
    HasDescription "Control Point that ends a PipeRun." : String
    HasDescription "Only Next or Previous ControlPoint must be set, and other must be end" : String

# directed and undirected

DirectedControlPoint <T RunEndControlPoint
    [HasLocalOrientation card "1"]
    [HasWorldOrientation card "1"]
#    [HasDirection card "1"]
UndirectedControlPoint <T RunEndControlPoint

EndComponentControlPoint <T UndirectedControlPoint
    [HasRotationAngle card "1"]
    
# for N-Port components (N > 3), defines position and direction of control point relative to main control point 
NPortControlPoint <T DirectedControlPoint
#    [HasRelativePosition card "1"]
#    [HasRelativeDirection card "1"] 

# Size change & Offset
# TODO: could we allow variable length components that offset piperun ? (currently only component that is variable length is straight pipe, so for now: no) 
# note: SizeChange actually ends a piperun, but allows path leg to continue
DualInlineControlPoint <T FixedLengthControlPoint
    HasDescription "FixedLengthInlineControlPoint that has subcontrolpoint in the same PipeRun/Pathleg." : String
    HasDescription "The previous controlpoint is connected (next) to this point and the next point is connected (previous) to subpoint, while this point and the subpoint are connected both the previous and the next point." : String
SizeChangeControlPoint <T DualInlineControlPoint
    HasDescription "Changes PipeRun within the path leg." : String
    HasDescription "This CP belongs to the PipeRun that is the previous side and subpoint belongs to the PipeRun that is on the next side." : String 
OffsettingPoint <T DualInlineControlPoint
    [HasOffset card "1"]
    HasDescription "Offsets the center of the pipe." : String                 
DualSubControlPoint <T FixedLengthControlPoint
    HasDescription "DualInlineControlPoint's subpoint." : String

# nozzle must have its own control point so that we know to link pipe diameters of the nozzle and the piperun
NozzleControlPoint <T DirectedControlPoint

# TODO : is it necessary to model inline control point that has no length?
BranchEndControlPoint <T UndirectedControlPoint
BranchControlPoint <T FixedLengthControlPoint

# TODO : we also need a way to specify if control point can be moved from its current place or not (this may be dynamic)
      

# relation and property definitions

HasControlPoint <R IsRelatedTo
    InverseOf ControlPointOf
    HasDomain [(PipelineComponent or Nozzle)]
    HasRange [PipeControlPoint]
    HasDescription "Relation between PipelineComponent and ControlPoint" : String
HasControlPoints <R IsRelatedTo
    InverseOf ControlPointOfPipeRun
    HasDomain [PipeRun]
    HasRange [PipeControlPoint]
    HasDescription "Relation between PipeRun and ControlPoint" : String
    HasDescription "This is needed because a PipeLineComponent may contain multiple ControlPoints that belong to different PipeRuns." : String
HasNext <R IsWeaklyRelatedTo
    HasDomain [PipeControlPoint]
    HasRange [PipeControlPoint]
    HasDescription "Next point in the piperun" : String
HasPrevious <R IsWeaklyRelatedTo
    HasDomain [PipeControlPoint]
    HasRange [PipeControlPoint]
    HasDescription "Previous point in the piperun" : String
HasSubPoint @ "Has SubPoint" <R IsRelatedTo
    InverseOf SubPointOf
    HasDomain [PipeControlPoint]
    HasRange [PipeControlPoint]
    HasDescription "Subcontrolpoint's position is defined by its parent control point. Local Position of subpoint is its position relative to its parent point similar to child/parent relationship in scene-graph." : String 

HasPipeDiameter <R HasNonTransformation
    HasRange [Double]
HasLength <R HasNonTransformation
    HasRange [Double]
HasTurnAngle <R HasNonTransformation
    HasRange [Double]
HasRotationAngle <R HasTransformation
    HasRange [Double]
HasOffset <R HasProperty
    HasRange [Double]
#HasRelativePosition <R HasProperty
#    HasRange [Position]
#HasRelativeDirection <R HasProperty
#    HasRange [Tuple3]
#HasDirection <R HasProperty
#    HasRange [Tuple3]  
HasTurnRadius <R HasNonTransformation
    HasRange [Double]   
IsReversed <R HasProperty
    HasRange [Boolean]
HasTurnAxis <R HasTransformation
    HasRange [Tuple3]
    
HasNozzleDefinition <R HasProperty
    HasDomain [Equipment]
    HasRange [Nozzle]
    HasDescription "This relation is used to connect nozzles to equipment in the template. For instantiated equipment nozzles must be connected with HasNozzle relation." : String  
HasNozzle <R HasChild
    InverseOf NozzleOf
    HasDomain [Equipment]
    HasRange [Nozzle]
    HasDescription "Used to connect nozzles to equipment." : String
HasNozzleRestriction <R HasMultiplicity
    HasDescription "Used in template equipment to restrict amount of nozzles." : String
    HasDescription "If template has as many nozzleDefinitions that maximum count in this restriction, user cannot add new nozzles to the equipment instance." : String



#****************************************************************************
#
#  Predefined equipment and components
#
#****************************************************************************    
    
    
Reducer <T CodedComponent <T SizeChangeComponent <T FixedLengthInlineComponent <T DualConnectedComponent
#ConcentricReducer <T Reducer
#ConcentricReducerImpl : ConcentricReducer
ConcentricReducer <T Reducer : Reducer
  PartOf Plant3DOntology
  HasRotationAngle "0.0" : Double
  HasControlPoint 
    _ : SizeChangeControlPoint
      HasWorldPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasWorldOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double
      HasLocalPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasLocalOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double
      HasSubPoint
        _ : DualSubControlPoint
          HasWorldPosition
            _ : Position
              HasX "0.0" : Double
              HasY "0.0" : Double
              HasZ "0.0" : Double
          HasWorldOrientation
            _ : Orientation
              HasX "0.0" : Double
              HasY "1.0" : Double
              HasZ "0.0" : Double
              HasAngle "0.0" : Double
          HasLocalPosition
            _ : Position
              HasX "0.0" : Double
              HasY "0.0" : Double
              HasZ "0.0" : Double
          HasLocalOrientation
            _ : Orientation
              HasX "0.0" : Double
              HasY "1.0" : Double
              HasZ "0.0" : Double
              HasAngle "0.0" : Double 
#EccentricReducer <T Reducer <T OffsetComponent
#EccentricReducerImpl : EccentricReducer
EccentricReducer <T Reducer <T OffsetComponent : Reducer : OffsetComponent
  PartOf Plant3DOntology
  HasRotationAngle "0.0" : Double
  HasControlPoint 
    _ : SizeChangeControlPoint : OffsettingPoint
      HasOffset "1.0" : Double #TODO : define an equation that can calculate the offset form pipediameters. This requires relative  
      HasWorldPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasWorldOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double
      HasLocalPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasLocalOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double
      HasSubPoint
        _ : DualSubControlPoint
          HasWorldPosition
            _ : Position
              HasX "0.0" : Double
              HasY "0.0" : Double
              HasZ "0.0" : Double
          HasWorldOrientation
            _ : Orientation
              HasX "0.0" : Double
              HasY "1.0" : Double
              HasZ "0.0" : Double
              HasAngle "0.0" : Double
          HasLocalPosition
            _ : Position
              HasX "0.0" : Double
              HasY "0.0" : Double
              HasZ "0.0" : Double
          HasLocalOrientation
            _ : Orientation
              HasX "0.0" : Double
              HasY "1.0" : Double
              HasZ "0.0" : Double
              HasAngle "0.0" : Double
#Elbow <T CodedComponent <T VariableAngleTurnComponent <T DualConnectedComponent
#ElbowImpl : Elbow
Elbow <T CodedComponent <T VariableAngleTurnComponent <T DualConnectedComponent : CodedComponent : VariableAngleTurnComponent : DualConnectedComponent
  PartOf Plant3DOntology
  HasLength "0.0" : Double
  HasTurnRadius "0.0" : Double
  HasTurnAngle "0.0" : Double
  HasControlPoint 
    _ : VariableAngleTurnControlPoint
      HasWorldPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasWorldOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double
      HasLocalPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasLocalOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double    
#Straight <T CodedComponent <T DualConnectedComponent <T VariableLengthInlineComponent
#StraightImpl : Straight
Straight <T CodedComponent <T DualConnectedComponent <T VariableLengthInlineComponent : CodedComponent : DualConnectedComponent : VariableLengthInlineComponent
  PartOf Plant3DOntology
  HasLength "0.0" : Double
  HasControlPoint 
    _ : VariableLengthControlPoint
      HasWorldPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasWorldOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double
      HasLocalPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasLocalOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double 
          
BranchSplitComponent <T FixedLengthInlineComponent <T NonVisibleComponent : FixedLengthInlineComponent : NonVisibleComponent          
  PartOf Plant3DOntology
  HasLength "0.0" : Double          
  HasControlPoint
    _ : BranchControlPoint
      HasWorldPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasWorldOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double
      HasLocalPosition
        _ : Position
          HasX "0.0" : Double
          HasY "0.0" : Double
          HasZ "0.0" : Double
      HasLocalOrientation
        _ : Orientation
          HasX "0.0" : Double
          HasY "1.0" : Double
          HasZ "0.0" : Double
          HasAngle "0.0" : Double
          
#Tee <T FixedLengthInlineComponent <T MultiConnectedComponent
#BendPipe <T PipeComponent <T VariableAngleTurnComponent <T DualConnectedComponent
#Cap <T EndComponent
#BlindFlange <T EndComponent
#TwoWayBallValve <T FixedLengthInlineComponent <T DualConnectedComponent
#ThreeWayTTypeBallValve <T FixedLengthInlineComponent <T MultiConnectedComponent
#    HasName "Three Way T Type Ball Valve" : String
#ThreeWayYType120DegreeBallValve <T EndComponent <T MultiConnectedComponent
#    HasName "Three Way Y Type 120 Degree Ball Valve" : String
Vessel <T Equipment
VerticalVessel <T Vessel
    [HasHeight card "1"]
HorizontalVessel <T Vessel
    [HasLength card "1"]

HasHeight <R HasNonTransformation
    HasRange [Double]
HasLength <R HasNonTransformation
    HasRange [Double]

#****************************************************************************
#
#  Specs 
#
#****************************************************************************