Plugin/Source/SenseGloveCore/Public/SGCore/SGDeviceModel.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
 *
 * Base class for Device Models containing the minimum amount of data gathered
 * through Communications Protocol. Used for shared functionality.
 */


#pragma once

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

#include "SGDeviceModel.generated.h"

class FSGDeviceModelImpl;

/**
 * Base class containing the minimum amount of data for device models.
 */
UCLASS(BlueprintType)
class SENSEGLOVECORE_API USGDeviceModel final : public UObject
{
    GENERATED_BODY()

public:
    static USGDeviceModel* NewDeviceModel(
        UObject* Outer, const FSGDeviceModelImpl& DeviceModelImpl);

public:
    /**
     *
     */
    static USGDeviceModel* NewDeviceModel(UObject* Outer);

    /**
     *
     */
    static USGDeviceModel* NewDeviceModel(
        UObject* Outer,
        const FString& Id, const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion);

public:
    /**
     * Parse a 32-bit integer value into a set of booleans (010010011) that indicate which (optional) functions this device has.
     */
    static TArray<bool> ParseFunctions(int32 Value, int32 Size);

    /**
     *
     */
    static void ParseFirmware(const FString& RawFirmware, int32& OutMainVersion, int32& OutSubVersion);

private:
    struct FImpl;

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

    TUniquePtr<FImpl, FImplDeleter> Pimpl;
    FImplDeleter PimplDeleter;

public:
    /**
     * Empty constructor to be used by child classes.
     */
    USGDeviceModel();

    /**
     *
     */
    USGDeviceModel(const FString& Id, const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion);

public:
    /**
     * The cast from underlying type constructor.
     */
    explicit USGDeviceModel(const FSGDeviceModelImpl& DeviceModelImpl);

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

protected:
    /**
     * Allows to set the underlying object after construction.
     */
    void SetDeviceModelImpl(const FSGDeviceModelImpl& DeviceModelImpl);

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

protected:
    /**
     * The non-const cast to underlying type method.
     */
    FSGDeviceModelImpl& ToDeviceModelImpl();

public:
    /**
     * Retrieve the Unique identifier of this device.
     */
    FString GetDeviceId() const;

    /**
     * Retrieve the Hardware (sub) version of this Sense Glove Device.
     */
    FString GetHardwareVersion() const;

    /**
     * Firmware version running on the device's MicroController. (as v4.12, this is the 4).
     */
    int32 GetFirmwareVersion() const;

    /**
     * Sub firmware version running on the device's microcontroller (as v4.12, this is the 12).
     */
    int32 GetSubFirmwareVersion() const;
};