PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
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.
 
VariableRegistryoperator= (const VariableRegistry &arg)=delete
 
VariableRegistryoperator= (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...
 
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
implImplementation 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
portDefintionDefinition of the IO variable or the tree of IO variables
useBackgroundDomainfalse to use the foreground domain, true to use the background domain

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