Extension.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2018.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#pragma once

#include "fwRuntime/BundleElement.hpp"
#include "fwRuntime/config.hpp"
#include "fwRuntime/ConfigurationElementContainer.hpp"

#include <libxml/tree.h>

#include <string>

namespace fwRuntime
{

struct Bundle;

namespace io
{
struct BundleDescriptorReader;
} // namespace io

struct Extension : public BundleElement,
                   public ConfigurationElementContainer
{
    friend struct ::fwRuntime::io::BundleDescriptorReader;

    typedef enum
    {
        UnknownValidity,    
        Valid,              
        Invalid             
    } Validity;

    ~Extension();

    FWRUNTIME_API const std::string& getIdentifier() const;

    FWRUNTIME_API const std::string& getPoint() const;

    FWRUNTIME_API Validity getValidity() const;

    FWRUNTIME_API xmlNodePtr getXmlNode() const;

    FWRUNTIME_API Validity validate();

    protected:

        Extension( std::shared_ptr<Bundle> bundle, const std::string& id, const std::string& point,
                   const xmlNodePtr xmlNode );

    private:

        const std::string m_id;     
        const std::string m_point;  
                                    // connected to.
        xmlDocPtr m_xmlDoc;         
                                    // extension
        xmlNodePtr m_xmlNode;       
        Validity m_validity;        

        void operator=(const Extension&) noexcept;

};

} // namespace fwRuntime