ISubscriptionService.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/IRscService.hpp"
#include "Arp/Base/Rsc/Commons/IRscReadEnumerator.hxx"
#include "Arp/Base/Rsc/Commons/IRscWriteEnumerator.hxx"
#include "Arp/Base/Core/delegate.hxx"
#include <vector>
#include "Arp/Base/Rsc/Commons/RscString.hxx"
#include "Arp/Base/Rsc/Commons/RscVariant.hxx"
#include "Arp/Plc/Gds/Services/DataAccessError.hpp"
#include "Arp/Plc/Gds/Services/SubscriptionKind.hpp"
#include "Arp/Plc/Gds/Services/VariableInfo.hpp"
 
// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ISubscriptionService.cs
 
namespace Arp::Plc::Gds::Services
{
 
using namespace Arp::Base::Rsc::Commons;
 
class ARP_EXPORT ISubscriptionService : public IRscService
{
public: // usings
    using Ptr = std::shared_ptr<ISubscriptionService>;
    using AddVariablesResultDelegate = delegate<void(IRscReadEnumerator<DataAccessError>&)>;
    using AddVariablesVariableNamesDelegate = delegate<void(IRscWriteEnumerator<RscString<512>>&)>;
    using GetRecordInfosRecordInfosDelegate = delegate<void(IRscReadEnumerator<std::vector<VariableInfo>>&)>;
    using GetTimeStampedVariableInfosVariableInfoDelegate = delegate<void(IRscReadEnumerator<VariableInfo>&)>;
    using GetVariableInfosVariableInfoDelegate = delegate<void(IRscReadEnumerator<VariableInfo>&)>;
    using ReadRecordsRecordsDelegate = delegate<void(IRscReadEnumerator<RscVariant<512>>&)>;
    using ReadTimeStampedValuesValuesDelegate = delegate<void(IRscReadEnumerator<RscVariant<512>>&)>;
    using ReadValuesValuesDelegate = delegate<void(IRscReadEnumerator<RscVariant<512>>&)>;
 
public: // construction/destruction
    ISubscriptionService(void) = default;
 
public: // static policy operation
    static IRscServiceProxyFactory& GetProxyFactory(void);
 
public: // abstract operations
    virtual uint32          CreateSubscription(SubscriptionKind kind) = 0;
 
    virtual uint32          CreateRecordingSubscription(uint16 recordCount) = 0;
 
    virtual DataAccessError AddVariable(uint32 subscriptionId, const RscString<512>& variableName) = 0;
 
    virtual void            AddVariables(uint32 subscriptionId, AddVariablesVariableNamesDelegate variableNamesDelegate, AddVariablesResultDelegate resultDelegate) = 0;
 
    virtual DataAccessError RemoveVariable(uint32 subscriptionId, const RscString<512>& variableName) = 0;
 
    virtual DataAccessError Subscribe(uint32 subscriptionId, uint64 sampleRate) = 0;
 
    virtual DataAccessError Resubscribe(uint32 subscriptionId, uint64 sampleRate) = 0;
 
    virtual DataAccessError Unsubscribe(uint32 subscriptionId) = 0;
 
    virtual DataAccessError DeleteSubscription(uint32 subscriptionId) = 0;
 
    virtual DataAccessError GetVariableInfos(uint32 subscriptionId, GetVariableInfosVariableInfoDelegate variableInfoDelegate) = 0;
 
    virtual DataAccessError GetTimeStampedVariableInfos(uint32 subscriptionId, GetTimeStampedVariableInfosVariableInfoDelegate variableInfoDelegate) = 0;
 
    virtual DataAccessError GetRecordInfos(uint32 subscriptionId, GetRecordInfosRecordInfosDelegate recordInfosDelegate) = 0;
 
    virtual DataAccessError ReadValues(uint32 subscriptionId, ReadValuesValuesDelegate valuesDelegate) = 0;
 
    virtual DataAccessError ReadTimeStampedValues(uint32 subscriptionId, ReadTimeStampedValuesValuesDelegate valuesDelegate) = 0;
 
    virtual DataAccessError ReadRecords(uint32 subscriptionId, uint16 count, ReadRecordsRecordsDelegate recordsDelegate) = 0;
};
 
} // end of namespace Arp::Plc::Gds::Services