StructuringElementXYZ.h

// StructuringElementXYZ.h:
// ------------------------
//

#ifndef __IPSDKBASEDATA_STRUCTURINGELEMENTXYZ_H__
#define __IPSDKBASEDATA_STRUCTURINGELEMENTXYZ_H__

// suppression warnings
// warning C4251: 'ipsdk::StructuringElementXYZ::_dataColl' : class 'std::set<_Kty>' needs to have dll-interface to be used by clients of class 'ipsdk::StructuringElementXYZ'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseData/Pattern/StructuringElement/BaseStructuringElement.h>
#include <set>

namespace ipsdk {

class OffsetXYZ;


class IPSDKBASEDATA_API StructuringElementXYZ : public BaseStructuringElement
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKBaseData, StructuringElementXYZ)

public:
    StructuringElementXYZ();
    ~StructuringElementXYZ();

// methods
public:
    eStructuringElementType getStructuringElementType() const;

    ipUInt32                getNbData() const;

    bool                    exists(const OffsetXYZ& offset) const;

    void                    insert(const OffsetXYZ& offset);

    void                    remove(const OffsetXYZ& offset);

    const XYZOffsetColl&    getDataColl() const;

    void                    setDataColl(const XYZOffsetColl& dataColl);

    const ipUInt32          getSizeX() const;
    const ipUInt32          getSizeY() const;
    const ipUInt32          getSizeZ() const;

    const ipInt32           getMinX() const;
    const ipInt32           getMinY() const;
    const ipInt32           getMinZ() const;

    const ipInt32           getMaxX() const;
    const ipInt32           getMaxY() const;
    const ipInt32           getMaxZ() const;

    const ipUInt32          getStartingSizeX() const;
    const ipUInt32          getStartingSizeY() const;
    const ipUInt32          getStartingSizeZ() const;

    const ipUInt32          getEndingSizeX() const;
    const ipUInt32          getEndingSizeY() const;
    const ipUInt32          getEndingSizeZ() const;

    void                    clear();

// attributes
protected:
    XYZOffsetColl   _dataColl;

    ipInt32         _minX;
    ipInt32         _minY;
    ipInt32         _minZ;

    ipUInt32        _sizeX;
    ipUInt32        _sizeY;
    ipUInt32        _sizeZ;
};


inline eStructuringElementType
StructuringElementXYZ::getStructuringElementType() const
{
    return eStructuringElementType::eSET_XYZ;
}

inline const ipUInt32
StructuringElementXYZ::getSizeX() const
{
    return _sizeX;
}

inline const ipUInt32
StructuringElementXYZ::getSizeY() const
{
    return _sizeY;
}

inline const ipUInt32
StructuringElementXYZ::getSizeZ() const
{
    return _sizeZ;
}

inline const ipInt32
StructuringElementXYZ::getMinX() const
{
    return _minX;
}

inline const ipInt32
StructuringElementXYZ::getMinY() const
{
    return _minY;
}

inline const ipInt32
StructuringElementXYZ::getMinZ() const
{
    return _minZ;
}

inline const ipInt32
StructuringElementXYZ::getMaxX() const
{
    if (_sizeX != 0)
        return _minX + static_cast<ipInt32>(_sizeX-1);
    else
        return 0;
}

inline const ipInt32
StructuringElementXYZ::getMaxY() const
{
    if (_sizeY != 0)
        return _minY + static_cast<ipInt32>(_sizeY-1);
    else
        return 0;
}

inline const ipInt32
StructuringElementXYZ::getMaxZ() const
{
    if (_sizeZ != 0)
        return _minZ + static_cast<ipInt32>(_sizeZ-1);
    else
        return 0;
}

inline const ipUInt32
StructuringElementXYZ::getStartingSizeX() const
{
    if (_minX < 0)
        return static_cast<ipUInt32>(-_minX);
    else
        return 0;
}

inline const ipUInt32
StructuringElementXYZ::getStartingSizeY() const
{
    if (_minY < 0)
        return static_cast<ipUInt32>(-_minY);
    else
        return 0;
}

inline const ipUInt32
StructuringElementXYZ::getStartingSizeZ() const
{
    if (_minZ < 0)
        return static_cast<ipUInt32>(-_minZ);
    else
        return 0;
}

inline const ipUInt32
StructuringElementXYZ::getEndingSizeX() const
{
    ipInt32 maxX = getMaxX();
    if (maxX > 0)
        return maxX;
    else
        return 0;
}

inline const ipUInt32
StructuringElementXYZ::getEndingSizeY() const
{
    ipInt32 maxY = getMaxY();
    if (maxY > 0)
        return maxY;
    else
        return 0;
}

inline const ipUInt32
StructuringElementXYZ::getEndingSizeZ() const
{
    ipInt32 maxZ = getMaxZ();
    if (maxZ > 0)
        return maxZ;
    else
        return 0;
}


} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEDATA_STRUCTURINGELEMENTXYZ_H__