DcgResultInfo.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Rsc/Commons/Rsc.hpp"
#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"
#include "Arp/Base/Rsc/Commons/RscString.hxx"
#include "Arp/Plc/Domain/Commons/DcgResult.hpp"
 
namespace Arp::Plc::Domain::Commons
{
 
using namespace Arp::Base::Rsc::Commons;
using namespace Arp::Base::Rsc::Commons::Services;
 
class ARP_EXPORT DcgResultInfo : public RscSerializable
{
public: //construction
    DcgResultInfo(void);
 
private:
    DcgResultInfo(DcgResult result, const String& refusedReason);
 
public: // static operations
    static DcgResultInfo CreateEmpty(void);
    static DcgResultInfo CreateSuccess(void);
    static DcgResultInfo CreateRefused(const String& refusedReason);
 
public:
    DcgResult   GetResult(void)const;
    String      GetMessage(void)const;
 
public:
    void Serialize(RscWriter& writer)const;
    void Deserialize(RscReader& reader);
 
public: // static RSC operation
    static size_t GetFieldCount(void);
 
private: // fields
    DcgResult       result = DcgResult::None;
    RscString<512>  message;
 
private: // const member
    static constexpr size_t fieldCount = 2;
    static constexpr int    maxMessageLength = 512;
};
 
} // end of namespace Arp::Plc::Domain::Commons