GoAcceleratorMgr.h

Go to the documentation of this file.

/**
 * @file    GoAcceleratorMgr.h
 * @brief   Declares the GoAcceleratorMgr class public interfaces.
 *
 * @internal
 * Copyright (C) 2018 by LMI Technologies Inc.
 * Licensed under the MIT License.
 * Redistributed files must retain the above copyright notice.
 */
#ifndef GO_ACCELERATOR_MGR_H
#define GO_ACCELERATOR_MGR_H

#include <GoSdk/GoSdk.h>
// Don't know why need to explicitly include GoSystem header file again
// here when GoSdk.h already includes it. If this is not done, compile fails
// to find GoSystem declaration!?
#include <GoSdk/GoSystem.h>
#include <GoSdk/Internal/GoAccelSensorPortAlloc.h>

/**
 * @class   GoAcceleratorMgr
 * @extends kObject
 * @ingroup GoSdk
 * @brief   Represents an GoAcceleratorMgr instance.
 */
typedef kObject GoAcceleratorMgr;

/**
* @class   GoAcceleratorMgr
* @extends kValue
* @ingroup GoSdk
* @brief   Represents an GoAcceleratorMgr events passed into the acceleration
*          update callback handler bound in by SDK client.
*/
typedef enum GoAcceleratorMgrAccelEvents
{
    GO_ACCELERATOR_MGR_EVENT_ACCELERATING = 0,  // Sensor acceleration is in progress.
    GO_ACCELERATOR_MGR_EVENT_ACCELERATED,       // Sensor is accelerated successfully.
    GO_ACCELERATOR_MGR_EVENT_DECELERATING,      // Sensor decleration is in progress.
    GO_ACCELERATOR_MGR_EVENT_DECELERATED     // Sensor is no longer accelerated.
} GoAcceleratorMgrAccelEvents;

/**
* @struct  GoAcceleratorMgrAccelUpdate
* @extends kValue
* @ingroup GoSdk
* @brief   Structure to hold data for the acceleration update handler.
*/
typedef struct GoAcceleratorMgrAccelUpdate
{
    k32u                        sensorId;
    GoAcceleratorMgrAccelEvents accelEvent;
} GoAcceleratorMgrAccelUpdate;

/**
* @struct  GoAcceleratorMgrSensorParam
* @extends kValue
* @ingroup GoSdk
* @brief   Structure to hold user configuration parameters from SDK client
*          for a sensor that is to be accelerated.
*/
typedef struct GoAcceleratorMgrSensorParam
{
    GoAccelSensorPortAllocPorts ports;
    kIpAddress                  platformIpAddress;  // Bind an accelerated sensor to this accelerator host interface IP address.
} GoAcceleratorMgrSensorParam;

/**
* @struct  GoAcceleratorMgrSensorInfo
* @extends kValue
* @ingroup GoSdk
* @brief   Structure to return accelerated sensor information to SDK client.
* The param field contains information received from the SDK client, except if
* SDK client requested automatic port selection. In this case, the ports in the
* param field are the ports selected by the SDK for the SDK client.
*/
typedef struct GoAcceleratorMgrSensorInfo
{
    k32u                        sensorId;
    GoSensorAccelStatus         status;
    GoAcceleratorMgrSensorParam param;
} GoAcceleratorMgrSensorInfo;


#include <GoSdk/GoAcceleratorMgr.x.h>

#endif  // GO_ACCELERATOR_MGR_H