The SerializationEntityType ObjectType defines the SerializationProcess. It has SerializationProperties which allow the configuration of the SerializationProcess and the SerializationScope.

The SerializationEntityType is formally defined in Table 1 and illustrated in Figure 7.

image010.png

Figure 7 – SerializationEntityType components

Table 1 – SerializationEntityType definition

Attribute

Value

BrowseName

SerializationEntityType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

HasComponent

Variable

SerializedData

Structure

BaseDataVariableType

M

Serialization filter Properties

HasProperty

Variable

IncludeReferenceTypes

NodeId[]

PropertyType

O,R

HasProperty

Variable

ExcludeReferenceTypes

NodeId[]

PropertyType

O,R

HasProperty

Variable

SerializationDepth

UInt16

PropertyType

O,R

HasProperty

Variable

ConsiderSubElementSerializationProperties

Boolean

PropertyType

O,R

HasProperty

Variable

CustomMetaDataProperties

KeyValuePair[]

PropertyType

O,R

HasProperty

Variable

CustomMetaDataRef

NodeId

PropertyType

O,R

HasProperty

Variable

IncludeStatus

Boolean

PropertyType

O,R

HasProperty

Variable

IncludeSourceTimestamp

Boolean

PropertyType

O,R

HasProperty

Variable

IncludeDictionaryReference

Boolean

PropertyType

O,R

Configuration of the SerializationEntity (requires locking)

HasComponent

Method

ConfigureSerialization

see 6.3.3

O

Conformance Units

ObjectSerialization Base

The SerializationProperties are described starting with clause 6.3.4. The default settings in Table 2 apply for Properties that are not provided on a SerializationEntityType instance.

Table 2 – Default values for serialization filter Properties

Property Name

Default setting

IncludeReferenceTypes

[HasChild]

ExcludeReferenceTypes

[] //empty array

SerializationDepth

1

ConsiderSubElementSerializationProperties

False

CustomMetaDataProperties

[] //empty array

CustomMetaDataRef

{0}

IncludeStatus

False

IncludeSourceTimestamp

False

IncludeDictionaryReference

False