PLCnext API Documentation 25.0.2.69
IDataLoggerService2.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include "Arp/Base/Rsc/Commons/IRscReadEnumerator.hxx"
11#include "Arp/Base/Rsc/Commons/IRscWriteEnumerator.hxx"
12#include "Arp/Base/Core/delegate.hxx"
13#include <vector>
14#include "Arp/Base/Rsc/Commons/RscString.hxx"
15#include "Arp/Base/Rsc/Commons/RscVariant.hxx"
16#include "Arp/Plc/Gds/Services/VariableInfo.hpp"
17#include "Arp/Services/DataLogger/Services/ErrorCode.hpp"
18#include "Arp/Services/DataLogger/Services/SessionProperty.hpp"
19#include "Arp/Services/DataLogger/Services/SessionState.hpp"
20#include "Arp/Services/DataLogger/Services/TriggerRpnItem.hpp"
21
22// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IDataLoggerService2.cs
23
25{
26
27using namespace Arp::Base::Rsc::Commons;
28
36class ARP_EXPORT IDataLoggerService2 : public IRscService
37{
38public: // usings
39 using Ptr = std::shared_ptr<IDataLoggerService2>;
50
51public: // construction/destruction
53 IDataLoggerService2(void) = default;
54
55public: // static policy operation
56 static IRscServiceProxyFactory& GetProxyFactory(void);
57
58public: // abstract operations
63 virtual void ListSessionNames(ListSessionNamesResultDelegate resultDelegate) = 0;
64
102 virtual ErrorCode CreateSession(const RscString<512>& sessionName, boolean persistent = false) = 0;
103
140 virtual ErrorCode RemoveSession(const RscString<512>& sessionName) = 0;
141
178 virtual ErrorCode StartSession(const RscString<512>& sessionName) = 0;
179
216 virtual ErrorCode StopSession(const RscString<512>& sessionName) = 0;
217
263 virtual ErrorCode ConfigureSession(const RscString<512>& sessionname, const std::vector<SessionProperty>& properties) = 0;
264
295 virtual ErrorCode GetSessionConfiguration(const RscString<512>& sessionname, std::vector<SessionProperty>& properties, boolean& isPersistent) = 0;
296
327 virtual ErrorCode GetSessionState(const RscString<512>& sessionName, SessionState& state) = 0;
328
356 virtual void SetVariables(const RscString<512>& sessionName, SetVariablesVariableNamesDelegate variableNamesDelegate, SetVariablesResultDelegate resultDelegate) = 0;
357
387 virtual ErrorCode GetLoggedVariables(const RscString<512>& sessionName, GetLoggedVariablesInfosDelegate infosDelegate) = 0;
388
474 virtual ErrorCode ReadVariablesData(const RscString<512>& sessionName, DateTime startTime, DateTime endTime, ReadVariablesDataVariableNamesDelegate variableNamesDelegate, ReadVariablesDataValuesDelegate valuesDelegate) = 0;
475
513 virtual ErrorCode GetRotatedFileNames(const RscString<512>& sessionname, GetRotatedFileNamesFilenamesDelegate filenamesDelegate) = 0;
514
520 virtual void GetSessionNames(const RscString<512>& variablename, GetSessionNamesResultDelegate resultDelegate) = 0;
521
584 virtual ErrorCode SetTriggerCondition(const RscString<512>& sessionName, const RscString<512>& taskName, uint16 preCycleCount, uint16 postCycleCount, SetTriggerConditionTriggerConditionDelegate triggerConditionDelegate) = 0;
585};
586
587} // end of namespace Arp::Services::DataLogger::Services
This class contains date and time informations.
Definition: DateTime.hpp:27
Prototyping of delegate template.
Definition: delegate.hxx:14
Interface for reading a arrays or enumerations.
Definition: IRscReadEnumerator.hxx:19
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for writing an array enumeration or enumeration of unspefied length.
Definition: IRscWriteEnumerator.hxx:20
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
Describes a subscribed variable.
Definition: VariableInfo.hpp:31
The DataLogger provides an interface to log and store variables during firmware runtime.
Definition: IDataLoggerService2.hpp:37
virtual void ListSessionNames(ListSessionNamesResultDelegate resultDelegate)=0
List all names of sessions inside the data logger component.
virtual ErrorCode CreateSession(const RscString< 512 > &sessionName, boolean persistent=false)=0
Tries to create a new session.
virtual ErrorCode GetLoggedVariables(const RscString< 512 > &sessionName, GetLoggedVariablesInfosDelegate infosDelegate)=0
Queries all infos about logged variables of a session.
virtual ErrorCode GetSessionConfiguration(const RscString< 512 > &sessionname, std::vector< SessionProperty > &properties, boolean &isPersistent)=0
Tries to query the current configuration of a session
virtual ErrorCode ReadVariablesData(const RscString< 512 > &sessionName, DateTime startTime, DateTime endTime, ReadVariablesDataVariableNamesDelegate variableNamesDelegate, ReadVariablesDataValuesDelegate valuesDelegate)=0
Read the data from the given variable from the session with the session name.
IDataLoggerService2(void)=default
Constructs an IDataLoggerService2 instance.
virtual ErrorCode StopSession(const RscString< 512 > &sessionName)=0
Tries to stop a logging session.
virtual ErrorCode ConfigureSession(const RscString< 512 > &sessionname, const std::vector< SessionProperty > &properties)=0
(Re)configures a session
virtual ErrorCode RemoveSession(const RscString< 512 > &sessionName)=0
Tries to remove a session.
virtual ErrorCode GetRotatedFileNames(const RscString< 512 > &sessionname, GetRotatedFileNamesFilenamesDelegate filenamesDelegate)=0
Returns names of all files that have been written by a session
virtual ErrorCode SetTriggerCondition(const RscString< 512 > &sessionName, const RscString< 512 > &taskName, uint16 preCycleCount, uint16 postCycleCount, SetTriggerConditionTriggerConditionDelegate triggerConditionDelegate)=0
Sets a trigger condition
virtual void GetSessionNames(const RscString< 512 > &variablename, GetSessionNamesResultDelegate resultDelegate)=0
Tries to retrieve names of sessions which log assigned variables
virtual ErrorCode GetSessionState(const RscString< 512 > &sessionName, SessionState &state)=0
Tries to query the state of a session.
virtual void SetVariables(const RscString< 512 > &sessionName, SetVariablesVariableNamesDelegate variableNamesDelegate, SetVariablesResultDelegate resultDelegate)=0
Tries to add a variable to a session.
virtual ErrorCode StartSession(const RscString< 512 > &sessionName)=0
Tries to start a logging session.
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:29
Namespace for services of the DataLogger
ErrorCode
Possible error codes for data-logger rsc services.
Definition: ErrorCode.hpp:19
SessionState
State of a data logger session
Definition: SessionState.hpp:19