Arp::Plc::Commons::Meta::DynamicPortsBuilder Class Reference

Provides the infrastructure for dynamic port provision More...

#include <DynamicPortsBuilder.hpp>

Public Member Functions
size_t	GetMaximumNumberOfPorts () const
	< summary>Returns the maximum number of dynamic ports to provide More...
size_t	GetNumberOfPorts () const
	summary>Returns the type definition for the program More...
const TypeSystem::TypeDefinition &	GetTypeDefinition () const
template<typename T >
void	AddPort (const String &portName, T &value, StandardAttribute standardAttributes)
	Adds a variable as dynamic port More...

Static Public Member Functions
template<typename TProgram , size_t MaxNumPorts>
static DynamicPortsBuilder	Create (const String &libraryNamespace, const String &programInstanceName, std::array< byte *, MaxNumPorts > &ports, size_t portsOffset)

Detailed Description

Provides the infrastructure for dynamic port provision

Member Function Documentation

AddPort()

template<typename T >

void Arp::Plc::Commons::Meta::DynamicPortsBuilder::AddPort	(	const String &	portName,
		T &	value,
		StandardAttribute	standardAttributes
	)

Adds a variable as dynamic port

Parameters

portName	Name of the port
value	Reference to the value of the port
standardAttributes	Definition of attribus for the port (e.g. Input, Output)

Create()

template<typename TProgram , size_t MaxNumPorts>

DynamicPortsBuilder Arp::Plc::Commons::Meta::DynamicPortsBuilder::Create ( const String &  libraryNamespace, const String &  programInstanceName, std::array< byte *, MaxNumPorts > &  ports, size_t  portsOffset  )

static

< summary>Creates an DynamicPortsProvider for an ProgramType remarks>Internal use only. The object is created by DynamicPortsProgramBase

GetMaximumNumberOfPorts()

size_t Arp::Plc::Commons::Meta::DynamicPortsBuilder::GetMaximumNumberOfPorts

(

)

const

< summary>Returns the maximum number of dynamic ports to provide

summary>Returns the current number of dynamic ports to provide

GetNumberOfPorts()

size_t Arp::Plc::Commons::Meta::DynamicPortsBuilder::GetNumberOfPorts

(

)

const

summary>Returns the type definition for the program

---

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

• Arp/Plc/Commons/Meta/DynamicPortsBuilder.hpp