Structure.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2024 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * 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 STRUCTURE_H
#define STRUCTURE_H
 
#include "PhysicalModelIO.h"
#include <vector>
#include <algorithm> // for the remove
#include "StructureProperties.h"
class StructuralComponent;
class Structure {
public:
    Structure()  {
        hasIndex = false;
    }
    virtual ~Structure() = default;
 
    virtual void xmlPrint(std::ostream&, const StructuralComponent*) = 0;
 
    virtual bool isInstanceOf(const char*) const = 0;
 
    bool hasIndex;
 
    unsigned int getIndex() const;
 
    virtual bool setIndex(const unsigned int);
 
    StructureProperties::GeometricType getType() const;
 
    std::vector <StructuralComponent*> getAllStructuralComponents();
 
    unsigned int getNumberOfStructuralComponents() const;
 
    StructuralComponent* getStructuralComponent(unsigned int i);
 
    virtual void addStructuralComponent(StructuralComponent*);
 
    void removeStructuralComponent(StructuralComponent*);
 
    void setName(std::string);
 
    std::string getName() const;
 
    virtual void setPhysicalModel(PhysicalModel*);
 
protected:
 
    StructureProperties* properties{nullptr};
 
private:
 
    std::vector <StructuralComponent*> mySCs;
 
};
 
// -------------------- inline ---------------------
inline std::vector <StructuralComponent*> Structure::getAllStructuralComponents() {
    return mySCs;
}
inline unsigned int Structure::getNumberOfStructuralComponents() const {
    return (unsigned int) mySCs.size();
}
inline StructuralComponent* Structure::getStructuralComponent(unsigned int i) {
    if (i < mySCs.size()) {
        return mySCs[i];
    }
    else {
        return nullptr;
    }
}
inline void Structure::addStructuralComponent(StructuralComponent* sc) {
    mySCs.push_back(sc);
}
 
inline void Structure::removeStructuralComponent(StructuralComponent* sc) {
    auto it = std::find(mySCs.begin(), mySCs.end(), sc);
    if (it != mySCs.end()) {
        mySCs.erase(it);
    }
}
 
 
#endif     //  STRUCTURE_H