ISubscriptionService.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Rsc/Services/IRscService.hpp"
#include "SubscriptionServiceProxyFactory.hpp"
#include "Arp/System/Core/delegate.hxx"
#include "Arp/System/Rsc/Services/IRscReadEnumerator.hxx"
#include "Arp/System/Rsc/Services/IRscWriteEnumerator.hxx"
#include "Arp/System/Rsc/Services/RscString.hxx"
#include "Arp/System/Rsc/Services/RscVariant.hxx"
#include "DataAccessError.hpp"
#include "SubscriptionKind.hpp"
#include "VariableInfo.hpp"

// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ISubscriptionService.cs

namespace Arp { namespace Plc { namespace Gds { namespace Services
{

using namespace Arp;
using namespace Arp::System::Rsc::Services;

class ISubscriptionService : public IRscService
{
public: // typedefs
    using Ptr = std::shared_ptr<ISubscriptionService>;
    using AddVariablesVariableNamesDelegate = delegate<void(IRscWriteEnumerator<RscString<512>>&)>;
    using AddVariablesResultDelegate = delegate<void(IRscReadEnumerator<DataAccessError>&)>;
    using GetVariableInfosVariableInfoDelegate = delegate<void(IRscReadEnumerator<VariableInfo>&)>;
    using GetTimeStampedVariableInfosVariableInfoDelegate = delegate<void(IRscReadEnumerator<VariableInfo>&)>;
    using GetRecordInfosRecordInfosDelegate = delegate<void(IRscReadEnumerator<VariableInfo>&)>;
    using ReadValuesValuesDelegate = delegate<void(IRscReadEnumerator<RscVariant<512>>&)>;
    using ReadTimeStampedValuesValuesDelegate = delegate<void(IRscReadEnumerator<RscVariant<512>>&)>;
    using ReadRecordsRecordsDelegate = 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;
};

// inline methods of class ISubscriptionService
inline IRscServiceProxyFactory& ISubscriptionService::GetProxyFactory()
{
    return SubscriptionServiceProxyFactory::GetInstance();
}

}}}} // end of namespace Arp::Plc::Gds::Services