ProcessObject.hpp

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

#ifndef __FWDATA_PROCESSOBJECT_HPP__
#define __FWDATA_PROCESSOBJECT_HPP__

#include "fwData/factory/new.hpp"
#include "fwData/Object.hpp"

#include <map>
#include <vector>

namespace fwData
{
class Field;
}

fwCampAutoDeclareDataMacro((fwData)(ProcessObject), FWDATA_API);

namespace fwData
{

class FWDATA_CLASS_API ProcessObject : public Object
{
public:
    fwCoreClassDefinitionsWithFactoryMacro( (ProcessObject)(::fwData::Object), (()),
                                            ::fwData::factory::New< ProcessObject >);

    fwCampMakeFriendDataMacro((fwData)(ProcessObject));

    typedef std::string ParamNameType;
    typedef std::vector<std::string> ParamNameVectorType;
    typedef std::map< ParamNameType, ::fwData::Object::sptr > ProcessObjectMapType;

    FWDATA_API ProcessObject(::fwData::Object::Key key);

    FWDATA_API virtual ~ProcessObject();

    FWDATA_API ::fwData::Object::sptr getInput(const ParamNameType& name);

    template< class OBJECTTYPE >
    typename OBJECTTYPE::sptr getInput(const ParamNameType& name);

    FWDATA_API ::fwData::Object::sptr getOutput(const ParamNameType& name);

    template< class OBJECTTYPE >
    typename OBJECTTYPE::sptr getOutput(const ParamNameType& name);

    const ProcessObjectMapType& getInputs () const;

    void setInputs (const ProcessObjectMapType& val);

    const ProcessObjectMapType& getOutputs () const;

    void setOutputs (const ProcessObjectMapType& val);

    FWDATA_API void setInputValue(const ParamNameType& name, ::fwData::Object::sptr object);

    FWDATA_API void setOutputValue(const ParamNameType& name, ::fwData::Object::sptr object);

    FWDATA_API ParamNameVectorType getInputsParamNames() const;

    FWDATA_API ParamNameVectorType getOutputsParamNames() const;

    FWDATA_API void clearInputs();

    FWDATA_API void clearOutputs();

    FWDATA_API void shallowCopy( const Object::csptr& source ) override;

    FWDATA_API void cachedDeepCopy(const Object::csptr& source, DeepCopyCacheType& cache) override;

protected:

    FWDATA_API ParamNameVectorType getParamNames(const ProcessObjectMapType& params) const;

    FWDATA_API void setValue(const ParamNameType& name, ::fwData::Object::sptr object, ProcessObjectMapType& params);

    FWDATA_API ::fwData::Object::sptr getValue(const ParamNameType& name, const ProcessObjectMapType& params);

    FWDATA_API void clearParams(ProcessObjectMapType& params);

    ProcessObjectMapType m_inputs;

    ProcessObjectMapType m_outputs;
};

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

template< class OBJECTTYPE >
inline typename OBJECTTYPE::sptr ProcessObject::getInput(const ProcessObject::ParamNameType& name)
{
    return OBJECTTYPE::dynamicCast( this->getInput( name ) );
}

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

template< class OBJECTTYPE >
inline typename OBJECTTYPE::sptr ProcessObject::getOutput(const ProcessObject::ParamNameType& name)
{
    return OBJECTTYPE::dynamicCast( this->getOutput( name ) );
}

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

inline const ProcessObject::ProcessObjectMapType& ProcessObject::getInputs () const
{
    return m_inputs;
}

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

inline void ProcessObject::setInputs (const ProcessObject::ProcessObjectMapType& val)
{
    m_inputs = val;
}

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

inline const ProcessObject::ProcessObjectMapType& ProcessObject::getOutputs () const
{
    return m_outputs;
}

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

inline void ProcessObject::setOutputs (const ProcessObject::ProcessObjectMapType& val)
{
    m_outputs = val;
}

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

} // namespace fwData

#endif // __FWDATA_PROCESSOBJECT_HPP__