MultiComponent.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 MULTICOMPONENT_H
#define MULTICOMPONENT_H

#include <vector>
#include <algorithm>

#include "Component.h"
class MultiComponent : public Component {
public:
    MultiComponent(PhysicalModel*);
    MultiComponent(PhysicalModel*, std::string);
    ~MultiComponent() override;

    unsigned int getNumberOfSubComponents() const;

    Component* getSubComponent(const unsigned int) const;

    void addSubComponent(Component*);

    void removeSubComponent(Component* c);

    void deleteAllSubComponents();

    bool isInstanceOf(const char*) const override;

    void xmlPrint(std::ostream&) const override;

    unsigned int getNumberOfCells() const override;

    Cell* getCell(unsigned int) const override;

    Component* getComponentByName(const std::string);

    bool isVisible(const RenderingMode::Mode mode) const override;

    void setVisible(const RenderingMode::Mode mode, const bool b) override;

    void setPhysicalModel(PhysicalModel*) override;

protected:
    std::vector <Component*> components;
};

// -------------------- inline methods -------------------
inline unsigned int MultiComponent::getNumberOfSubComponents() const {
    return (unsigned int) components.size();
}
inline Component* MultiComponent::getSubComponent(const unsigned int i) const {
    if (i < components.size()) {
        return components[i];
    }
    else {
        return nullptr;
    }
}
inline void MultiComponent::addSubComponent(Component* c) {
    // add c in the list
    components.push_back(c);
    // add this in the list of c's composing component
    c->addParentMultiComponent(this);
    // set the isExclusive flag accordingly
    c->setExclusive(isExclusive());
}
inline void MultiComponent::removeSubComponent(Component* c) {
    auto it = std::find(components.begin(), components.end(), c);
    if (it != components.end()) {
        components.erase(it);
        c->removeParentMultiComponent(this);
    }
}
inline Component* MultiComponent::getComponentByName(const std::string n) {
    auto it = components.begin();
    Component* foundC = nullptr;
    while (it != components.end() && !foundC) {
        foundC = ((*it)->getName() == n) ? (*it) : NULL;
        // look inside the component if it is a MultiComponent
        if (!foundC && (*it)->isInstanceOf("MultiComponent")) {
            foundC = ((MultiComponent*)(*it))->getComponentByName(n);
        }
        it++;
    }
    return foundC;
}
inline bool MultiComponent::isInstanceOf(const char* className) const {
    return (std::string(className) == std::string("MultiComponent"));
}

#endif //MULTICOMPONENT_H