Annotation2 module documentation

AnnotationType

AnnotationType represents AnnotationType instance in Simantics ontology (http://www.simantics.org/Annotation-1.0/AnnotationType)

newAnnotationType :: Resource -> <WriteGraph> Resource

Creates new AnnotationType under the given Library instance and returns it without PropertyRelation

newAnnotationType1 :: Resource -> <WriteGraph> (Resource, Resource)

Creates new AnnotationType under the given Library instance. Returns a Tuple2 consisting the AnnotationPropertyRelation and AnnotationType instances.

attachAnnotationType :: Resource -> Resource -> <WriteGraph> Resource

Attaches the given AnnotationType to the given Resource which can be for example a Diagram or a Symbol.

AnnotationValue

AnnotationValue represents AnnotationType instance in Simantics ontology (http://www.simantics.org/Annotation-1.0/AnnotationType)

newAnnotationValue :: Resource -> Resource -> <WriteGraph> Resource

Creates new AnnotationValue under the given Library instance with the AnnotationType reference. Returns the created AnnotationValue.

Didn't find the value 'attachAnnotationValue'.

AnnotationProperty

newAnnotationProperty :: Resource -> <WriteGraph> Resource

Creates new AnnotationProperty under the given AnnotatoinType instance. Returns the created AnnotationProperty.

advancedAnnotationProperty :: Resource -> String -> String -> String -> String -> String -> String -> <WriteGraph> Resource

Creates new AnnotationProperty under the given AnnotationType instance with advanced options for user to define non-default parameters for the following values

  • name
  • type
  • unit
  • range
  • label
  • description
removeAnnotationProperty :: Resource -> <WriteGraph> ()

Removes the given AnnotationProperty instance.

Undocumented entities

copyAnnotationData :: Resource -> Resource -> <WriteGraph> ()
exportAnnotationType :: File -> Resource -> <Proc> ()
getAnnotationNameFromType :: Resource -> <ReadGraph> String
getPossibleAnnotationType :: Resource -> String -> <ReadGraph> Maybe Resource
importAnnotation :: File -> Resource -> <Proc> ()
newAnnotationValueWithName :: Resource -> String -> Resource -> <WriteGraph> Resource
saveAnnotation :: Resource -> Resource -> String -> <WriteGraph> Resource
setAnnotationPropertyValue :: Resource -> Resource -> String -> String -> <WriteGraph> ()
setPropertyDescription :: Resource -> String -> <WriteGraph> ()
setPropertyLabel :: Resource -> String -> <WriteGraph> ()
setPropertyRange :: Resource -> String -> <WriteGraph> ()
setPropertyType :: Resource -> String -> <WriteGraph> ()
setPropertyUnit :: Resource -> String -> <WriteGraph> ()