Variables documentation

class Browsable a
fromUri :: Browsable a => String -> <ReadGraph> a (Simantics/DB)
uriOf :: Browsable a => a -> <ReadGraph> String (Simantics/DB)

Returns the URI of the given value.

possibleUriOf :: Browsable a => a -> <ReadGraph> Maybe String (Simantics/DB)

Returns the URI of the given value if it exists or Nothing.

nameOf :: Browsable a => a -> <ReadGraph> String (Simantics/DB)

Reads the name of the value.

possibleNameOf :: Browsable a => a -> <ReadGraph> Maybe String (Simantics/DB)
valueOf :: Browsable a => Serializable b => a -> <ReadGraph> b (Simantics/DB)
genericRelatedValue :: Browsable a => a -> Resource -> <ReadGraph> b (Simantics/DB)
genericPossibleRelatedValue :: Browsable a => a -> Resource -> <ReadGraph> Maybe b (Simantics/DB)
variantValueOf :: Browsable a => a -> <ReadGraph> Variant (Simantics/DB)
children :: Browsable a => a -> <ReadGraph> [a] (Simantics/DB)
parent :: Browsable a => a -> <ReadGraph> a (Simantics/DB)
possibleParent :: Browsable a => a -> <ReadGraph> Maybe a (Simantics/DB)
child :: Browsable a => a -> String -> <ReadGraph> a (Simantics/DB)
possibleChild :: Browsable a => a -> String -> <ReadGraph> Maybe a (Simantics/DB)
ResourceX :: Resource -> VariableOrResource
VariableX :: Variable -> VariableOrResource
browse :: Variable -> String -> <ReadGraph> Variable
browsePossible :: Variable -> String -> <ReadGraph> Maybe Variable
children_ :: Variable -> <ReadGraph> Collection Variable
createValueAccessor :: (Variable -> <ReadGraph> a) -> (Variable -> Binding b -> <ReadGraph> b) -> (Variable -> c -> <WriteGraph> ()) -> (Variable -> d -> Binding d -> <WriteGraph> ()) -> (Variable -> <ReadGraph> Datatype) -> ValueAccessor
createVariableMap :: [Resource] -> VariableMap
datatype :: Variable -> <ReadGraph> Datatype
getIndexRoot :: Variable -> <ReadGraph> Resource
getPossiblePredicateResource :: Variable -> <ReadGraph> Maybe Resource
getPossibleType :: Variable -> <ReadGraph> Maybe Resource
getPossibleTypeWithBaseType :: Variable -> Resource -> <ReadGraph> Maybe Resource
getPredicateResource :: Variable -> <ReadGraph> Resource
getType :: Variable -> <ReadGraph> Resource

Function getType returns the type of the input variable as resource

Example:

import "Simantics/Variables"
import "Apros/Module"
getType (moduleVariable "PO01")

> #275837

nameOf(getType (moduleVariable "PO01"))

> "POINT_QF"
instanceIndexRoot :: Variable -> <ReadGraph> Resource
instantiateUnder :: Resource -> Resource -> <WriteGraph> Resource
modelOfVariable :: Variable -> <ReadGraph> Resource

Function modelOfVariable returns the model, in which the given input variable is located, as Resource

Example:

import "Simantics/Variables"
import "Apros/Module"
my_variable = moduleVariable "PO01"
my_model = modelOfVariable my_variable
my_model

> #376833

// use function nameOf, which works for resources, to print out the name of the model
nameOf(my_model)

> "Model"
modelResourceOfVariable :: Variable -> <ReadGraph> Resource
modelVariableOfVariable :: Variable -> <ReadGraph> Variable

Function modelVariableOfVariable returns the model, in which the given input Variable is located, as Variable

Example:

import "Simantics/Variables"
import "Apros/Module"
my_model_variable = modelVariableOfVariable (moduleVariable "PO01")
my_model_variable

> <variable>

name my_model_variable

> "Model"
name :: Variable -> <ReadGraph> String

Function name return the name of the input variable as string

Example:

import "Simantics/Variables"
import "Apros/Module"
name (moduleVariable "PO01")

> "PO01"
possibleActiveVariable :: Variable -> <ReadGraph> Maybe Variable
possibleConfigurationContext :: Resource -> <ReadGraph> Variable
possibleProperty :: Variable -> String -> <ReadGraph> Maybe Variable
possiblePropertyValue :: Serializable a => Typeable a => Variable -> String -> <ReadGraph> Maybe a
possiblePropertyValue_ :: Variable -> String -> Binding a -> <ReadGraph> Maybe a
possibleRepresents :: Variable -> <ReadGraph> Maybe Resource
possibleResourceVariable :: Resource -> <ReadGraph> Maybe Variable
possibleVariable :: String -> <ReadGraph> Maybe Variable
possibleVariableValue :: Serializable a => Typeable a => Variable -> <ReadGraph> Maybe a
possibleVariableValue_ :: Variable -> Binding a -> <ReadGraph> Maybe a
properties :: Variable -> <ReadGraph> [Variable]

Function properties returns a list, which contains of the properties of the input variable as Variable

Example 1: print out all the properties of certain point as they are shown in Variable Debugger.

import "Simantics/Variables"
import "Apros/Module"
point_properties_list = properties (moduleVariable "PO01")
//print out the names of the properties
for point_properties_list (\x -> print(name x) )

> IncludedInSimulation
> PO11_PRESSURE
> IsDesynchronized
> PO11_PROPERTY_CALC
> PO11_EPM_ROU
> PO11_ELEV_FROM_BOT
...

Example 2: print out only the properties of a point, which name starts as "PO11". Else do nothing.

import "Simantics/Variables"
import "Apros/Module"
point_properties_list = properties (moduleVariable "PO01")
for point_properties_list (\x -> do
    //print out the names of the properties, which name start as "PO11"
    if (take 4 (name x) == "PO11") then do
        print(name x)
        ()
    else do
        ()
)

> PO11_PRESSURE
> PO11_PROPERTY_CALC
> PO11_EPM_ROU
> PO11_ELEV_FROM_BOT
> PO11_NODE_VELOCITY_CALC
...
propertiesClassified :: Variable -> Resource -> <ReadGraph> [Variable]
propertiesClassified_ :: Variable -> Resource -> <ReadGraph> Collection Variable
properties_ :: Variable -> <ReadGraph> Collection Variable
property :: Variable -> String -> <ReadGraph> Variable

Function property return the wanted property as Variable

Input 1: Module which property we want to obtain as Variable

Input 2: Name of the property as String

Output: wanted property as Variable

Example

import "Simantics/Variables"
import "Apros/Module"
my_property_variable = property (moduleVariable "PO01") "PO11_PRESSURE"
my_property_variable

> <variable>
propertyInfoOf :: Resource -> <ReadGraph> PropertyInfo
propertyValue :: Serializable a => Typeable a => Variable -> String -> <ReadGraph> a

Function propertyValue finds the value of given property.

Example: Find out the value of point PO01 attribute PO11_PRESSURE

import "Simantics/Variables"
import "Apros/Module"
propertyValue (moduleVariable "PO01") "PO11_PRESSURE" :: Double

> 0.75
propertyValue_ :: Variable -> String -> Binding a -> <ReadGraph> a
represents :: Variable -> <ReadGraph> Resource

Function represents returns the resource of the given input variable

Input 1: Variable which resource is wanted to be obtainend

Output: Resource of the given input variable.

Example: Find out the resource of given variable

import "Simantics/Variables"
import "Apros/Module"
represents (moduleVariable "PO01")

> #426013
resolvePossible :: RVI -> Variable -> <ReadGraph> Maybe Variable
resourceVariable :: Resource -> <ReadGraph> Variable

Function resourceVariable converts a resource to a corresponding variable.

Example:

import "Simantics/Variables"
import "Apros/Module"
model_id = model "Model"
my_resource = getComponent model_id "PO01"
my_variable = resourceVariable my_resource
my_variable

> <variable>
rviBinding :: <ReadGraph> Binding a

Returns the Binding needed to read RVI type properties.

rviIsEmpty :: RVI -> Boolean

Returns True if the given RVI is empty in which case resolvePossible rvi var would return Just var.

rviOf :: Variable -> <ReadGraph> RVI
sclVariableMap :: (Variable -> <ReadGraph,Proc> [Variable]) -> VariableMap
sclVariableMapWithBasis :: VariableMap -> (Variable -> <ReadGraph,Proc> [Variable]) -> VariableMap
setPropertyValue :: Serializable a => Variable -> String -> a -> <WriteGraph> ()

Function setPropertyValue sets wanted to value to given Variable property.

Input 1: Wanted module as Variable

Input 2: Wanted property name as String

Output: No output, given value is inserted to property

Example:

import "Simantics/Variables"
import "Apros/Module"
setPropertyValue (moduleVariable "PO01") "PO11_PRESSURE" 0.5
setPropertyValue_ :: Variable -> String -> a -> Binding a -> <WriteGraph> ()
setRVIProperty :: Variable -> RVI -> <WriteGraph> ()
setValue :: Variable -> a -> <WriteGraph> ()
standardChildDomainProperties :: VariableMap
standardGetDatatype :: Variable -> <ReadGraph> Datatype
standardGetValue1 :: Variable -> <ReadGraph> a
standardGetValue2 :: Variable -> Binding a -> <ReadGraph> a
standardGraphPropertyVariable :: Variable -> Maybe VariableNode -> Resource -> PropertyInfo -> Resource -> <ReadGraph> Variable
standardGraphPropertyVariableParentPredicate :: Variable -> Resource -> <ReadGraph> Variable
standardPropertyDomainProperties :: VariableMap
standardSetValue2 :: Variable -> a -> <WriteGraph> ()
standardSetValue3 :: Variable -> a -> Binding a -> <WriteGraph> ()
switchPossibleContext :: Variable -> Resource -> <ReadGraph> Maybe Variable
uniqueChild :: Resource -> Resource -> String -> <ReadGraph> Variable
untypedPossiblePropertyValue :: Variable -> String -> <ReadGraph> Maybe a
untypedPossibleVariableValue :: Variable -> <ReadGraph> Maybe a
untypedPropertyValue :: Variable -> String -> <ReadGraph> a
untypedValue :: Variable -> <ReadGraph> a
uri :: Variable -> <ReadGraph> String

Function uri return the uri of given variable. The uri is fetched from the active Experiment

Input 1: wanted variable which uri is needed as Variable

Output: uri of the variable as String

Example:

import "Simantics/Variables"
import "Apros/Module"
uri (moduleVariable "PO01")

>"http://Projects/Development%20Project/Model/Experiment/8ee6b693-891b-438e-a597-9e15a2634e8b/NewGenericDiagram/PO01"
value :: Serializable a => Typeable a => Variable -> <ReadGraph> a
value_ :: Variable -> Binding a -> <ReadGraph> a
variable :: String -> <ReadGraph> Variable

Function variable converts a variable URI to a variable.

Example:

import "Simantics/Variables"
import "Apros/Module"
model_id = model "Model"
my_component = getComponent model_id "PO01"
my_uri = uriOf my_component
my_variable = variable my_uri
my_variable

> <variable>
variableParent :: Variable -> <ReadGraph> Variable

Function variableParent returns the name of the parent variable as Variable

Example:

import "Simantics/Variables"
import "Apros/Module"
my_variable = moduleVariable "PO01"
variableParent my_variable

> <variable>

name (variableParent my_variable)

> "NewGenericDiagram"