opcua:Variable
Mapped https://mapped.com/schema/mapped/1.0/opcua#Variable
An OPC UA data Variable (OPC 10000-3 §5.6.2, §5.6.4): a node that contains a value. Properties are not stored as Variables; they fold into their parent. Live values are timeseries on the mapped:Point that links to the Variable with mapped:hasExternalReference, not attributes of the Variable. A Variable with component Variables is usually a structure, which a Brick Thing may link to instead.
Hierarchy
Parent classes: opcua:Node
Subclasses: none, this is a leaf class.
Facts
| Fact | Value |
|---|---|
| URI | https://mapped.com/schema/mapped/1.0/opcua#Variable |
| Source | Mapped |
| Protobuf | OPCUA_VARIABLE |
| GraphQL | OPCUAVariable |
| Deprecated | No |
Properties
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
opcua:accessLevel | Array<string> | The Variable's AccessLevel attribute (OPC 10000-3 §5.6.2), decoded into the names of its set bits from AccessLevelType (OPC 10000-3 §8.57): CurrentRead, CurrentWrite, HistoryRead, HistoryWrite, SemanticChange, StatusWrite, TimestampWrite. CurrentWrite means the point can be commanded. UserAccessLevel is not stored because it describes the connector's session, not the point. | ||
opcua:dataType | string | BrowseName of the Variable's DataType attribute (OPC 10000-3 §5.6.2), such as Double, Boolean, UInt32, or the name of a vendor enumeration or structure. | ||
opcua:engineeringUnits | string | The Variable's EngineeringUnits Property (OPC 10000-8 §5.3.2.2), an EUInformation (§5.6.4), in the opcua.eu_information JSON shape: namespaceUri, unitId, displayName and description, plus uneceCode, the UNECE common code decoded from unitId (§5.6.4.4). QUDT indexes units by that code, so it is the shortest path from an OPC UA unit to a Brick unit. | ||
opcua:enumStrings | string | The EnumStrings Property of a MultiStateDiscreteType Variable (OPC 10000-8 §5.3.3.3), or of the Variable's Enumeration DataType (OPC 10000-3 §5.8.3), in the opcua.enum_strings JSON shape: an array of texts in which each index is the value it names. | ||
opcua:enumValues | string | The EnumValues Property of a MultiStateValueDiscreteType Variable (OPC 10000-8 §5.3.3.4), or of the Variable's Enumeration DataType (OPC 10000-3 §5.8.3), in the opcua.enum_values JSON shape: an array of {value, displayName, description}. Used where values are not zero-based or have gaps. | ||
opcua:euRange | string | The Variable's EURange Property (OPC 10000-8 §5.3.2.2): the value range likely in normal operation, in the opcua.range JSON shape {low, high}. | ||
opcua:falseState | string | Text of the FalseState Property of a TwoStateDiscreteType Variable (OPC 10000-8 §5.3.3.2): what a false value means, such as STOP, OPEN or DISABLE. | ||
opcua:trueState | string | Text of the TrueState Property of a TwoStateDiscreteType Variable (OPC 10000-8 §5.3.3.2): what a true value means, such as RUN, CLOSE or ENABLE. | ||
opcua:valueRank | integer | The Variable's ValueRank attribute (OPC 10000-3 §5.6.2): -1 for a scalar, and a positive number for an array with that many dimensions. An array rarely maps to a single Point. |
exactType is always opcua:Variable.
Inherited properties (18)
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
connectedDataSourceId | string | The id of the origin data source of an entity. This id is already a part of mappingKey but important for faster query. | ||
connectorIds | Array<string> | The ids of the connectors associated with the entity. | ||
dateCreated | dateTime | Datetime when it is created. | ||
dateUpdated | dateTime | Datetime when it is updated last time. | ||
description | string | |||
enrichmentSourceConnectorId | string | The id of the source connector with which the vertex, whether it's a property bag or a derived entity, is associated. | ||
id | string | Yes | A globally unique ID in Mapped services. | |
isVirtual | boolean | false | If this is true, the corresponding entity is virtual, meaning it doesn't exist in the real world but fabricated in the Mapped's system. | |
mappingKey | string | The origin of the entity. More detailed definition is available at here. | ||
name | string | |||
opcua:browseName | string | The name part of the node's BrowseName (OPC 10000-3 §5.2.4), a QualifiedName; the namespace part is dropped. The DisplayName and Description attributes are stored as mapped:name and mapped:description. | ||
opcua:nodeId | string | Yes | The node's NodeId (OPC 10000-3 §5.2.2) in the string form of OPC 10000-6 §5.1.12: nsu=<namespace URI>;<identifier> for every namespace except 0, and the bare <identifier> (such as i=58) for namespace 0. GUID identifiers are uppercase. It is the deduplication key for OPC UA nodes, so a node must always produce the same string. | |
opcua:typeDefinition | string | BrowseName of the node's HasTypeDefinition target (OPC 10000-3 §7.13), such as AnalogItemType or FolderType. The type is referenced by name rather than stored as a vertex. | ||
opcua:typeDefinitionId | string | NodeId of the node's HasTypeDefinition target, in the opcua:nodeId string form. A namespace-0 type is a bare i=…; for any other type, the nsu= identifies the companion specification or vendor that defines it. | ||
organizationId | string | Yes | The id of the organization that owns the entity. | |
seeAlso | string | |||
systemType | Array<Object> | A system type of the system the entity is associated. | ||
type | Array<Object> | Yes | The entity's types or classes. The types are determined within the class hierarchy. This is an stringified alias for rdf:type. |
Relationships
| Relationship | Targets | Inverse | Cardinality | Notes |
|---|---|---|---|---|
opcua:componentOf | opcua:Object, opcua:Variable | opcua:hasComponent | 0..* | The node this node is a component of: the inverse of opcua:hasComponent, OPC UA's ComponentOf (OPC 10000-5 §11.7). |
opcua:hasComponent | opcua:Variable | opcua:componentOf | 0..* | transitive, canonical A HasComponent reference (OPC 10000-3 §7.7), or any other Aggregates subtype except HasProperty: the target is a part of the source. An Object may have Object and Variable components; a Variable may have only Variable components. These references never form loops. |
Inherited relationships (9)
| Relationship | Targets | Inverse | Cardinality | Notes |
|---|---|---|---|---|
contributesProperty | Meta | hasPropertyContributedFrom | 0..* | transitive, canonical Mapped's internal relationship indicating that a vertex is contributing a property/value to another vertex. |
hasExtendedProperty | ExtendedProperty | 0..* | transitive, canonical The entity's customer-defined extended properties, one node per key-value pair. | |
hasGeneratedArtifact | OpenUSD_Layer | isGeneratedFrom | 0..* | The layers generated from this source. |
hasIdentity | Identity | 0..* | transitive, canonical | |
hasPrimBinding | OpenUSD_Prim_Binding | isPrimBindingOf | 0..* | transitive, canonical Attaches a prim address. Used directly on an entity for pure addressing that carries no physical claim, and on a Representation or level-of-detail heuristic to realise it in USD. |
hasPropertyBag | PropertyBag | 0..* | transitive, canonical | |
isConstraintTarget | Spatial_Constraint | constrainsAgainst | 0..* | The constraints evaluated against this representation or entity. |
isSubjectOfConstraint | Spatial_Constraint | constrainsSubject | 0..* | The constraints this entity is the subject of. |
opcua:organizedBy | opcua:Object, opcua:Server | opcua:organizes | 0..* | The Object or server that groups this node: the inverse of opcua:organizes, OPC UA's OrganizedBy (OPC 10000-5 §11.6). |
Referenced by
Classes whose own relationships point at opcua:Variable.
- hasExternalReference (2): Point, Thing
- opcua:componentOf (1): opcua:Variable
- opcua:hasComponent (2): opcua:Object, opcua:Variable
- opcua:organizes (2): opcua:Object, opcua:Server
Something wrong or missing on this page? Propose a change to opcua:Variable.