OpenTAP 9.24
API Reference
Public Member Functions | Properties | List of all members
OpenTap.ITapSerializerPlugin Interface Reference

Species a OpenTAP Serializer plugin. More...

Inheritance diagram for OpenTap.ITapSerializerPlugin:
OpenTap.ITapPlugin OpenTap.ITapSerializerPluginDependencyMarker OpenTap.TapSerializerPlugin OpenTap.Plugins.DefaultValueSerializer OpenTap.Plugins.EventsSerializerPlugin OpenTap.Plugins.ExternalParameterSerializer OpenTap.Plugins.InputOutputRelationSerializer OpenTap.Plugins.TestStepSerializer

Public Member Functions

bool Deserialize (XElement node, ITypeData t, Action< object > setter)
 Called as part for the deserialization chain. Returns false if it cannot serialize the XML element.
More...
 
bool Serialize (XElement node, object obj, ITypeData expectedType)
 Called as part for the serialization chain. Returns false if it cannot serialize the XML element.
More...
 

Properties

double Order [get]
 Priority of the serializer. Defines the order in which the serializers are used. Default is 0.

 

Detailed Description

Species a OpenTAP Serializer plugin.

Member Function Documentation

◆ Deserialize()

bool OpenTap.ITapSerializerPlugin.Deserialize ( XElement  node,
ITypeData  t,
Action< object >  setter 
)

Called as part for the deserialization chain. Returns false if it cannot serialize the XML element.

Parameters
node
t
setter
Returns

Implemented in OpenTap.Plugins.TestStepSerializer, OpenTap.Plugins.ExternalParameterSerializer, OpenTap.Plugins.DefaultValueSerializer, OpenTap.Plugins.EventsSerializerPlugin, OpenTap.Plugins.InputOutputRelationSerializer, and OpenTap.TapSerializerPlugin.

◆ Serialize()

bool OpenTap.ITapSerializerPlugin.Serialize ( XElement  node,
object  obj,
ITypeData  expectedType 
)

Called as part for the serialization chain. Returns false if it cannot serialize the XML element.

Parameters
nodeThe output XML element.
objThe object being deserialized.
expectedTypeThe expected type from deserialization.
Returns
return true if the object could be serialized.

Implemented in OpenTap.Plugins.DefaultValueSerializer, OpenTap.Plugins.ExternalParameterSerializer, OpenTap.Plugins.TestStepSerializer, OpenTap.Plugins.EventsSerializerPlugin, OpenTap.Plugins.InputOutputRelationSerializer, and OpenTap.TapSerializerPlugin.

OpenTAP 9.24 API built Tue Apr 30 2024 13:44:42