Header.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_HEADER_H
#define YARP_OS_HEADER_H
 
#include <yarp/os/Portable.h>
#include <yarp/conf/numeric.h>
 
#include <string>
 
namespace yarp::os {
 
class YARP_os_API Header :
        public Portable
{
public:
    using count_t = std::uint32_t;
 
    static constexpr count_t npos = static_cast<count_t>(-1);
 
    explicit Header();
 
    Header(count_t count, yarp::conf::float64_t time, std::string frameId = {});
 
    Header(const Header& rhs);
 
    Header(Header&& rhs) noexcept;
 
    ~Header() override;
 
    Header& operator=(const Header& rhs);
 
    Header& operator=(Header&& rhs) noexcept;
 
    count_t count() const;
 
    yarp::conf::float64_t timeStamp() const;
 
    std::string frameId() const;
 
    bool isValid() const;
 
    void update();
 
    void update(yarp::conf::float64_t time);
 
    void setFrameId(std::string frameId);
 
 
    // Documented in Portable
    bool read(ConnectionReader& connection) override;
 
    // Documented in Portable
    bool write(ConnectionWriter& connection) const override;
 
private:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    class Private;
    Private* mPriv;
#endif // DOXYGEN_SHOULD_SKIP_THIS
};
 
 
} // namespace yarp::os
 
#endif // YARP_OS_HEADER_H