SensorMetadata.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
 * All rights reserved.
 *
 * This software may be modified and distributed under the terms of the
 * BSD-3-Clause license. See the accompanying LICENSE file for details.
 */
 
// Autogenerated by Thrift Compiler (0.12.0-yarped)
//
// This is an automatically generated file.
// It could get re-generated if the ALLOW_IDL_GENERATION flag is on.
 
#ifndef YARP_THRIFT_GENERATOR_STRUCT_SENSORMETADATA_H
#define YARP_THRIFT_GENERATOR_STRUCT_SENSORMETADATA_H
 
#include <yarp/os/Wire.h>
#include <yarp/os/idl/WireTypes.h>
 
class SensorMetadata :
        public yarp::os::idl::WirePortable
{
public:
    // Fields
    std::string name;
    std::string frameName;
    std::string additionalMetadata;
 
    // Default constructor
    SensorMetadata();
 
    // Constructor with field values
    SensorMetadata(const std::string& name,
                   const std::string& frameName,
                   const std::string& additionalMetadata);
 
    // Read structure on a Wire
    bool read(yarp::os::idl::WireReader& reader) override;
 
    // Read structure on a Connection
    bool read(yarp::os::ConnectionReader& connection) override;
 
    // Write structure on a Wire
    bool write(const yarp::os::idl::WireWriter& writer) const override;
 
    // Write structure on a Connection
    bool write(yarp::os::ConnectionWriter& connection) const override;
 
    // Convert to a printable string
    std::string toString() const;
 
    // If you want to serialize this class without nesting, use this helper
    typedef yarp::os::idl::Unwrapped<SensorMetadata> unwrapped;
 
    class Editor :
            public yarp::os::Wire,
            public yarp::os::PortWriter
    {
    public:
        // Editor: default constructor
        Editor();
 
        // Editor: constructor with base class
        Editor(SensorMetadata& obj);
 
        // Editor: destructor
        ~Editor() override;
 
        // Editor: Deleted constructors and operator=
        Editor(const Editor& rhs) = delete;
        Editor(Editor&& rhs) = delete;
        Editor& operator=(const Editor& rhs) = delete;
        Editor& operator=(Editor&& rhs) = delete;
 
        // Editor: edit
        bool edit(SensorMetadata& obj, bool dirty = true);
 
        // Editor: validity check
        bool isValid() const;
 
        // Editor: state
        SensorMetadata& state();
 
        // Editor: start editing
        void start_editing();
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.2
        YARP_DEPRECATED_MSG("Use start_editing() instead")
        void begin()
        {
            start_editing();
        }
#endif // YARP_NO_DEPRECATED
 
        // Editor: stop editing
        void stop_editing();
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.2
        YARP_DEPRECATED_MSG("Use stop_editing() instead")
        void end()
        {
            stop_editing();
        }
#endif // YARP_NO_DEPRECATED
 
        // Editor: name field
        void set_name(const std::string& name);
        const std::string& get_name() const;
        virtual bool will_set_name();
        virtual bool did_set_name();
 
        // Editor: frameName field
        void set_frameName(const std::string& frameName);
        const std::string& get_frameName() const;
        virtual bool will_set_frameName();
        virtual bool did_set_frameName();
 
        // Editor: additionalMetadata field
        void set_additionalMetadata(const std::string& additionalMetadata);
        const std::string& get_additionalMetadata() const;
        virtual bool will_set_additionalMetadata();
        virtual bool did_set_additionalMetadata();
 
        // Editor: clean
        void clean();
 
        // Editor: read
        bool read(yarp::os::ConnectionReader& connection) override;
 
        // Editor: write
        bool write(yarp::os::ConnectionWriter& connection) const override;
 
    private:
        // Editor: state
        SensorMetadata* obj;
        bool obj_owned;
        int group;
 
        // Editor: dirty variables
        bool is_dirty;
        bool is_dirty_name;
        bool is_dirty_frameName;
        bool is_dirty_additionalMetadata;
        int dirty_count;
 
        // Editor: send if possible
        void communicate();
 
        // Editor: mark dirty overall
        void mark_dirty();
 
        // Editor: mark dirty single fields
        void mark_dirty_name();
        void mark_dirty_frameName();
        void mark_dirty_additionalMetadata();
 
        // Editor: dirty_flags
        void dirty_flags(bool flag);
    };
 
private:
    // read/write name field
    bool read_name(yarp::os::idl::WireReader& reader);
    bool write_name(const yarp::os::idl::WireWriter& writer) const;
    bool nested_read_name(yarp::os::idl::WireReader& reader);
    bool nested_write_name(const yarp::os::idl::WireWriter& writer) const;
 
    // read/write frameName field
    bool read_frameName(yarp::os::idl::WireReader& reader);
    bool write_frameName(const yarp::os::idl::WireWriter& writer) const;
    bool nested_read_frameName(yarp::os::idl::WireReader& reader);
    bool nested_write_frameName(const yarp::os::idl::WireWriter& writer) const;
 
    // read/write additionalMetadata field
    bool read_additionalMetadata(yarp::os::idl::WireReader& reader);
    bool write_additionalMetadata(const yarp::os::idl::WireWriter& writer) const;
    bool nested_read_additionalMetadata(yarp::os::idl::WireReader& reader);
    bool nested_write_additionalMetadata(const yarp::os::idl::WireWriter& writer) const;
};
 
#endif // YARP_THRIFT_GENERATOR_STRUCT_SENSORMETADATA_H