IAppConfigManager.hpp

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

#ifndef __FWSERVICES_IAPPCONFIGMANAGER_HPP__
#define __FWSERVICES_IAPPCONFIGMANAGER_HPP__

#include "fwServices/config.hpp"
#include "fwServices/registry/AppInfo.hpp"

#include <fwData/Composite.hpp>

#include <fwTools/Object.hpp>

namespace fwServices
{
class FWSERVICES_CLASS_API IAppConfigManager : public ::fwTools::Object
{
public:
    typedef registry::FieldAdaptorType FieldAdaptorType;

    fwCoreNonInstanciableClassDefinitionsMacro((IAppConfigManager)(::fwTools::Object));

    FWSERVICES_API IAppConfigManager();

    FWSERVICES_API virtual ~IAppConfigManager();

    FWSERVICES_API static SPTR(IAppConfigManager) New();

    bool isCreated() const;
    bool isStarted() const;
    bool isStopped() const;
    bool isDestroyed() const;

    void setConfig(::fwRuntime::ConfigurationElement::csptr cfgElem);

    FWSERVICES_API virtual void setConfig(const std::string& configId,
                                          const FieldAdaptorType& replaceFields = FieldAdaptorType()) = 0;

    FWSERVICES_API virtual void setConfig(const std::string& configId,
                                          const ::fwData::Composite::csptr& replaceFields) = 0;

    FWSERVICES_API virtual ::fwData::Object::sptr getConfigRoot() const = 0;

    FWSERVICES_API virtual void launch() = 0;

    FWSERVICES_API virtual void stopAndDestroy() = 0;

    FWSERVICES_API virtual void create() = 0;

    FWSERVICES_API virtual void start() = 0;

    FWSERVICES_API virtual void update() = 0;

    FWSERVICES_API virtual void stop() = 0;

    FWSERVICES_API virtual void destroy() = 0;

protected:
    enum ConfigState
    {
        STATE_CREATED,
        STATE_STARTED,
        STATE_STOPPED,
        STATE_DESTROYED,
    };

    ::fwRuntime::ConfigurationElement::csptr m_cfgElem;

    ConfigState m_state;
};

//------------------------------------------------------------------------------

inline IAppConfigManager::IAppConfigManager() :
    m_state(STATE_DESTROYED)
{
}

//------------------------------------------------------------------------------

inline IAppConfigManager::~IAppConfigManager()
{

}

//------------------------------------------------------------------------------

inline bool IAppConfigManager::isCreated() const
{
    return m_state == STATE_CREATED;
}

//------------------------------------------------------------------------------

inline bool IAppConfigManager::isStarted() const
{
    return m_state == STATE_STARTED;
}

//------------------------------------------------------------------------------

inline bool IAppConfigManager::isStopped() const
{
    return m_state == STATE_STOPPED;
}

//------------------------------------------------------------------------------

inline bool IAppConfigManager::isDestroyed() const
{
    return m_state == STATE_DESTROYED;
}

//------------------------------------------------------------------------------

inline void IAppConfigManager::setConfig(fwRuntime::ConfigurationElement::csptr cfgElem)
{
    m_cfgElem = cfgElem;
}

//------------------------------------------------------------------------------

} // namespace fwServices

#endif // __FWSERVICES_IAPPCONFIGMANAGER_HPP__