Arp::Plc::Domain::Commons::DomainSelector Class Reference

This class is for internal use only. Never use it directly. More...

#include <DomainSelector.hpp>

Public Member Functions
	DomainSelector (const DomainSelector &arg)=delete
	DomainSelector (DomainSelector &&arg) noexcept=delete
DomainSelector &	operator= (const DomainSelector &arg)=delete
DomainSelector &	operator= (DomainSelector &&arg) noexcept=delete
	~DomainSelector (void)
	The default destructor.
	DomainSelector (DomainBase &domain1, DomainBase &domain2)
	Constructs a DualDomainBase instance. More...
void	SwapDomains (bool simulate)
	Swaps the domain states during download-changes operation. More...
DomainBase &	Get (bool backgroundDomain)
	Gets one of the domain instances depending on the backgroundDomain . More...
const DomainBase &	Get (bool backgroundDomain) const
	Gets one of the domain instances depending on the backgroundDomain . More...
Impl &	GetImpl (void)
	For internal use only.
const Impl &	GetImpl (void) const

Detailed Description

This class is for internal use only. Never use it directly.

This class is only part of the SDK, because it serves as member of template class DualDomain. The intention of this class is to hide as much as possible code of class DualDomain, so that inlining is avoided as much as possible.

Constructor & Destructor Documentation

DomainSelector()

Arp::Plc::Domain::Commons::DomainSelector::DomainSelector	(	DomainBase &	domain1,
		DomainBase &	domain2
	)

Constructs a DualDomainBase instance.

Parameters

domain1	The adapted foreground domain.
domain2	The adapted background domain.

Member Function Documentation

Get() [1/2]

DomainBase & Arp::Plc::Domain::Commons::DomainSelector::Get

(

bool

backgroundDomain

)

Gets one of the domain instances depending on the backgroundDomain .

Parameters

backgroundDomain

If true, the background domain is returned, otherwise the foreground domain.

Returns

One of the domain instances.

Get() [2/2]

const DomainBase & Arp::Plc::Domain::Commons::DomainSelector::Get

(

bool

backgroundDomain

)

const

Gets one of the domain instances depending on the backgroundDomain .

Parameters

backgroundDomain

If true, the background domain is returned, otherwise the foreground domain.

Returns

One of the domain instances.

SwapDomains()

void Arp::Plc::Domain::Commons::DomainSelector::SwapDomains

(

bool

simulate

)

Swaps the domain states during download-changes operation.

Parameters

simulate

If true the swap is just simulated to measure the duration.

---

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

• Arp/Plc/Domain/Commons/DomainSelector.hpp
• Arp/Plc/Domain/Commons/DomainSelector.cpp