Plugin/Source/SenseGloveCore/Public/SGCore/SGCalibrationDataPoint.h

/**
 * @file
 *
 * @author  Mamadou Babaei <mamadou@senseglove.com>
 *
 * @section LICENSE
 *
 * (The MIT License)
 *
 * Copyright (c) 2020 - 2022 SenseGlove
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * @section DESCRIPTION
 *
 *
 */


#pragma once

#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Math/Vector.h"
#include "Templates/UniquePtr.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"

#include "SGCalibrationDataPoint.generated.h"

class FSGCalibrationDataPointImpl;

/**
 *
 */
UCLASS(BlueprintType)
class SENSEGLOVECORE_API USGCalibrationDataPoint final : public UObject
{
    GENERATED_BODY()

public:
    static USGCalibrationDataPoint* NewCalibrationDataPoint(
        UObject* Outer, const FSGCalibrationDataPointImpl& CalibrationDataPointImpl);

public:
    /**
     *
     */
    static USGCalibrationDataPoint* NewCalibrationDataPoint(UObject* Outer);

    /**
     * Create a new data point.
     */
    static USGCalibrationDataPoint* NewCalibrationDataPoint(
        UObject* Outer,
        int32 CurrentStage, const TArray<FVector>& CalibrationValues);

private:
    struct FImpl;

    struct FImplDeleter
    {
        void operator()(const FImpl* P) const;
    };

    TUniquePtr<FImpl, FImplDeleter> Pimpl;
    FImplDeleter PimplDeleter;

public:
    /**
     *
     */
    USGCalibrationDataPoint();

    /**
     * Create a new data point.
     */
    USGCalibrationDataPoint(int32 CurrentStage, const TArray<FVector>& CalibrationValues);

public:
    /**
     * The cast from underlying type constructor.
     */
    explicit USGCalibrationDataPoint(const FSGCalibrationDataPointImpl& CalibrationDataPointImpl);

public:
    /**
     * The destructor.
     */
    virtual ~USGCalibrationDataPoint() override;

protected:
    /**
     * Allows to set the underlying object after construction.
     */
    void SetCalibrationDataPointImpl(const FSGCalibrationDataPointImpl& CalibrationDataPointImpl);

public:
    /**
     * The cast to underlying type method.
     */
    const FSGCalibrationDataPointImpl& ToCalibrationDataPointImpl() const;

public:
    /**
     * Actual calibration values.
     */
    TArray<FVector> GetCalibrationValues() const;

    /**
     * The Calibration stage this data point belongs to.
     */
    int32 GetStage() const;

public:
    /**
     * Log Calibration values for storing on disk.
     */
    FString ToLogData(const FString& Delimiter = "\t") const;
};