CalibrationTypes.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2019 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_CALIBRATION_ENGINE_CALIBRATIONTYPES_H_
#define DW_CALIBRATION_ENGINE_CALIBRATIONTYPES_H_

#include <dw/core/Types.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwCalibrationRoutineObject* dwCalibrationRoutineHandle_t;
typedef struct dwCalibrationEngineObject* dwCalibrationEngineHandle_t;

typedef enum dwCalibrationState {
    DW_CALIBRATION_STATE_NOT_ACCEPTED = 0,

    DW_CALIBRATION_STATE_ACCEPTED = 1,

    DW_CALIBRATION_STATE_FAILED = 2,
} dwCalibrationState;

DW_API_PUBLIC
dwStatus dwCalibrationState_toString(const char** str, dwCalibrationState state);

typedef struct dwCalibrationStatus
{
    bool started;

    dwCalibrationState state;

    float32_t percentageComplete;
} dwCalibrationStatus;

typedef void (*dwCalibrationStatusChanged)(dwCalibrationRoutineHandle_t routine,
                                           dwCalibrationStatus status,
                                           void* userData);

typedef enum dwCalibrationSignal {
    DW_CALIBRATION_SIGNAL_POSE_SENSOR_TO_RIG    = 1 << 1, 
    DW_CALIBRATION_SIGNAL_POSE_SENSOR_TO_SENSOR = 1 << 2, 
    DW_CALIBRATION_SIGNAL_POSE_ROLL             = 1 << 3, 
    DW_CALIBRATION_SIGNAL_POSE_PITCH            = 1 << 4, 
    DW_CALIBRATION_SIGNAL_POSE_YAW              = 1 << 5, 
    DW_CALIBRATION_SIGNAL_POSE_X                = 1 << 6, 
    DW_CALIBRATION_SIGNAL_POSE_Y                = 1 << 7, 
    DW_CALIBRATION_SIGNAL_POSE_Z                = 1 << 8, 

    DW_CALIBRATION_SIGNAL_VEHICLE_SPEED_FACTOR          = 1 << 9,  
    DW_CALIBRATION_SIGNAL_VEHICLE_WHEEL_RADII           = 1 << 10, 
    DW_CALIBRATION_SIGNAL_VEHICLE_FRONT_STEERING_OFFSET = 1 << 11  
} dwCalibrationSignal;

typedef enum dwCalibrationFastAcceptanceOption {
    DW_CALIBRATION_FAST_ACCEPTANCE_DEFAULT = 0,

    DW_CALIBRATION_FAST_ACCEPTANCE_ENABLED = 1,

    DW_CALIBRATION_FAST_ACCEPTANCE_DISABLED = 2,
} dwCalibrationFastAcceptanceOption;

#ifdef __cplusplus
} // extern C
#endif

#endif // DW_CALIBRATION_ENGINE_CALIBRATIONTYPES_H_