StructureProperties.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK 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 version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/

#ifndef STRUCTUREPROPERTIES_H
#define STRUCTUREPROPERTIES_H

#include "PhysicalModelIO.h"
#include "Properties.h"
class StructureProperties : public Properties {
public:
    enum GeometricType {
        INVALID, 
        ATOM, 
        LINE, 
        TRIANGLE, 
        QUAD, 
        TETRAHEDRON, 
        WEDGE, 
        PYRAMID, 
        HEXAHEDRON, 
        POLY_LINE, 
        POLY_VERTEX 
    };

    static GeometricType toType(const std::string);

    static std::string toString(const GeometricType);

    StructureProperties(PhysicalModel*, const GeometricType);
    ~StructureProperties() = default;

    void setType(const GeometricType t);

    GeometricType getType() const;

    void xmlPrint(std::ostream&) const;

    unsigned int getIndex() const;

    void setIndex(const unsigned int);

private:
    GeometricType type;

protected:
    unsigned int index;

};

// ---------------- inlines -------------------
inline StructureProperties::GeometricType StructureProperties::getType() const {
    return type;
}
inline void StructureProperties::setType(const StructureProperties::GeometricType t) {
    type = t;
}
inline unsigned int StructureProperties::getIndex() const {
    return index;
}
inline void StructureProperties::setIndex(const unsigned int newIndex) {
    index = newIndex;
}

#endif //STRUCTUREPROPERTIES_H