FB_CMA_BufferConverting

Input parameters

The input parameters of this function block represent initialization parameters and must already be assigned in the declaration of the FB instance! (Alternatively: Init() method). They may only be assigned once. A change at runtime is not possible.

Output parameters

VAR_OUTPUT
    bError         : BOOL;                           // TRUE if an error occurs. Reset by next method call.
    hrErrorCode    : HRESULT;                        // '< 0' = error; '> 0' = info; '0' = no error/info
    ipErrorMessage : I_TcMessage := fbErrorMessage;  // Shows detailed information about occurred errors, warnings and more.
    nCntResults    : ULINT;                          // Counts outgoing results (MultiArrays were calculated and sent to transfer tray).
END_VAR

• bError: The output is TRUE if an error occurs.
• hrErrorCode: If an error occurs, a corresponding error code of the type HRESULT is output. Possible values are described in the List of error codes.
• ipErrorMessage: Contains more detailed information on the current return value. Refer here to the section Error description and information. This special interface pointer is internally secured so that it is always valid/assigned.

Copy1D():

Copies one-dimensional data from one MultiArray to another MultiArray.

METHOD Copy1D : HRESULT
VAR_INPUT
    nWorkDimIn     : UDINT;                // It designates the dimension in the input MultiArray being processed.
    nWorkDimOut    : UDINT;                // It designates the dimension in the output MultiArray being processed.
    nElements      : UDINT;                // optional: default:0->full copy; It designates the number of elements to be copied out of the MultiArray.
    pStartIndexIn  : POINTER TO UDINT;    (* optional: default:0->internally handled as [0,0,..]; It designates the index of the first element to be copied out of the MultiArray.
                         If allocated it must point to a onedimensional array of UDINT with so many elements as dimensions of the MultiArray. *)
    pStartIndexOut : POINTER TO UDINT;    (* optional: default:0->internally handled as [0,0,..]; It designates the index of the first MultiArray element to be copied.
                         If allocated it must point to a onedimensional array of UDINT with so many elements as dimensions of the MultiArray. *)
    nOptionPars    : DWORD;               // option mask 
END_VAR
VAR_OUTPUT
    bNewResult     : BOOL;                // TRUE every time when outgoing MultiArray was calculated and sent to transfer tray.
    bError         : BOOL;                // TRUE if an error occurs.
    hrErrorCode   : HRESULT;              // '< 0' = error; '> 0' = info; '0' = no error/info
END_VAR

• nWorkDimIn: If the input MultiArray is multi-dimensional, you can select the dimension whose data you want to copy. The first dimension would be 0 (0-based).
• nWorkDimOut: If the output MultiArray is multi-dimensional, you can select the dimension to which you want to copy data. The first dimension would be 0 (0-based).
• nElements: To copy the complete data of a MultiArray dimension, this parameter can be set to 0. The total number is determined internally in this case. Alternatively, you can specify the number of elements to be copied.
• bError: The output is TRUE if an error occurs.
• hrErrorCode: If an error occurs, a corresponding error code of the type HRESULT is output. Possible values are described in the List of error codes. This output is identical to the return value of the method.

If a timeout occurs or no MultiArray buffer is available for the result, then neither the input data nor the result data are lost. They are forwarded on the next call.

Transpose():

Transposes two dimensions so that the output buffer is the transposition of the input buffer. This operation is only possible for one and two-dimensional input buffers.

METHOD Transpose : HRESULT
VAR_INPUT
    nOptionPars : DWORD;   // option mask
END_VAR
VAR_OUTPUT
    bNewResult  : BOOL;    // TRUE every time when outgoing MultiArray was calculated and sent to transfer tray.
    bError      : BOOL;    // TRUE if an error occurs.
    hrErrorCode : HRESULT; // '< 0' = error; '> 0' = info; '0' = no error/info
END_VAR

• bNewResult: The output is TRUE every time an output MultiArray is calculated and sent to the TransferTray.
• bError: The output is TRUE if an error occurs.
• hrErrorCode: If an error occurs, a corresponding error code of the type HRESULT is output. Possible values are described in the List of error codes. This output is identical to the return value of the method.

If a timeout occurs or no MultiArray buffer is available for the result, then neither the input data nor the result data are lost. They are forwarded on the next call.

Init():

This method is not usually necessary in a Condition Monitoring application. It offers an alternative to the function block initialization. The Init() method may only be called during the initialization phase of the PLC. It cannot be used at runtime. You are referred to the use of an FB_init method or the attribute 'call_after_init' (see TwinCAT PLC reference). In addition, this facilitates the function block encapsulation.

The input parameters of the function block instance may not be assigned in the declaration if the initialization is to take place using the Init() method.

• Return value: If an error occurs, a corresponding error code of the type HRESULT is output. Possible values are described in the List of error codes.

PassInputs():

As long as an FB_CMA_Source instance is called and signal data are thus transferred to a target block, all further function blocks of the analysis chain have to be called cyclically as explained in the API PLC Reference.
Sometimes it is useful not to execute an algorithm for a certain time. For example, some algorithms should be executed only after prior training or configuration. The function block must be called cyclically, but it is sufficient for the data arriving at the function block to be forwarded in the communication ring. This is done using the PassInputs() method in place of the Call() method. The algorithm itself is not called here, and accordingly no result is calculated and no output buffer generated.

• Return value: If an error occurs, a corresponding error code of the type HRESULT is output. Possible values are described in the List of error codes.

METHOD PassInputs : HRESULT
VAR_INPUT
END_VAR