opcua:Field
Mapped https://mapped.com/schema/mapped/1.0/opcua#Field
One field of a structure DataType: a StructureField of its StructureDefinition (OPC 10000-3 §8.51). opcua:hasDataType points to the field's DataType, as it does for a Variable or Property. Not an OPC UA node and without a NodeId, so not an opcua:Node: its identity is its structure's opcua:nodeId and its opcua:fieldName, which is unique within the structure.
Hierarchy
Parent classes: opcua:Concept
Subclasses: none, this is a leaf class.
Facts
| Fact | Value |
|---|---|
| URI | https://mapped.com/schema/mapped/1.0/opcua#Field |
| Source | Mapped |
| Protobuf | OPCUA_FIELD |
| GraphQL | OPCUAField |
| Deprecated | No |
Properties
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
opcua:arrayDimensions | string | The maximum length of each dimension of an array value, in the opcua.array_dimensions JSON shape: the ArrayDimensions attribute of a Variable or Property (OPC 10000-3 §5.6.2), or StructureField.ArrayDimensions of an opcua:Field (§8.51). One entry per dimension, in order; 0 means the maximum is unknown. Written only when the value is an array. | ||
opcua:fieldIndex | integer | Yes | The 0-based position of an opcua:Field in its structure's StructureDefinition.Fields (OPC 10000-3 §8.48). Edges are unordered, so this keeps the field order, which the binary encoding follows. For a structure that subtypes another, the supertype's fields come first. | |
opcua:fieldName | string | Yes | The Name of an opcua:Field (StructureField.Name, OPC 10000-3 §8.51), as the server spells it and unique within its structure; a decoded structure value (opcua:value) uses it, unchanged, as the field's key. On an opcua:EnumValue of a DataType, EnumField.Name (§8.52), written only when it differs from the label in mapped:name. | |
opcua:isOptional | boolean | StructureField.IsOptional (OPC 10000-3 §8.51) of an opcua:Field. For a StructureWithOptionalFields, true means a value may leave the field out; for the subtyped-value kinds, it allows a subtype of the field's DataType. Written only when true. | ||
opcua:maxStringLength | integer | StructureField.MaxStringLength of an opcua:Field (OPC 10000-3 §8.51): the maximum length in bytes of a String, LocalizedText or ByteString field, per element for an array; 0 means unknown. A Variable's own limit is its MaxStringLength Property, stored as an opcua:Property. | ||
opcua:valueRank | integer | The ValueRank of a Variable or Property (OPC 10000-3 §5.6.2): n > 0 for an array of exactly n dimensions, 0 for one or more dimensions, -1 for a scalar, -2 for a scalar or an array of any rank, -3 for a scalar or one dimension. On an opcua:Field it is StructureField.ValueRank (§8.51), only -1 or n > 0. An array rarely maps to a single Point. |
exactType is always opcua:Field.
Inherited properties (14)
| 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 | |||
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:hasDataType | opcua:DataType | opcua:isDataTypeOf | 0..1 | transitive, canonical From a Variable, Property or opcua:Field to the opcua:DataType of what it holds: the DataType attribute (OPC 10000-3 §5.6.2) of a Variable or Property, or StructureField.DataType (§8.51) of a field. OPC UA has no such reference: each holds the DataType's NodeId, and the edge resolves it to the DataType's vertex. |
opcua:isFieldOf | opcua:DataType | opcua:hasField | 0..1 | The structure opcua:DataType this opcua:Field belongs to: the inverse of opcua:hasField. |
Inherited relationships (10)
| 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. |
isMigratedFrom | Entity | isMigratedTo | 0..* | The entity this entity has been migrated from. This entity supersedes the source. |
isMigratedTo | Entity | isMigratedFrom | 0..* | transitive, canonical The entity this entity has been migrated to. The target supersedes this entity. |
isSubjectOfConstraint | Spatial_Constraint | constrainsSubject | 0..* | The constraints this entity is the subject of. |
Referenced by
Classes whose own relationships point at opcua:Field.
- opcua:hasField (1): opcua:DataType
- opcua:isDataTypeOf (1): opcua:DataType
Something wrong or missing on this page? Propose a change to opcua:Field.