GmiTypes.h

Go to the documentation of this file.

#pragma once
#include <gmi/iface/global.h>
#include <misc/gen/TSet.h>
#include <misc/gen/Value.h>
#if IS_QT
  #include <QMetaType>
#endif
 
namespace sf::gmi
{
 
#if IS_QT
Q_NAMESPACE_EXPORT(_GMI_DATA)
#endif
 
typedef unsigned long long IdType;
 
typedef TVector<IdType> IdList;
 
enum EAxisValueType : unsigned int
{
  avtNone = 0,
  avtPosition,
  avtVelocity,
  avtAcceleration
};
#if IS_QT
Q_ENUM_NS(EAxisValueType)
#endif
 
enum EAxisMovement : unsigned int
{
  amLinear = 0,
  amRadial = 1,
  amLimited = 2
};
 
typedef TSet<EAxisMovement> AxisMovements;
 
enum EAxisLocation : int
{
  alNA = -1,
  alX = 0,
  alY,
  alZ,
  alA,
  alB,
  alC,
  alD,
  alE,
  alAux1,
  alAux2,
  //  alAUX3, // Auxiliary axis 3 has no location in the constellation of axes.
  //  alAUX4, // Auxiliary axis 4 has no location in the constellation of axes.
  alLastEntry,
  alFirstEntry = 0
};
 
typedef TSet<EAxisLocation> AxisLocations;
 
_GMI_FUNC std::string_view getAxisName(int axis_loc);
 
_GMI_FUNC std::string_view getAxisUnit(int axis_loc, EAxisValueType type);
 
_GMI_FUNC std::string_view getAxisValueTypeName(EAxisValueType type);
 
_GMI_FUNC std::string_view getMovementsUnit(const AxisMovements& ams, EAxisValueType type);
 
class _GMI_CLASS AxisValue
{
  public:
    AxisValue(int location, double value);
    AxisValue(const Value& location, const Value& value);
    AxisValue() = default;
    EAxisLocation _location{alNA};
    double _value{0.0};
};
 
inline AxisValue::AxisValue(int location, double value)
  : _location(static_cast<EAxisLocation>(location))
  , _value(value)
{}
 
inline AxisValue::AxisValue(const Value& location, const Value& value)
  : _location(static_cast<EAxisLocation>(location.getInteger()))
  , _value(value.getFloat())
{}
 
}// namespace sf::gmi