StructArray.h

Go to the documentation of this file.

#ifndef MATIOCPP_STRUCTARRAY_H
#define MATIOCPP_STRUCTARRAY_H
 
/*
 * Copyright (C) 2020 Fondazione Istituto Italiano di Tecnologia
 *
 * This software may be modified and distributed under the terms of the
 * BSD-2-Clause license (https://opensource.org/licenses/BSD-2-Clause).
 */
 
#include <matioCpp/ForwardDeclarations.h>
#include <matioCpp/Variable.h>
#include <matioCpp/Struct.h>
#include <matioCpp/StructArrayElement.h>
 
class matioCpp::StructArray : public matioCpp::Variable
{
 
    virtual bool checkCompatibility(const matvar_t* inputPtr, matioCpp::VariableType variableType, matioCpp::ValueType valueType) const final;
 
    template<bool>
    friend class StructArrayElement;
 
public:
 
    using index_type = size_t; 
    using Element = StructArrayElement<false>; 
    using ConstElement = StructArrayElement<true>; 
    StructArray();
 
    StructArray(const std::string& name);
 
    StructArray(const std::string& name, const std::vector<index_type>& dimensions);
 
    StructArray(const std::string& name,
                const std::vector<index_type>& dimensions,
                const std::vector<matioCpp::Struct>& elements);
 
    StructArray(const std::string& name,
                const std::vector<index_type>& dimensions,
                const std::vector<std::string>& fields);
 
    StructArray(const StructArray& other);
 
    StructArray(StructArray&& other);
 
    StructArray(const MatvarHandler& handler);
 
    ~StructArray();
 
    StructArray& operator=(const StructArray& other);
 
    StructArray& operator=(StructArray&& other);
 
    bool fromVectorOfStructs(const std::vector<index_type> &dimensions, const std::vector<matioCpp::Struct>& elements);
 
    index_type rawIndexFromIndices(const std::vector<index_type>& el) const;
 
    bool indicesFromRawIndex(size_t rawIndex, std::vector<index_type>& el) const;
 
    bool setName(const std::string& newName);
 
    void resize(const std::vector<index_type>& newDimensions);
 
    index_type numberOfElements() const;
 
    index_type numberOfFields() const;
 
    std::vector<std::string> fields() const;
 
    void clear();
 
    bool isFieldExisting(const std::string& field) const;
 
    size_t getFieldIndex(const std::string& field) const;
 
    bool addField(const std::string& newField);
 
    bool addFields(const std::vector<std::string>& newFields);
 
    bool setElement(const std::vector<index_type>& el, const matioCpp::Struct& newValue);
 
    bool setElement(index_type el, const matioCpp::Struct& newValue);
 
    Element operator()(const std::vector<index_type>& el);
 
    ConstElement operator()(const std::vector<index_type>& el) const;
 
    Element operator()(index_type el);
 
    ConstElement operator()(index_type el) const;
 
    Element operator[](const std::vector<index_type>& el);
 
    ConstElement operator[](const std::vector<index_type>& el) const;
 
    Element operator[](index_type el);
 
    ConstElement operator[](index_type el) const;
};
 
#endif // MATIOCPP_STRUCTARRAY_H