Arp::Plc::Meta::Commons::Io::VariableRegistry Class Reference

This class is used to register IO variables More...

#include <VariableRegistry.hpp>

Public Types
using	Pimpl = PimplPtr< Impl >

Public Member Functions
	VariableRegistry (Impl &&impl)
	Constructs a VariableRegistry instance. More...
	VariableRegistry (const VariableRegistry &arg)=delete
	VariableRegistry (VariableRegistry &&arg) noexcept
	The default move constructor.
VariableRegistry &	operator= (const VariableRegistry &arg)=delete
VariableRegistry &	operator= (VariableRegistry &&arg) noexcept
	The default move-assignment operator.
	~VariableRegistry (void)
	The default destructor.
void	AddPort (const PortDefinition &portDefintion, bool useBackgroundDomain)
	Adds an IO variable or a whole tree of IO variables More...
void	AddType (const TypeDefinition &typeDefinition, bool useBackgroundDomain)
	Adds an IO type More...
Impl &	GetImpl (void)
	For internal use only.
const Impl &	GetImpl (void) const

Detailed Description

This class is used to register IO variables

An object of this type is provided by IIoMetaComponent. It cannot be constructed in client code.

Constructor & Destructor Documentation

VariableRegistry()

Arp::Plc::Meta::Commons::Io::VariableRegistry::VariableRegistry ( Impl &&  impl )

explicit

Constructs a VariableRegistry instance.

Parameters

impl	Implementation object

For internal use only.

Member Function Documentation

AddPort()

void Arp::Plc::Meta::Commons::Io::VariableRegistry::AddPort	(	const PortDefinition &	portDefintion,
		bool	useBackgroundDomain
	)

Adds an IO variable or a whole tree of IO variables

Parameters

portDefintion	Definition of the IO variable or the tree of IO variables
useBackgroundDomain	false to use the foreground domain, true to use the background domain

AddType()

void Arp::Plc::Meta::Commons::Io::VariableRegistry::AddType	(	const TypeDefinition &	typeDefinition,
		bool	useBackgroundDomain
	)

Adds an IO type

Parameters

portDefintion	Definition of the IO type
useBackgroundDomain	false to use the foreground domain, true to use the background domain

---

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

• Arp/Plc/Meta/Commons/Io/VariableRegistry.hpp
• Arp/Plc/Meta/Commons/Io/VariableRegistry.cpp