class mrpt::obs::CObservationCANBusJ1939

Overview

This class stores a message from a CAN BUS with the protocol J1939.

See also:

#include <mrpt/obs/CObservationCANBusJ1939.h>

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

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

    // fields

    static constexpr const char* className = "mrpt::obs" "::" "CObservationCANBusJ1939";
    uint16_t m_pgn {0};
    uint8_t m_src_address {0};
    uint8_t m_priority {0};
    uint8_t m_pdu_format {0};
    uint8_t m_pdu_spec {0};
    uint8_t m_data_length {0};
    std::vector<uint8_t> m_data;
    std::vector<char> m_raw_frame;

    // construction

    CObservationCANBusJ1939();

    // 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& newSensorPose);
    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 ::CObservationCANBusJ1939> Ptr

A type for the associated smart pointer.

Fields

uint16_t m_pgn {0}

The Parameter Group Number within this frame.

uint8_t m_src_address {0}

The address of the source node within this frame.

uint8_t m_priority {0}

The priority.

uint8_t m_pdu_format {0}

PDU Format.

uint8_t m_pdu_spec {0}

PDU Specific.

uint8_t m_data_length {0}

Data length

std::vector<uint8_t> m_data

The data within this frame (0-8 bytes)

std::vector<char> m_raw_frame

The ASCII frame.

Construction

CObservationCANBusJ1939()

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.

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

A general method to change the sensor pose on the robot.

Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.