PLCnext API Documentation  22.9.0.33
Public Types | Public Member Functions | Protected Member Functions | List of all members
Arp::Plc::Commons::Meta::IChangeNavigator Class Referenceabstract

Enables switching of counterparts during download change More...

#include <IChangeNavigator.hpp>

Public Types

using Ptr = std::shared_ptr< IChangeNavigator >
 std::shared_ptr to IChangeNavigator More...
 

Public Member Functions

virtual bool ChangeReference (const DataTag &dataTag)=0
 Determines if a reference DataTag must be swapped during download change More...
 
virtual bool ChangePointer (const DataTag &dataTag)=0
 Determines if a pointer DataTag must be swapped during download change More...
 

Protected Member Functions

 IChangeNavigator (void)=default
 Constructs an IChangeNavigator instance. More...
 
virtual ~IChangeNavigator (void)=default
 Destructs this instance and frees all resources. More...
 

Detailed Description

Enables switching of counterparts during download change

The IChangeNavigator is provided by the IMetaLibrary interface. C++ program components do not provide an IChangeNavigator.

Only for internal use.

Member Typedef Documentation

◆ Ptr

std::shared_ptr to IChangeNavigator

Constructor & Destructor Documentation

◆ IChangeNavigator()

Arp::Plc::Commons::Meta::IChangeNavigator::IChangeNavigator ( void  )
protecteddefault

Constructs an IChangeNavigator instance.

◆ ~IChangeNavigator()

virtual Arp::Plc::Commons::Meta::IChangeNavigator::~IChangeNavigator ( void  )
protectedvirtualdefault

Destructs this instance and frees all resources.

Member Function Documentation

◆ ChangePointer()

virtual bool Arp::Plc::Commons::Meta::IChangeNavigator::ChangePointer ( const DataTag dataTag)
pure virtual

Determines if a pointer DataTag must be swapped during download change

Parameters
dataTagDataTag object
Returns
true, if dataTag needs to be swapped

◆ ChangeReference()

virtual bool Arp::Plc::Commons::Meta::IChangeNavigator::ChangeReference ( const DataTag dataTag)
pure virtual

Determines if a reference DataTag must be swapped during download change

Parameters
dataTagDataTag object
Returns
true, if dataTag needs to be swapped

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