Editor

Editor is returned by ua.Model:edit() method. It is used to edit the address space. It has same interface as browser with additional methods to add new nodes to the model.

To save changes to the model you should call editor.save() method. Without saving changes are not committed to the model.

Objects returned from the following methods editor.addXXX() have same interface as objects returned from ua.Model:browse() method plus additional methods to edit the node. All changes made to them are saved in the editor and will be committed to the model when you call editor.save() method.

editor.addObject(browseName, objectType, nodeId, refType)

Add an object to the model under ObjectsFolder node.

BrowseName:

QualifiedName or String Name of the object.

ObjectType:

NodeID | ObjectType object. Object type which will be used as a template for the new object. The hierarchy of object type will be expanded.

NodeId:

Node ID for the new object. If not provided, then new Node ID is generated.

RefType:

Reference type of the object.

Can be:

NodeID of the reference type
String with name of the reference type
Reference Type object
nil - then HasComponent reference type is used.

Example:

  local object = editor:addObject("Sensor")
  object:addVariable("Temperature", {Type=ua.VariantType.Double, Value=20})

editor.addObjectType(browseName)

Add an object type to the model.

BrowseName:: QualifiedName or String Name of the object.
Returns:: ObjectType

Example:

-- Add a sensor object type. This object type will be used
-- to create instances of sensors.
local sensorObjectType = modelEditor:addObjectType("SensorType")
-- Add a property to the sensor object type
local addressProp = sensorObjectType:addProperty("Address",
    {Type = ua.VariantType.Int32, Value = 1})

local objectsFolder = modelEditor:objectsFolder()
local sensorFolder = objectsFolder:addFolder("Sensors")

editor.addVariableType(browseName)

Add a variable type to the model.

Returns:: VariableType

Example:

-- Add a variable type for the sensor data
-- Variables of this type will have root node with structured value and
-- underlying hierarchy of fields will be expanded.
local sensorVariableDataType = modelEditor:addVariableType("SensorVariableDataType", nil, sensorDataType)
-- Add a variable to the sensor object type
local sensorDataVariable = sensorObjectType:addVariable("Data", nil, sensorVariableDataType)
sensorDataVariable.Attrs.Description = {Text="Current measured sensor data"}

editor.addReferenceType(browseName)

Add a reference type to the model.

Returns:: Reference Type

editor.addEnum(browseName, values, nodeId)

Add an enum to the model.

Values:: Array of string. Each value is a name of the enum value, values are assigned in the order they are defined.
Returns:: Enum.

Example:

-- Add enum for the sensor data
local sensorDataEnum = modelEditor:addEnum("PrecisionType", {
  "Low",
  "Medium",
  "High",
})

editor.addStructure(browseName, nodeId)

Add a structure to the model.

BrowseName:: QualifiedName or String Name of the structure.
NodeId:: Node ID for the new structure. If not provided, then new Node ID is generated.
Returns:: Structure That can be used to add fields to the structure.

Example:

-- Add a structure type for the sensor data
local sensorDataType = modelEditor:addStructure("SensorDataType")
sensorDataType:addField("Temperature", ua.DataTypeId.Double, ua.ValueRank.Scalar)
sensorDataType:addField("Humidity", ua.DataTypeId.Double, ua.ValueRank.Scalar)
sensorDataType:addField("Precision", ua.DataTypeId.Enumeration, ua.ValueRank.Scalar)

editor.save()

Save the model.

Returns:: nil

Example:

local modelEditor = server.model:edit()
local objectsFolder = modelEditor:objectsFolder()
local sensorFolder = objectsFolder:addFolder("Sensors")
local sensor1 = sensorFolder:addObject("Outside", sensorObjectType)
local sensor2 = sensorFolder:addObject("Inside", sensorObjectType)

-- Save the changes to the model
modelEditor:save()

editor.objectsFolder()

Returns ‘ObjectsFolder’.

Returns:: Object that can be used for editing objects under ObjectsFolder.

Example:

local modelEditor = server.model:edit()
-- Get ObjectsFolder node
local objectsFolder = modelEditor:objectsFolder()
-- Create to node folders and add some variables to them
local folder1 = objectsFolder:addFolder("Folder1")

Object

object.addProperty(browseName, propertyType, nodeId, refType)

Add a property to the object.

BrowseName:: QualifiedName | String Name of the property.
PropertyType:: (optional) NodeID | DataType. Property type which will be used as a template for the new property.
NodeId:: (optional) Node ID for the new property. If not provided, then new Node ID is generated.
RefType:: (optional) Reference type of the property.
Returns:: Variable object.

Example:

  local configurationObject = object:addObject("Configuration")
  configurationObject:addProperty("Address", {Type=ua.VariantType.String, Value="1"})
  configurationObject:addProperty("Port", {Type=ua.VariantType.UInt16, Value=1234})

object.addVariable(browseName, value, variableType, nodeId, refType)

Add a variable to the object.

BrowseName:: (String or QualifiedName) Name of the variable.
Value:: (DataValue or Variant or nil) Value of the variable.
VariableType:: (NodeID or VariableType or nil) Variable type which will be used as a template for the new variable. The hierarchy of variable type will be expanded. If not provided, then BaseDataVariableType is used.
NodeId:: (NodeID or nil) Node ID for the new variable. If not provided, then new Node ID is generated.
RefType:: (NodeID or String or Reference Type or nil) Reference type of the variable. If not provided, then HasComponent reference type is used.
Returns:: Variable object.

Example:

  local editor = model:edit()

  local object = editor:addObject("Sensor")
  object:addVariable("Temperature", {Type=ua.VariantType.Double, Value=20})

object.addObject(browseName, objectType, nodeId, refType)

Add an sub-object to the object.

BrowseName:

QualifiedName or String Name of the object.

ObjectType:

NodeID | ObjectType object. Object type which will be used as a template for the new object. The hierarchy of object type will be expanded.

NodeId:

Node ID for the new object. If not provided, then new Node ID is generated.

RefType:

Reference type of the object.

Can be:

NodeID of the reference type
String with name of the reference type
Reference Type object
nil - then HasComponent reference type is used.

Returns:

Example:

  local editor = model:edit()

  local object = editor:addObject("Sensor")
  object:addVariable("Temperature", {Type=ua.VariantType.Double, Value=20})
  local configurationObject = object:addObject("Configuration")
  configurationObject:addProperty("Address", {Type=ua.VariantType.String, Value="1"})

object.addFolder(browseName)

Add Folder which stores other nodes (like ‘ObjectsFolder’)

Returns:: Object with newly created folder

-- Get ObjectsFolder node
local objectsFolder = modelEditor:objectsFolder()
-- Create to node folders and add some variables to them
local folder1 = objectsFolder:addFolder("Folder1")

object.addMethod(browseName, func, inputArguments, outputArguments, nodeId)

Add a method to the Object.

Func:

Function to be called when the method is called by client.

InputArguments:

Array with description of input arguments. Each argument is a table with following fields:

Name
DataType
ValueRank (optional)
ArrayDimensions (optional)
Description (optional)

OutputArguments:

Array with description of output arguments. Each argument is a table with following fields:

Name
DataType
ValueRank
ArrayDimensions
Description

NodeId:

(optional) Node ID for the new method. If not provided, then new Node ID is generated.

Example:

  local inputArguments = {
    {Name = "Address",  DataType = ua.DataTypeId.String},
    {Name = "Port",     DataType = ua.DataTypeId.UInt16},
    {Name = "Enabled",  DataType = ua.DataTypeId.Boolean},
  }

  local outputArguments = {
    {Name = "Result",  DataType = ua.DataTypeId.StatusCode},
  }

  local func = function(address, port, enabled)
    trace(string.format("New configuration: address=%s, port=%d, enabled=%s",
      address, port, enabled))

    return {
      {Name="Result", {Type = ua.DataTypeId.StatusCode, Value = ua.StatusCode.Good}}
    }
  end

  local method = object:addMethod("SetConfiguration",
    func, inputArguments, outputArguments)

Returns:: Method

object.getProperty(browseName)

Get a property from the object.

Returns:: Variable

object.getVariable(browseName)

Get a variable from the object.

Returns:: Variable

object.getComponent(browseName)

Get a component from the object.

Returns:: Object

object.getMethod(browseName)

Get a method from the object.

Returns:: Method

object.path(names)

Resolve node by path relative to current object.

Throws:: Error if path is not found.
Returns:: Node corresponding to the path.

ObjectType

objectType.addProperty(browseName, value, variableType, nodeId, refType)

Add a property to the object.

BrowseName:: QualifiedName | String Name of the property.
PropertyType:: (optional) NodeID | DataType. Property type which will be used as a template for the new property.
NodeId:: (optional) Node ID for the new property. If not provided, then new Node ID is generated.
RefType:: (optional) Reference type of the property.
Returns:: Variable object.

Example:

-- Add a sensor object type. This object type will be used
-- to create instances of sensors.
local sensorObjectType = modelEditor:addObjectType("SensorType")
-- Add a property to the sensor object type

objectType.addVariable(browseName, value, variableType, nodeId, refType)

Add a variable to the object.

BrowseName:: (String or QualifiedName) Name of the variable.
Value:: (DataValue or Variant or nil) Value of the variable. If not provided, then nil is used.
VariableType:: (NodeID or VariableType or nil) Variable type which will be used as a template for the new variable. The hierarchy of variable type will be expanded. If not provided, then BaseDataVariableType is used.
NodeId:: (NodeID or nil) Node ID for the new variable. If not provided, then new Node ID is generated.
RefType:: (NodeID or String or Reference Type or nil) Reference type of the variable. If not provided, then HasComponent reference type is used.
Returns:: Variable object.

Example:

-- Add a sensor object type. This object type will be used
-- to create instances of sensors.
local sensorObjectType = modelEditor:addObjectType("SensorType")
-- Add a variable to the sensor object type
local sensorDataVariable = sensorObjectType:addVariable("Data", nil, sensorVariableDataType)
sensorDataVariable.Attrs.Description = {Text="Current measured sensor data"}

objectType.addObject(browseName, objectType, nodeId, refType)

Add an sub-object to the object.

BrowseName:

QualifiedName or String Name of the object.

ObjectType:

NodeID | ObjectType object. Object type which will be used as a template for the new object. The hierarchy of object type will be expanded.

NodeId:

Node ID for the new object. If not provided, then new Node ID is generated.

RefType:

Reference type of the object.

Can be:

NodeID of the reference type
String with name of the reference type
Reference Type object
nil - then HasComponent reference type is used.

Returns:

Example:

-- Add a sensor object type. This object type will be used
-- to create instances of sensors.
local sensorObjectType = modelEditor:addObjectType("SensorType")
-- Add an object to the sensor object type
local busObject = sensorObjectType:addObject("Bus")
busObject.Attrs.Description = {Text="Ethernet bus object"}

objectType.addFolder(browseName)

Add Folder which stores other nodes (like ‘ObjectsFolder’) Parameters are the same as for object.addFolder().

Returns:: Object with newly created folder

Example:

-- Add a sensor object type. This object type will be used
-- Add an object to the sensor object type
local gpioFolder = sensorObjectType:addFolder("GPIO Pins")
gpioFolder:addVariable("GPIO 1", {Type = ua.VariantType.Int32, Value = 1})
gpioFolder:addVariable("GPIO 2", {Type = ua.VariantType.Int32, Value = 2})
gpioFolder:addVariable("GPIO 3", {Type = ua.VariantType.Int32, Value = 3})

objectType.addMethod(browseName, func, inputArguments, outputArguments[, nodeId])

Add a method to the object type.

Func:

Function to be called when the method is called by client.

InputArguments:

Array with description of input arguments of a method. Each argument is a table with following fields:

Name
DataType
ValueRank (optional)
ArrayDimensions (optional)
Description (optional)

OutputArguments:

Array with description of output arguments of a method. Each argument is a table with following fields:

Name
DataType
ValueRank
ArrayDimensions
Description

Throws:

Error in case of errors.

Returns:

Example:

-- Add a sensor object type. This object type will be used
-- to create instances of sensors.
local sensorObjectType = modelEditor:addObjectType("SensorType")
-- Add a method to the sensor object type
local function measureSensor(objectId, methodId, isAsync)
  if isAsync then
    return ua.StatusCode.Good
  end

  return ua.StatusCode.Good
end
local inputArguments = {
  {Name = "IsAsync",  DataType = ua.DataTypeId.Boolean},
}
local outputArguments = {
  {Name = "Status",  DataType = ua.DataTypeId.StatusCode},
}
local measureMethod = sensorObjectType:addMethod("Measure",
    measureSensor, inputArguments, outputArguments)
measureMethod.Attrs.Description = {Text="Measure the temperature of the sensor"}

objectType.getProperty(browseName)

Get a property from the object.

Returns:: Variable

objectType.getVariable(browseName)

Get a variable from the object.

Returns:: Variable

objectType.getComponent(browseName)

Get a component from the object.

Returns:: Object

objectType.getMethod(browseName)

Get a method from the object.

Returns:: Method

objectType.path(names)

Resolve node by path relative to current object.

Returns:: Node corresponding to the path.

Variable

variable.addVariable(browseName, value, variableType, nodeId, refType)

Add a variable to the object.

BrowseName:: (String or QualifiedName) Name of the variable.
Value:: (DataValue or Variant or nil) Value of the variable.
VariableType:: (NodeID or VariableType or nil) Variable type which will be used as a template for the new variable. The hierarchy of variable type will be expanded. If not provided, then BaseDataVariableType is used.
NodeId:: (NodeID or nil) Node ID for the new variable. If not provided, then new Node ID is generated.
RefType:: (NodeID or String or Reference Type or nil) Reference type of the variable. If not provided, then HasComponent reference type is used.
Returns:: Variable object.

Example:

-- Add a variable for the sensor data
local objectsFolder = modelEditor:objectsFolder()

local sensorDataVariable = objectsFolder:addVariable("SensorData")
sensorDataVariable:addVariable("Temperature",
    {Type = ua.VariantType.Double, Value = 20})

sensorDataVariable:addVariable("Humidity",
    {Type = ua.VariantType.Double, Value = 50})

variable.getVariable(browseName)

Get a chile node variable by name.

Returns:: Variable

variable.path(names)

Resolve node by path relative to current variable.

Returns:: Node corresponding to the path.

VariableType

Variable type is a type of variable. It is used to describe the type of variable. When create a variable the variable type is used as a template for the new variable. If variable is structured then VariableType is used as a template for the new variable and its underlying hierarchy.

For example variable type BuildInfoType represents a structure with the following fields:

ProductUri
ManufacturerName
ProductName
SoftwareVersion

After creating a variable with type BuildInfoType, the variable will have the same fields as the variable type. Root node will single structured value. For convinience, editor will expand hierarchy with fields in the underlying hierarchy. For each field fill be created separate variable node with the same type as the field.

BuildInfo - Structured value
- ProductUri - String
- ManufacturerName - String
- ProductName - String
- SoftwareVersion - String

variableType.addVariable(browseName, value, variableType, nodeId, refType)

Add a variable to the object.

BrowseName:: (String or QualifiedName) Name of the variable.
Value:: (DataValue or Variant or nil) Value of the variable.
VariableType:: (NodeID or VariableType or nil) Variable type which will be used as a template for the new variable. The hierarchy of variable type will be expanded. If not provided, then BaseDataVariableType is used.
NodeId:: (NodeID or nil) Node ID for the new variable. If not provided, then new Node ID is generated.
RefType:: (NodeID or String or Reference Type or nil) Reference type of the variable. If not provided, then HasComponent reference type is used.
Returns:: Variable object.

Example:

-- Add a variable type for the sensor data
-- Variables of this type will have root node with structured value and underlying hierarchy of fields will be expanded.
local sensorVariableDataType = modelEditor:addVariableType("SensorVariableType")
sensorVariableDataType:addVariable("Temperature",
    {Type = ua.VariantType.Double, Value = 20})

sensorVariableDataType:addVariable("Humidity",
    {Type = ua.VariantType.Double, Value = 50})

variableType.getVariable(browseName)

Get a chile node variable by name.

Returns:: Variable

variableType.path(names)

Resolve node by path relative to current variable type.

Throws:: Error if path is not found.
Returns:: Node corresponding to the path relative to current variable type.

Enum

enum.setValues(values)

Set values for the enum.

Values:: Array of string. Each value is a name of the enum value, values are assigned in the order they are defined.
Returns:: nil

Example:

local values = sensorDataEnum:getValues()
for i, value in ipairs(values) do
  print(value)
end

-- Add a new value to the enum
sensorDataEnum:setValues({"Low", "Medium", "High", "VeryHigh"})

enum.getValues()

Get values for the enum.

Returns:: Array of string. Each value is a name of the enum value, values are assigned in the order they are defined.

Example:

local values = sensorDataEnum:getValues()
for i, value in ipairs(values) do
  print(value)
end

Structure

Structure is a complex data type. It is a collection of fields. Structure types describes how to encode and decode the structure. Fileds are encoded in the order they are defined.

structure.setFields(fields)

Set fields for the structure.

Fields:

Array of tables with description of fields. Each field is a table with following fields:

Name
DataType
ValueRank
ArrayDimensions
Description

Returns:

nil

Example:

local fields = {
  {
    Name = "Temperature",
    DisplayName = {Text = "Temperature"},
    DataType = ua.DataTypeId.Double,
    ValueRank = ua.ValueRank.Scalar,
    IsOptional = false
  },
  {
    Name = "Humidity",
    DisplayName = {Text = "Humidity"},
    DataType = ua.DataTypeId.Double,
    ValueRank = ua.ValueRank.Scalar,
    IsOptional = false
  },
  {
    Name = "Precision",
    DisplayName = {Text = "Precision"},
    DataType = ua.DataTypeId.Enumeration,
    ValueRank = ua.ValueRank.Scalar,
    IsOptional = false
  },
}
sensorDataType:setFields(fields)

structure.getFields()

Get fields for the structure.

Returns:

Array of fields. Each field is a table with following fields:

Name
DataType
ValueRank
ArrayDimensions
Description

Example:

local allFields = sensorDataType:getFields()
for _, field in ipairs(allFields) do
  print(field.Name, field.DisplayName, field.DataType, field.ValueRank, field.IsOptional)
end

structure.getField(fieldName)

Get field for the structure.

FieldName:: Name of the field.
Returns:: Field.

Example:

local field = sensorDataType:getField("Precision")
print(field.Name, field.DisplayName, field.DataType, field.ValueRank, field.IsOptional)

Method

method.setInputArguments(inputArguments)

Set input arguments for the method.

InputArguments:: Array with description of input arguments. Each argument is a table with following fields:
Returns:: nil

Example:

local inputArguments = {
  {Name = "IsAsync",  DataType = ua.DataTypeId.Boolean},
  {Name = "Unit",  DataType = ua.DataTypeId.String},
}
measureMethod:setInputArguments(inputArguments)

method.setOutputArguments(outputArguments)

Set output arguments for the method.

OutputArguments:: Array with description of output arguments. Each argument is a table with following fields:
Returns:: nil

Example:

local outputArguments = {
  {Name = "Status",  DataType = ua.DataTypeId.StatusCode},
  {Name = "Temperature",  DataType = ua.DataTypeId.Double},
}
measureMethod:setOutputArguments(outputArguments)

Reference Type

Reference type represents a kind of a reference between nodes.

referenceType.path(names): Resolve node by path relative to current reference type.