This class is used to define a single IO variable or a tree if IO variables More...

#include <PortDefinition.hpp>

Public Types
using	ArrayDimensions = std::vector< ArrayDimension >

using	CustomAttributes = std::vector< CustomAttribute >

using	Children = std::vector< PortDefinition >

Public Member Functions
	PortDefinition (const String &name, DataType dataType, const ArrayDimensions &arrayDimensions, StandardAttribute standardAttribute, const CustomAttributes &customAttributes, const String &bufferName, const BitSize &offset)
	Construct a PortDefinition for an IO variable, size deduced from data type More...

	PortDefinition (const String &name, DataType dataType, const String &typeName, const BitSize &size, const ArrayDimensions &arrayDimensions, StandardAttribute standardAttribute, const CustomAttributes &customAttributes, const String &bufferName, const BitSize &offset)
	Construct a PortDefinition for an IO variable More...

	PortDefinition (const String &name, const CustomAttributes &customAttributesArg, const Children &childrenArg)
	Construct a PortDefinition for a hierarchy node More...

	PortDefinition (const PortDefinition &arg)
	The default copy constructor.

	PortDefinition (PortDefinition &&arg) noexcept
	The default move constructor.

PortDefinition &	operator= (const PortDefinition &arg)
	THe default copy-assignment operator.

PortDefinition &	operator= (PortDefinition &&arg) noexcept
	The default move-assignment operator.

	~PortDefinition (void)
	The default destructor.

String	GetName () const
	Returns the name of the node More...

DataType	GetDataType () const
	Returns the data type More...

String	GetTypeName () const
	Returns the type name More...

BitSize	GetSize () const
	Returns the size More...

ArrayDimensions	GetArrayDimensions () const
	Returns the array dimensions More...

StandardAttribute	GetStandardAttribute () const
	Returns the standard attributes More...

CustomAttributes	GetCustomAttributes () const
	Returns the custom attributes More...

String	GetBufferName () const
	Returns the buffer name More...

BitSize	GetOffset () const
	Returns the offset in the buffer More...

const Children &	GetChildren () const
	Returns the children of the node More...

void	AddAttribute (const CustomAttribute &customAttribute)
	Adds a CustomAttribute More...

void	AddChild (const PortDefinition &child)
	Adds a child More...

Impl &	GetImpl (void)
	For internal use only.

const Impl &	GetImpl (void) const

Detailed Description

This class is used to define a single IO variable or a tree if IO variables

There are IO variables and hierarchy nodes. The IO variables are the leafs of the tree. Only they contain information about the data type or buffer.
Each node may contain an arbitrary number of custom attributes.
The following properties are provided for future use cases. Using them now will result in exceptions:

typeName
arrayDimensions DataType is limited to primitive data types.

Constructor & Destructor Documentation

◆ PortDefinition() [1/3]

Arp::Plc::Meta::Commons::Io::PortDefinition::PortDefinition	(	const String &	name,
		DataType	dataType,
		const ArrayDimensions &	arrayDimensions,
		StandardAttribute	standardAttribute,
		const CustomAttributes &	customAttributes,
		const String &	bufferName,
		const BitSize &	offset
	)

Construct a PortDefinition for an IO variable, size deduced from data type

Parameters

name	Name of the node, must not be empty
dataType	Data type of the IO variable, only primitive types allowed
arrayDimensions	Dimensions of the array, must be empty
standardAttribute	Combination of StandardAttribute enumerators. Io is always added.
customAttributes	Initial set of CustomAttributes. Attribute names must be unique.
bufferName	Name of the corresponding buffer, must not be empty
offset	Offset in the buffer (BitSize)

Exceptions

ArgumentException Throws on invalid parameters

◆ PortDefinition() [2/3]

Arp::Plc::Meta::Commons::Io::PortDefinition::PortDefinition	(	const String &	name,
		DataType	dataType,
		const String &	typeName,
		const BitSize &	size,
		const ArrayDimensions &	arrayDimensions,
		StandardAttribute	standardAttribute,
		const CustomAttributes &	customAttributes,
		const String &	bufferName,
		const BitSize &	offset
	)

Construct a PortDefinition for an IO variable

Parameters

name	Name of the node, must not be empty
dataType	Data type of the IO variable, only primitive types allowed
typeName	Type name for complex types, must be empty
size	Size of the one array element of variable (BitSize)
arrayDimensions	Dimensions of the array, must be empty
standardAttribute	Combination of StandardAttribute enumerators. Io is always added.
customAttributes	Initial set of CustomAttributes. Attribute names must be unique.
bufferName	Name of the corresponding buffer, must not be empty
offset	Offset in the buffer (BitSize)

Exceptions

ArgumentException Throws on invalid parameters

◆ PortDefinition() [3/3]

Arp::Plc::Meta::Commons::Io::PortDefinition::PortDefinition	(	const String &	name,
		const CustomAttributes &	customAttributesArg,
		const Children &	childrenArg
	)

Construct a PortDefinition for a hierarchy node

Parameters

name	Name of the node, must not be empty
customAttributesArg	Initial set of CustomAttributes. Attribute names must be unique.
childrenArg	Initial set of children. Child names must be unique.

Exceptions

ArgumentException Throws on invalid parameters

Member Function Documentation

◆ AddAttribute()

void Arp::Plc::Meta::Commons::Io::PortDefinition::AddAttribute ( const CustomAttribute & customAttribute )

Adds a CustomAttribute

Parameters

customAttribute New custom attribute. Attribute name must be unique.

◆ AddChild()

void Arp::Plc::Meta::Commons::Io::PortDefinition::AddChild ( const PortDefinition & child )

Adds a child

Parameters

child New child. Child name must be unique.

Exceptions

InvalidOperationException Throws if child is added to IO variable.

◆ GetArrayDimensions()

PortDefinition::ArrayDimensions Arp::Plc::Meta::Commons::Io::PortDefinition::GetArrayDimensions ( void ) const

Returns the array dimensions

Returns: Array dimensions, empty for hierarchy nodes

◆ GetBufferName()

String Arp::Plc::Meta::Commons::Io::PortDefinition::GetBufferName ( ) const

Returns the buffer name

Returns: Buffer name, empty for hierarchy nodes

◆ GetChildren()

const PortDefinition::Children & Arp::Plc::Meta::Commons::Io::PortDefinition::GetChildren ( ) const

Returns the children of the node

Returns: Children of the node, empty for IO variables

◆ GetCustomAttributes()

PortDefinition::CustomAttributes Arp::Plc::Meta::Commons::Io::PortDefinition::GetCustomAttributes ( ) const

Returns the custom attributes

Returns: Custom attributes

◆ GetDataType()

DataType Arp::Plc::Meta::Commons::Io::PortDefinition::GetDataType ( void ) const

Returns the data type

Returns: Data type; Node for hierarchy nodes

◆ GetName()

String Arp::Plc::Meta::Commons::Io::PortDefinition::GetName ( void ) const

Returns the name of the node

Returns: Name of the node

◆ GetOffset()

BitSize Arp::Plc::Meta::Commons::Io::PortDefinition::GetOffset ( void ) const

Returns the offset in the buffer

Returns: Offset in the buffer, zero for hierarchy nodes

◆ GetSize()

BitSize Arp::Plc::Meta::Commons::Io::PortDefinition::GetSize ( void ) const

Returns the size

Returns: Size, zero for hierarchy nodes

◆ GetStandardAttribute()

StandardAttribute Arp::Plc::Meta::Commons::Io::PortDefinition::GetStandardAttribute ( ) const

Returns the standard attributes

Returns: Standard attributes, always includes Io

◆ GetTypeName()

String Arp::Plc::Meta::Commons::Io::PortDefinition::GetTypeName ( ) const

Returns the type name

Returns: Type name for complex types; empty for hierarchy nodes

The documentation for this class was generated from the following files:

Arp/Plc/Meta/Commons/Io/PortDefinition.hpp
Arp/Plc/Meta/Commons/Io/PortDefinition.cpp

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PortDefinition() [1/3]

◆ PortDefinition() [2/3]

◆ PortDefinition() [3/3]

Member Function Documentation

◆ AddAttribute()

◆ AddChild()

◆ GetArrayDimensions()

◆ GetBufferName()

◆ GetChildren()

◆ GetCustomAttributes()

◆ GetDataType()

◆ GetName()

◆ GetOffset()

◆ GetSize()

◆ GetStandardAttribute()

◆ GetTypeName()