Ocp1DataTypes.h

Go to the documentation of this file.

/* Copyright (c) 2024, Bernardo Escalona
 *
 * This file is part of NanoOcp <https://github.com/ChristianAhrens/NanoOcp>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <vector>       //< USE std::vector
#include <string>       //< USE std::to_string
#include <cmath>        //< USE std::float_t, std::double_t
 
namespace NanoOcp1
{
 
using ByteVector = std::vector<std::uint8_t>;
 
 
enum Ocp1DataType
{
    OCP1DATATYPE_NONE               = 0,    
    OCP1DATATYPE_BOOLEAN            = 1,    
    OCP1DATATYPE_INT8               = 2,    
    OCP1DATATYPE_INT16              = 3,    
    OCP1DATATYPE_INT32              = 4,    
    OCP1DATATYPE_INT64              = 5,    
    OCP1DATATYPE_UINT8              = 6,    
    OCP1DATATYPE_UINT16             = 7,    
    OCP1DATATYPE_UINT32             = 8,    
    OCP1DATATYPE_UINT64             = 9,    
    OCP1DATATYPE_FLOAT32            = 10,   
    OCP1DATATYPE_FLOAT64            = 11,   
    OCP1DATATYPE_STRING             = 12,   
    OCP1DATATYPE_BIT_STRING         = 13,   
    OCP1DATATYPE_BLOB               = 14,   
    OCP1DATATYPE_BLOB_FIXED_LEN     = 15,   
    OCP1DATATYPE_DB_POSITION        = 32,   
    OCP1DATATYPE_CUSTOM             = 128   
};
 
 
bool DataToBool(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromBool(bool boolValue);
 
std::int32_t DataToInt32(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromInt32(std::int32_t value);
 
std::uint8_t DataToUint8(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromUint8(std::uint8_t value);
 
std::uint16_t DataToUint16(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromUint16(std::uint16_t value);
 
std::uint32_t DataToUint32(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromUint32(std::uint32_t value);
 
std::uint64_t DataToUint64(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromUint64(std::uint64_t value);
 
std::string DataToString(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromString(const std::string& string);
 
std::float_t DataToFloat(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromFloat(std::float_t floatValue);
 
std::double_t DataToDouble(const ByteVector& parameterData, bool* pOk = nullptr);
 
ByteVector DataFromDouble(std::double_t doubleValue);
 
ByteVector DataFromPosition(std::float_t x, std::float_t y, std::float_t z);
 
ByteVector DataFromAimingAndPosition(std::float_t hor, std::float_t vert, std::float_t rot, std::float_t x, std::float_t y, std::float_t z);
 
[[deprecated("Use DataFromAimingAndPosition instead, this method will be removed in the future. "
  "NOTE: The order of the input parameters in the new method has been changed to be more consistent with the marshaling order.")]]
ByteVector DataFromPositionAndRotation(std::float_t x, std::float_t y, std::float_t z, std::float_t hor, std::float_t vert, std::float_t rot);
 
ByteVector DataFromOnoForSubscription(std::uint32_t ono, bool add = true);
 
std::string StatusToString(std::uint8_t status);
 
std::string DataTypeToString(int dataType);
 
std::string HandleToString(std::uint32_t handle);
 
std::uint32_t ReadUint32(const char* buffer);
 
std::uint32_t ReadUint32(const std::uint8_t* buffer);
 
std::uint16_t ReadUint16(const char* buffer);
 
std::uint16_t ReadUint16(const std::uint8_t* buffer);
 
std::uint32_t GetONo(std::uint32_t type, std::uint32_t record, std::uint32_t channel, std::uint32_t boxAndObjectNumber);
 
std::uint32_t GetONoTy2(std::uint32_t type, std::uint32_t record, std::uint32_t channel, std::uint32_t boxNumber, std::uint32_t objectNumber);
 
}