BaseCompleteImage.h

// BaseCompleteImage.h:
// --------------------
//

#ifndef __IPSDKIMAGE_BASECOMPLETEIMAGE_H__
#define __IPSDKIMAGE_BASECOMPLETEIMAGE_H__

// suppression warnings
// warning C4251: 'ipsdk::image::BaseCompleteImage::_pIdentifier' : class 'boost::shared_ptr<T>' needs to have dll-interface to be used by clients of class 'ipsdk::image::BaseCompleteImage'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImage/Image/BaseImage.h>
#include <IPSDKImage/Geometry/ImageGeometryTypes.h>

namespace ipsdk {
namespace image {

class ImagePlanGeometry;


class IPSDKIMAGE_API BaseCompleteImage : public BaseImage
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImage, BaseCompleteImage);

// predefined public types
public:
    static const eImageBaseType::domain g_imageBaseType = eImageBaseType::eIBT_Complete;

protected:
    BaseCompleteImage();

public:
    virtual ~BaseCompleteImage() = 0;
    
// methods
public:
    eImageBaseType                  getImageBaseType() const;

    virtual eImageType              getImageType() const = 0;

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

    void                            setName(const std::string& imageName);

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

    BaseDataItem&                   getHeaderItem(const std::string& key);

    void                            addHeaderItem(const std::string& key,
                                                  const DataItemPtr& pItem);

    void                            removeHeaderItem(const std::string& key);

    void                            clearHeader();

    virtual BoolResult              resize(const BaseImageGeometry& geometry) = 0;

protected:
    BoolResult                      initBase(const ImageGeometryPtr& pGeometry,
                                             const PlanStorageColl3d& imagePlans);

    DataIdentifierConstPtr          getIdentifier() const;

    virtual void                    clearDerived();

// attributes
protected:
    DataIdentifierPtr       _pIdentifier;

    DataItemMapPtr          _pHeader;
};


inline eImageBaseType
BaseCompleteImage::getImageBaseType() const
{
    return g_imageBaseType;
}


} // end of namespace image
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASECOMPLETEIMAGE_H__