modeling/libraries/pml/Component.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 COMPONENT_H
#define COMPONENT_H

#include "RenderingMode.h"
#include "Properties.h"
#include <string>
#include <vector>
#include <algorithm> // for remove
class Cell;
class MultiComponent;
class Component {
public:
    Component(PhysicalModel*, std::string n = "");

    virtual ~Component();

    bool isExclusive() const;

    void setExclusive(const bool);

    virtual bool isInstanceOf(const char*) const = 0;

    const std::string getName() const;

    void setName(const std::string);

    virtual void xmlPrint(std::ostream&) const = 0;

    virtual unsigned int getNumberOfCells() const = 0;

    virtual Cell* getCell(unsigned int) const = 0;

    virtual bool isVisible(const RenderingMode::Mode mode) const = 0;

    virtual void setVisible(const RenderingMode::Mode mode, const bool b) = 0;

    std::vector <MultiComponent*> getAllParentMultiComponents();

    unsigned int getNumberOfParentMultiComponents() const;

    MultiComponent* getParentMultiComponent(unsigned int);

    void addParentMultiComponent(MultiComponent*);

    void removeParentMultiComponent(MultiComponent*);
    virtual void setPhysicalModel(PhysicalModel*);

    PhysicalModel* getPhysicalModel() const;

    Properties* getProperties();

protected:
    Properties* properties;

    void removeFromParents();

    void deleteProperties();

private:
    bool exclusive;

    std::vector <MultiComponent*> parentMultiComponentList;

};

// -------------- inline -------------
inline void Component::setExclusive(const bool b) {
    exclusive = b;
}
inline bool Component::isExclusive() const {
    return exclusive;
}
inline const std::string Component::getName() const {
    return properties->getName();
}
inline void Component::setName(const std::string n) {
    properties->setName(n);
}

// -------------- parent Multi Component admin  -------------

inline std::vector <MultiComponent*> Component::getAllParentMultiComponents() {
    return parentMultiComponentList;
}
inline unsigned int Component::getNumberOfParentMultiComponents() const {
    return (unsigned int) parentMultiComponentList.size();
}
inline MultiComponent* Component::getParentMultiComponent(unsigned int i) {
    if (i < parentMultiComponentList.size()) {
        return parentMultiComponentList[i];
    }
    else {
        return nullptr;
    }
}
inline void Component::addParentMultiComponent(MultiComponent* c) {
    parentMultiComponentList.push_back(c);
}
inline void Component::removeParentMultiComponent(MultiComponent* c) {
    auto it = std::find(parentMultiComponentList.begin(), parentMultiComponentList.end(), c);
    if (it != parentMultiComponentList.end()) {
        parentMultiComponentList.erase(it);
    }
}

inline void Component::setPhysicalModel(PhysicalModel* pm) {
    properties->setPhysicalModel(pm);
}

inline PhysicalModel* Component::getPhysicalModel() const {
    return properties->getPhysicalModel();
}

inline Properties* Component::getProperties() {
    return properties;
}


#endif //COMPONENT_H