class mrpt::obs::CObservationRawDAQ

Overview

Store raw data from a Data Acquisition (DAQ) device, such that input or output analog and digital channels, counters from encoders, etc.

at one sampling instant. All analog values are assumed to be volts. On timing:

See also:

CObservation

#include <mrpt/obs/CObservationRawDAQ.h>

class CObservationRawDAQ: public mrpt::obs::CObservation
{
public:
    // typedefs

    typedef std::shared_ptr<mrpt::obs ::CObservationRawDAQ> Ptr;
    typedef std::shared_ptr<const mrpt::obs ::CObservationRawDAQ> ConstPtr;
    typedef std::unique_ptr<mrpt::obs ::CObservationRawDAQ> UniquePtr;
    typedef std::unique_ptr<const mrpt::obs ::CObservationRawDAQ> ConstUniquePtr;

    // fields

    static constexpr const char* className = "mrpt::obs" "::" "CObservationRawDAQ";
    std::vector<uint8_t> AIN_8bits;
    std::vector<uint16_t> AIN_16bits;
    std::vector<uint32_t> AIN_32bits;
    std::vector<float> AIN_float;
    std::vector<double> AIN_double;
    uint16_t AIN_channel_count {0};
    bool AIN_interleaved {true};
    std::vector<uint8_t> AOUT_8bits;
    std::vector<uint16_t> AOUT_16bits;
    std::vector<float> AOUT_float;
    std::vector<double> AOUT_double;
    std::vector<uint8_t> DIN;
    std::vector<uint8_t> DOUT;
    std::vector<uint32_t> CNTRIN_32bits;
    std::vector<double> CNTRIN_double;
    double sample_rate {0};

    // construction

    CObservationRawDAQ();

    // methods

    static constexpr auto getClassName();
    static const mrpt::rtti::TRuntimeClassId& GetRuntimeClassIdStatic();
    static std::shared_ptr<CObject> CreateObject();

    template <typename... Args>
    static Ptr Create(Args&&... args);

    template <typename Alloc, typename... Args>
    static Ptr CreateAlloc(
        const Alloc& alloc,
        Args&&... args
        );

    template <typename... Args>
    static UniquePtr CreateUnique(Args&&... args);

    virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const;
    virtual mrpt::rtti::CObject* clone() const;
    virtual mrpt::poses::CPose3D getSensorPose() const;
    virtual void setSensorPose(const mrpt::poses::CPose3D&);
    virtual void getDescriptionAsText(std::ostream& o) const;
};

Inherited Members

public:
    // typedefs

    typedef std::shared_ptr<CObject> Ptr;
    typedef std::shared_ptr<const CObject> ConstPtr;
    typedef std::shared_ptr<CSerializable> Ptr;
    typedef std::shared_ptr<const CSerializable> ConstPtr;
    typedef std::shared_ptr<CObservation> Ptr;
    typedef std::shared_ptr<const CObservation> ConstPtr;

    // fields

    mrpt::system::TTimeStamp timestamp {mrpt::Clock::now()};
    std::string sensorLabel;

    // methods

    static const mrpt::rtti::TRuntimeClassId& GetRuntimeClassIdStatic();
    virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const;
    virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const;
    static const mrpt::rtti::TRuntimeClassId& GetRuntimeClassIdStatic();
    virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const;
    static const mrpt::rtti::TRuntimeClassId& GetRuntimeClassIdStatic();
    mrpt::system::TTimeStamp getTimeStamp() const;
    virtual mrpt::system::TTimeStamp getOriginalReceivedTimeStamp() const;
    void load() const;
    virtual void unload() const;
    virtual bool exportTxtSupported() const;
    virtual std::string exportTxtHeader() const;
    virtual std::string exportTxtDataRow() const;

    template <class METRICMAP>
    bool insertObservationInto(
        METRICMAP& theMap,
        const std::optional<const mrpt::poses::CPose3D>& robotPose = std::nullopt
        ) const;

    virtual mrpt::poses::CPose3D getSensorPose() const = 0;
    void getSensorPose(mrpt::poses::CPose3D& out_sensorPose) const;
    void getSensorPose(mrpt::math::TPose3D& out_sensorPose) const;
    mrpt::math::TPose3D sensorPose() const;
    virtual void setSensorPose(const mrpt::poses::CPose3D& newSensorPose) = 0;
    void setSensorPose(const mrpt::math::TPose3D& newSensorPose);
    virtual void getDescriptionAsText(std::ostream& o) const;
    virtual std::string asString() const;

Typedefs

typedef std::shared_ptr<mrpt::obs ::CObservationRawDAQ> Ptr

A type for the associated smart pointer.

Fields

std::vector<uint16_t> AIN_16bits

Readings from 8-bit analog input (ADCs) channels (vector length=channel count) in ADC units.

std::vector<uint32_t> AIN_32bits

Readings from 16-bit analog input (ADCs) channels (vector length=channel count) in ADC units.

std::vector<float> AIN_float

Readings from 32-bit analog input (ADCs) channels (vector length=channel count) in ADC units.

std::vector<double> AIN_double

Readings from analog input (ADCs) channels (vector length=channel count) in Volts.

uint16_t AIN_channel_count {0}

Readings from analog input (ADCs) channels (vector length=channel count) in Volts.

How many different ADC channels are present in the AIN_* vectors.

bool AIN_interleaved {true}

Whether the channels are interleaved (A0 A1 A2 A0 A1 A2…) or not (A0 A0 A0 A1 A1 A1 A2 A2 A2…) in the AIN_* vectors.

std::vector<uint16_t> AOUT_16bits

Present output values for 8-bit analog output (DACs) channels (vector length=channel count) in DAC units.

std::vector<float> AOUT_float

Present output values for 16-bit analog output (DACs) channels (vector length=channel count) in DAC units.

std::vector<double> AOUT_double

Present output values for 16-bit analog output (DACs) channels (vector length=channel count) in volts.

std::vector<uint8_t> DIN

Present output values for 16-bit analog output (DACs) channels (vector length=channel count) in volts.

std::vector<uint8_t> DOUT

Readings from digital inputs; each byte stores 8 digital inputs, or 8-bit port.

std::vector<uint32_t> CNTRIN_32bits

Present digital output values; each byte stores 8 digital inputs, or 8-bit port.

std::vector<double> CNTRIN_double

Readings from ticks counters, such as quadrature encoders.

(vector length=channel count) in ticks.

double sample_rate {0}

Readings from ticks counters, such as quadrature encoders.

(vector length=channel count) in radians, degrees or any other unit (depends on the source driver). The sampling rate, in samples per second per channel

Construction

CObservationRawDAQ()

Constructor.

Methods

virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() const

Returns information about the class of an object in runtime.

virtual mrpt::rtti::CObject* clone() const

Returns a deep copy (clone) of the object, indepently of its class.

virtual mrpt::poses::CPose3D getSensorPose() const

Not used in this class.

virtual void setSensorPose(const mrpt::poses::CPose3D&)

Not used in this class.

virtual void getDescriptionAsText(std::ostream& o) const

Build a detailed, multi-line textual description of the observation contents and dump it to the output stream.

If overried by derived classes, call base CObservation::getDescriptionAsText() first to show common information.

This is the text that appears in RawLogViewer when selecting an object in the dataset