Field.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 __FWDATATOOLS_HELPER_FIELD_HPP__
#define __FWDATATOOLS_HELPER_FIELD_HPP__

#include "fwDataTools/config.hpp"

#include <fwData/Object.hpp>

namespace fwDataTools
{
namespace helper
{

class FWDATATOOLS_CLASS_API Field
{

public:

    FWDATATOOLS_API Field( ::fwData::Object::sptr object );

    FWDATATOOLS_API ~Field();

    template< typename DATA_TYPE >
    SPTR(DATA_TYPE) setDefaultField( const ::fwData::Object::FieldNameType& name, SPTR(DATA_TYPE) defaultValue );

    FWDATATOOLS_API void setField( const ::fwData::Object::FieldNameType& name, ::fwData::Object::sptr obj );

    FWDATATOOLS_API void setFields( const ::fwData::Object::FieldMapType& newFields );

    FWDATATOOLS_API void removeField( const ::fwData::Object::FieldNameType& name );

    FWDATATOOLS_API void add( const ::fwData::Object::FieldNameType& _name, ::fwData::Object::sptr _obj );

    FWDATATOOLS_API void swap( const ::fwData::Object::FieldNameType& _name, ::fwData::Object::sptr _obj );

    FWDATATOOLS_API void addOrSwap( const ::fwData::Object::FieldNameType& _name, ::fwData::Object::sptr _obj );

    FWDATATOOLS_API void remove(  const ::fwData::Object::FieldNameType& _name );

    FWDATATOOLS_API void clear();

    FWDATATOOLS_API void notify();

protected:
    FWDATATOOLS_API void buildMessage(
        const ::fwData::Object::FieldMapType& oldFields,
        const ::fwData::Object::FieldMapType& newFields
        );

    ::fwData::Object::FieldsContainerType m_addedFields;
    ::fwData::Object::FieldsContainerType m_newChangedFields;
    ::fwData::Object::FieldsContainerType m_oldChangedFields;
    ::fwData::Object::FieldsContainerType m_removedFields;

    ::fwData::Object::wptr m_object;
};

template<typename DATA_TYPE>
inline SPTR(DATA_TYPE) Field::setDefaultField(const fwData::Object::FieldNameType& name, SPTR(DATA_TYPE) defaultValue)
{
    SLM_ASSERT("Field helper need a non-null object pointer", !m_object.expired());
    ::fwData::Object::sptr object = m_object.lock();
    ::fwData::Object::sptr field  = object->getField(name);
    if (!field)
    {
        m_addedFields[name] = defaultValue;
    }
    return object->setDefaultField(name, defaultValue);
}

} // namespace helper
} // namespace fwDataTools

#endif // __FWDATATOOLS_HELPER_FIELD_HPP__