Variables documentation

Things that are addressed by URI and browsed as a tree of named children. Both Resource and Variable are browsable: a resource is browsed through the resources it consists of, a variable through its own child structure.

Returns the variable reached from the given variable by the given relative path. The path may mix child steps and property steps, for example Diagram/PO01#PO11_PRESSURE.

Like browse, but returns Nothing if the path does not resolve.

Returns all children of the given variable as a Java collection. children returns the same as a list.

Creates a value accessor from the five functions that implement reading and writing the value of a variable: reading with the default binding, reading with an explicit binding, writing with the default binding, writing with an explicit binding, and resolving the datatype of the value.

Creates a variable map whose children are the given resources, each becoming a child variable named by its L0.HasName. Use it to define a custom variable space from SCL.

Returns the datatype of the value of the given variable.

Returns the index root, typically the model or the ontology, that the given variable belongs to.

Like getPredicateResource, but returns Nothing when there is no predicate resource.

Like getType, but returns Nothing if the type of the variable cannot be determined.

Returns the type of the given variable that inherits from the given base type, or Nothing if the variable has no such type.

Returns the resource of the relation through which the given property variable was reached. Fails if the variable is not a property or has no predicate 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"

Returns the index root, typically the model or the ontology, that the given variable belongs to.

Creates a new instance of the given type under the given container and returns it. By default the instance is attached to the container with L0.ConsistsOf and given a fresh name derived from the type, but a type can define its own methods#instantiateUnder function to do something else. Requires a write transaction.

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"

Returns the model that contains the given variable. Same as modelOfVariable, which returns the same resource typed as Model.

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"

Function name return the name of the input variable as string

Example:

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

> "PO01"

Returns the counterpart of the given configuration variable in the currently active experiment run of its model. Returns Nothing if the variable has no model, if the model has no active run, or if the run has no variable at the same path.

Returns the configuration variable of the model that the given resource belongs to. The resource may be the model itself or any resource under it. Fails if no model or no configuration is found; despite the name it has no Maybe result.

Like property, but returns Nothing if the variable has no property with the given name.

Like propertyValue, but returns Nothing if the variable has no such property or the property has no value.

Returns the value of the named property decoded with the given binding, or Nothing if there is no such property or it has no value.

Like represents, but returns Nothing if the variable does not correspond to any resource.

Returns the variable that corresponds to the given resource, or Nothing if the resource has no place in the variable tree. If the resource itself has no URI, the variable of its owner is looked up and searched for a child that has the resource's name or represents it.

Returns the variable at the given variable URI, or Nothing if there is no such variable.

Like value, but returns Nothing if the variable has no value.

Returns the value of the given variable decoded with the given binding, or Nothing if the variable has no value.

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
...

Returns those properties of the given variable that carry the given classification resource.

Returns those properties of the given variable that carry the given classification resource, as a Java collection. propertiesClassified returns the same as a list.

Returns all properties of the given variable as a Java collection. properties returns the same as a list.

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>

Returns the cached PropertyInfo of the given property relation.

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

Returns the value of the named property of the given variable, decoded with the given binding.

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

Follows the given RVI from the given variable and returns the variable it leads to, or Nothing if some step of the path does not resolve.

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>

Returns the Binding needed to read RVI type properties.

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

Returns the RVI of the given variable, relative to the nearest enclosing context.

Creates a variable map whose children of a variable are the variables produced by the given function.

Like sclVariableMap, but the variables produced by the function are added on top of those of the given basis map, replacing any that have the same name.

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

Writes the value of the named property of the given variable, encoding it with the given binding. Requires a write transaction and fails if the property is not writable.

Writes the given RVI as the value of the given RVI-valued property variable. The old literal is removed and a new one claimed on the parent resource. Requires a write transaction.

Writes the value of the given variable, using the default binding for the class of the value. Requires a write transaction and fails if the variable is not writable.

The variable map that resolves the properties of a variable that represents an entity. It is the default value of the L0.domainProperties property for entities.

The default implementation for resolving the datatype of the value of a variable.

The default implementation for reading the value of a standard graph property variable, using the default binding of the property.

The default implementation for reading the value of a standard graph property variable with the given binding.

Creates a standard graph property variable for the property described by the given PropertyInfo on the given parent resource, under the given parent variable. The VariableNode is the external data source node that backs the property, or Nothing when the value lives in the graph, and the last argument is the resource the property variable represents.

Creates a standard graph property variable for the property reached from the given parent variable through the given predicate resource.

The variable map that resolves the properties of a variable that is itself a property, such as the Unit in .../PI_X#PI_MASS_FLOW#Unit. It is the default value of the L0.domainProperties property for properties.

The default implementation for writing the value of a standard graph property variable, using the default binding for the class of the value. Requires a write transaction.

The default implementation for writing the value of a standard graph property variable with the given binding. Requires a write transaction.

Returns the variable at the same relative path as the given variable but under the given context resource, for example the same property in another experiment run. Returns Nothing if the variable has no enclosing context or if the given context has nothing at that path.

Searches the index of the given model for an instance of the given type with the given name and returns it as a variable. Fails if the index has no match; if it has several, the first one is returned.

Like untypedPropertyValue, but returns Nothing instead of failing when the property or its value is missing.

Like untypedValue, but returns Nothing instead of failing when the variable has no value.

Returns the value of the named property without checking that it has the expected SCL type. propertyValue is the type safe version.

Returns the value of the given variable using the binding of its datatype, without checking that the value has the expected SCL type. value is the type safe version.

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"

Returns the value of the given variable, decoded with the default binding of the expected SCL type.

Returns the value of the given variable, decoded with the given binding.

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>

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"