Dimensions.hpp

Go to the documentation of this file.

/*
 
  This file is part of OpenFLUID software
  Copyright(c) 2021-2026, INRAE
 
 
 == GNU General Public License Usage ==
 
  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  OpenFLUID 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 General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
 
 
 == Other Usage ==
 
  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/
 
 
/**
  @file Dimensions.hpp
 
  @author Armel THÖNI <armel.thoni@inrae.fr>
*/
 
 
#ifndef __OPENFLUID_CORE_DIMENSIONS_HPP__
#define __OPENFLUID_CORE_DIMENSIONS_HPP__
 
 
#include <string>
 
#include <openfluid/dllexport.hpp>
 
 
namespace openfluid { namespace core {
 
 
class OPENFLUID_API Dimensions
{
 
  private:
 
    bool splitDimensions(const std::string& DimsStr, const char& Separator);
 
    void applyDimensions(const std::string& SerializedVariableSize);
 
 
  public:
    static const char s_BeginningSymbol;
    static const char s_SeparatorSymbol;
    static const char s_EndSymbol;
 
    enum class DimensionType {SCALAR, VECTOR, MATRIX};
 
    DimensionType Type;
    
    unsigned long Cols, Rows;
 
 
    Dimensions();
 
    Dimensions(unsigned long Size);
 
    Dimensions(unsigned long ColsNbr, unsigned long RowsNbr);
    
    Dimensions(std::string SerializedVariableSize);
 
    std::string strType() const;
 
    bool isScalar() const;
    
    bool isVector() const;
    
    bool isMatrix() const;
 
    const std::string getSerializedVariableSize() const;
};
 
} } // namespaces
 
 
#endif /* __OPENFLUID_CORE_DIMENSIONS_HPP__ */