T_ALY_SPGetHistorical_Cmd

T_ALY_SPGetHistorical_Cmd 1:

Syntax

Definition:

FUNCTION_BLOCK T_ALY_SPGetHistorical_Cmd EXTENDS T_ALY_JsonPayload
VAR_INPUT
    nRecordingID : LINT;
    sSubBroker : GUID;
    sTopic  : T_MaxString;
    sLayout : GUID;
    eMode   : E_SymbolMode := E_SymbolMode.All;
    eOutputFormat   : E_RawDataFormat := E_RawDataFormat.Bin;
    nMaxSampleCount : UDINT := 3000;
    nUserSampleTime : DINT := -1;
    nRecordID : DINT;
    nStartTimestamp : LINT;
    nEndTimestamp   : LINT;
    sResultTopic : T_MaxString;
    arrSymbol : ARRAY [0..255] OF T_ALY_Symbol;
END_VAR

Inheritence hierarchy

T_ALY_JsonPayload

    T_ALY_SPGetHistorical_Cmd

T_ALY_SPGetHistorical_Cmd 2: Inputs

Name

Type

Description

nRecordingID

LINT

Specific ID of the recording to be used

sSubBroker

GUID

Individual GUID of the MessageBroker via which the data is sent.

sTopic

T_MaxString

Topic name of the recorded live stream.

sLayout

GUID

Layout GUID of the recording.

eMode   

E_SymbolMode

Get all symbols or only a subset.

eOutputFormat   

E_RawDataFormat

Format of the returned data (actually only “Bin” supported).

nMaxSampleCount 

UDINT

Maximum number of samples in a payload package.

nUserSampleTime

DINT

Sample time in milliseconds of the returned stream. (-1 uses the recorded sample time.)

nRecordID 

DINT

Number of the record.

nStartTimestamp 

LINT

Start time

nEndTimestamp   

LINT

End time

sResultTopic 

T_MaxString

Topic name of the result stream.

arrSymbol 

ARRAY [0..255] OF T_ALY_Symbol

If SymbolMode is Subset, only the list of this symbols will be returned.

T_ALY_SPGetHistorical_Cmd 3: Methods

Name

Definition location

Description

Reset

 

Reset all values in the payload FB.

Init_JsonValue

Inherited from T_ALY_JsonPayload

Initialization of the FB with JSON object.

Development Environment

Target platform

PLC libraries to include

TwinCAT v3.1.4022.25

PC or CX (x64, x86, Arm®)

Tc3_AnalyticsStorageProvider