opcua::DataTypeBuilder< T, Tag, U > Class Template Reference

#include <datatype.hpp>

Detailed Description

template<typename T, typename Tag = detail::TagDataTypeAny, typename U = struct DeferT>
class opcua::DataTypeBuilder< T, Tag, U >

Builder to create DataType definitions of custom types.

The attributes memSize, padding, pointerFree, isArray and isOptional are automatically deduced from the types itself.

Definition at line 257 of file datatype.hpp.

Public Member Functions
template<auto U::* field>
auto &	addField (const char *fieldName, const UA_DataType &fieldType)
template<auto U::* field>
auto &	addField (const char *fieldName)
template<auto U::* fieldSize, auto U::* fieldArray>
auto &	addField (const char *fieldName, const UA_DataType &fieldType)
template<auto U::* fieldSize, auto U::* fieldArray>
auto &	addField (const char *fieldName)
template<auto U::* memberUnion, typename TField >
auto &	addUnionField (const char *fieldName, const UA_DataType &fieldType)
template<auto U::* memberUnion, typename TField >
auto &	addUnionField (const char *fieldName)
DataType	build ()

Static Public Member Functions
static auto	createEnum (const char *typeName, NodeId typeId, NodeId binaryEncodingId)
static auto	createStructure (const char *typeName, NodeId typeId, NodeId binaryEncodingId)
static auto	createUnion (const char *typeName, NodeId typeId, NodeId binaryEncodingId)

Friends
template<typename , typename , typename >
class	DataTypeBuilder

Member Function Documentation

createEnum()

template<typename T , typename Tag , typename U >

auto opcua::DataTypeBuilder< T, Tag, U >::createEnum ( const char * typeName, NodeId typeId, NodeId binaryEncodingId )

static

Build a DataType definition for an enum.

Parameters

typeName	Human-readable type name
typeId	NodeId of the type
binaryEncodingId	NodeId of data type when encoded as binary

Examples

custom_datatypes/custom_datatypes.hpp.

Definition at line 368 of file datatype.hpp.

createStructure()

template<typename T , typename Tag , typename U >

auto opcua::DataTypeBuilder< T, Tag, U >::createStructure ( const char * typeName, NodeId typeId, NodeId binaryEncodingId )

static

Build a DataType definition for a structure.

A structure may have optional fields (pointers).

Parameters

typeName	Human-readable type name
typeId	NodeId of the type
binaryEncodingId	NodeId of data type when encoded as binary

Examples

custom_datatypes/custom_datatypes.hpp.

Definition at line 384 of file datatype.hpp.

createUnion()

template<typename T , typename Tag , typename U >

auto opcua::DataTypeBuilder< T, Tag, U >::createUnion ( const char * typeName, NodeId typeId, NodeId binaryEncodingId )

static

Build a DataType definition for an union.

Union type consist of a switch field and the actual union.

Parameters

typeName	Human-readable type name
typeId	NodeId of the type
binaryEncodingId	NodeId of data type when encoded as binary

Examples

custom_datatypes/custom_datatypes.hpp.

Definition at line 400 of file datatype.hpp.

addField() [1/4]

template<typename T , typename Tag , typename U >

template<auto U::* field>

auto & opcua::DataTypeBuilder< T, Tag, U >::addField	(	const char *	fieldName,
		const UA_DataType &	fieldType )

Add a structure field.

Template Parameters

field

Member pointer, e.g. &S::value

Parameters

fieldName	Human-readable field name
fieldType	Member data type

Definition at line 417 of file datatype.hpp.

addField() [2/4]

template<typename T , typename Tag = detail::TagDataTypeAny, typename U = struct DeferT>

template<auto U::* field>

auto & opcua::DataTypeBuilder< T, Tag, U >::addField ( const char * fieldName )

inline

Add a structure field (derive DataType from field).

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 299 of file datatype.hpp.

addField() [3/4]

template<typename T , typename Tag , typename U >

template<auto U::* fieldSize, auto U::* fieldArray>

auto & opcua::DataTypeBuilder< T, Tag, U >::addField	(	const char *	fieldName,
		const UA_DataType &	fieldType )

Add a structure array field.

Arrays must consists of two fields: its size (of type size_t) and the pointer to the data. No padding allowed between the size field and the array field.

Template Parameters

fieldSize	Member pointer to the size field, e.g. &S::length
fieldArray	Member pointer to the array field, e.g. &S::data

Parameters

fieldName	Human-readable field name
fieldType	Member data type

Definition at line 446 of file datatype.hpp.

addField() [4/4]

template<typename T , typename Tag = detail::TagDataTypeAny, typename U = struct DeferT>

template<auto U::* fieldSize, auto U::* fieldArray>

auto & opcua::DataTypeBuilder< T, Tag, U >::addField ( const char * fieldName )

inline

Add a structure array field (derive DataType from fieldArray).

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 320 of file datatype.hpp.

addUnionField() [1/2]

template<typename T , typename Tag , typename U >

template<auto U::* memberUnion, typename TField >

auto & opcua::DataTypeBuilder< T, Tag, U >::addUnionField	(	const char *	fieldName,
		const UA_DataType &	fieldType )

Add a union field.

Template Parameters

memberUnion	Member pointer to the union, e.g. &S::Uni
TField	Type of the union field

Parameters

fieldName	Human-readable field name
fieldType	Data type of the union field

Definition at line 477 of file datatype.hpp.

addUnionField() [2/2]

template<typename T , typename Tag = detail::TagDataTypeAny, typename U = struct DeferT>

template<auto U::* memberUnion, typename TField >

auto & opcua::DataTypeBuilder< T, Tag, U >::addUnionField ( const char * fieldName )

inline

Add a union field (derive DataType from TField).

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 339 of file datatype.hpp.

build()

template<typename T , typename Tag , typename U >

DataType opcua::DataTypeBuilder< T, Tag, U >::build ( )

nodiscard

Create the actual DataType.

Definition at line 508 of file datatype.hpp.

Friends And Related Symbol Documentation

DataTypeBuilder

template<typename T , typename Tag = detail::TagDataTypeAny, typename U = struct DeferT>

template<typename , typename , typename >

friend class DataTypeBuilder

friend

Definition at line 350 of file datatype.hpp.