Variable.h

Go to the documentation of this file.

/*****************************************************************************
 * vim:tw=78
 *
 * Copyright (C) 2021 Richard Hacker (lerichi at gmx dot net),
 *                    Florian Pose (fp at igh dot de),
 *                    Bjarne von Horn (vh at igh dot de).
 *
 * This file is part of the PdCom library.
 *
 * The PdCom library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * The PdCom library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the PdCom library. If not, see <http://www.gnu.org/licenses/>.
 *
 *****************************************************************************/

#ifndef PDCOM5_VARIABLE_H
#define PDCOM5_VARIABLE_H

#include "SizeTypeInfo.h"
#include "details.h"
#include "visibility.h"

#include <istream>
#include <memory>
#include <ostream>
#include <stdint.h>
#include <string>
#include <vector>

namespace PdCom {
namespace impl {
class Variable;
}

class PDCOM5_PUBLIC Variable
{
    friend class impl::Variable;

    explicit Variable(std::shared_ptr<const impl::Variable> pimpl) :
        pimpl(std::move(pimpl))
    {}

  public:
    Variable() = default;

    template <typename T>
    typename std::enable_if<!std::is_arithmetic<T>::value, bool>::type
    setValue(T const &data, size_t index = 0) const
    {
        return setValue(
                &data[0],
                details::TypeInfoTraits<typename T::value_type>::type_info.type,
                index, data.size() - index);
    }
    template <typename T>
    typename std::enable_if<std::is_arithmetic<T>::value, bool>::type
    setValue(T const &data, size_t index = 0) const
    {
        return setValue(
                &data, details::TypeInfoTraits<T>::type_info.type, index, 1);
    }

    bool
    setValue(const void *src, TypeInfo::DataType src_type, size_t idx, size_t n)
            const;

    const TypeInfo &getTypeInfo() const noexcept;
    const SizeInfo &getSizeInfo() const noexcept;
    std::string getPath() const;
    std::string getName() const;
    std::string getAlias() const;
    int getTaskId() const;


    bool empty() const noexcept { return !(pimpl); }

  private:
    std::shared_ptr<const impl::Variable> pimpl;
};

}  // namespace PdCom

#endif  // PDCOM5_VARIABLE_H