ProgramBase.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/Plc/Commons/Esm/IProgram.hpp"
namespace Arp { namespace Plc { namespace Commons { namespace Esm
{

class ProgramBase : public IProgram
{
private: // typedefs

public: // construction/destruction
    ProgramBase(const String& programName);
    virtual ~ProgramBase(void) = default;

public: // IProgram implementation
    const String& GetFullName(void)const override;
    const String& GetTaskName(void)const override;
    void SetTaskName(const String& taskNameArg)override;
    void SetInitialValues(void)override;
    void AbortRequest(void)override;
    bool IsAbortRequested(void)const override;

public: // abstract IProgram operations
    virtual void Execute(void) = 0;

private: // deleted methods
    ProgramBase(const ProgramBase& arg) = delete;
    ProgramBase& operator=(const ProgramBase& arg) = delete;

private: // fields
    String programName;
    String taskName;
    bool abortRequested = false;
};

// inline methods of class ProgramBase
inline ProgramBase::ProgramBase(const String& programNameArg)
    : programName(programNameArg)
{
}

inline const String& ProgramBase::GetFullName()const
{
    return this->programName;
}

inline void ProgramBase::SetInitialValues()
{
    // Default implementation is empty.
    // Implement this function to set initialize values of program variables.
}

inline const String& ProgramBase::GetTaskName()const
{
    return this->taskName;
}

inline void ProgramBase::SetTaskName(const String& value)
{
    this->taskName = value;
}

inline void ProgramBase::AbortRequest()
{
    this->abortRequested = true;
}

inline bool ProgramBase::IsAbortRequested()const
{
    return this->abortRequested;
}

}}}} // end of namespace Arp::Plc::Commons::Esm