GoWebScanRecording.h

Go to the documentation of this file.

/**
* @file    GoWebScanRecording.h
* @brief   Declares a GoWebScanRecording object.
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_RECORDING_H
#define GO_WEB_SCAN_RECORDING_H

#include <GoSdk/Messages/GoDataTypes.h>
#include <GoSdk/Messages/GoDataSet.h>
#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanConfig.h>

/**
* @class   GoWebScanRecording
* @extends kObject
* @ingroup GoWebScanSdk-Control
* @brief   A class for storing sensor messages, which can be reused, or saved to and loaded from disk.

*/
typedef kObject GoWebScanRecording;

/**
* Constructs a GoWebScanRecording object.
*
* @public                   @memberof GoWebScanRecording
* @param   recording        Receives the constructed GoWebScanRecording object.
* @param   allocator        Memory allocator (or kNULL for default).
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanRecording_Construct(GoWebScanRecording* recording, kAlloc allocator);

/**
 * Adds s sensor message set to the recording. If adding the set would result in a recording size
 * greater than the max record size, the set is not added and kERROR_MEMORY is returned.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @param   dataSet         Set of sensor messages. Must have one of type GO_DATA_MESSAGE_TYPE_STAMP with
 *                          remaining messages of type GO_DATA_MESSAGE_TYPE_PROFILE for profile,
 *                          GO_DATA_MESSAGE_TYPE_TRACHEID for tracheid, or GO_DATA_MESSAGE_TYPE_VIDEO for
 *                          vision.
 * @param   recordingStatus Pointer to resulting status of adding data set. This value will be kOK if the
 *                          data set was successfully added, or kERROR_MEMORY if the memory limit has been reached.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanRecording_AddDataSetCopy(GoWebScanRecording recording, GoDataSet dataSet, kStatus* recordingStatus);

/**
 * Return the number of GoDataSet objects that have been recorded.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @return                  Number of recorded GoDataSet objects.
 */
GoWebScanFx(kSize) GoWebScanRecording_Count(GoWebScanRecording recording);

/**
 * Access a recorded GoDataSet object by index.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @param   index           Recorded GoDataSet index.
 * @return                  Pointer to the recorded GoDataSet.
 */
GoWebScanFx(const GoDataSet*) GoWebScanRecording_DataSetAt(GoWebScanRecording recording, kSize index);

/**
 * Get the array list of stored data message sets.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @return                  Array list of GoDataSets.
 */
GoWebScanFx(kArrayList) GoWebScanRecording_RecordingList(GoWebScanRecording recording);

/**
 * Loads a GoWebScanRecording object from a recording previously saved to disk.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       Receives the constructed GoWebScanCal object.
 * @param   fileName        File name (including path). Expected to be an .kdat6 file.
 * @param   alloc           Memory allocator (or kNULL for default).
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanRecording_Load(GoWebScanRecording* recording, const kChar* fileName, kAlloc alloc);

/**
 * Writes and stores a GoWebScanRecording object to a.kdat6 file.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @param   fileName        File name (including path). Expected to be a .kdat6 file.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanRecording_Store(GoWebScanRecording recording, const kChar* fileName);

/**
 * Clear the recorded GoDataSet objects. As such, the number of processed boards corresponding to the recorded
 * data will become zero.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanRecording_Clear(GoWebScanRecording recording);

/**
 * Return the approximate total size in bytes of the recorded GoDataSet objects.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @return                  Size in bytes of recorded GoDataSet objects.
 */
GoWebScanFx(k64u) GoWebScanRecording_RecordSize(GoWebScanRecording recording);

/**
 * Return the max allowed size in bytes of the recorded GoDataSet objects. Once this value is reached,
 * additional GoDataSet objects are no longer recorded.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @return                  Max size in bytes of recorded GoDataSet objects.
 */
GoWebScanFx(k64u) GoWebScanRecording_MaxRecordSize(GoWebScanRecording recording);

/**
 * Set the max allowed size in bytes of the recorded GoDataSet objects. Once this value
 * is reached, additional GoDataSet objects may no longer be added.
 *
 * @public                  @memberof GoWebScanRecording
 * @param   recording       GoWebScanRecording object.
 * @param   maxRecordSize   Max size in bytes of recorded GoDataSet objects.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanRecording_SetMaxRecordSize(GoWebScanRecording recording, k64u maxRecordSize);

#include <GoWebScanSdk/GoWebScanRecording.x.h>

#endif