class P1::CameraSdk::ImageEnumBuffer

Overview

#include <C_P1CameraPrivStructs.hpp>

class ImageEnumBuffer:
    public P1::CameraSdk::IImageBuffer,
    public P1::CameraSdk::ImageFileCommonImpl
{
public:
    // typedefs

    typedef P1::IQP::ImageEnumerationAgent::ImageBuffer const PrivStructType;

    // construction

    ImageEnumBuffer(PrivStructType*const dataStruct);

    // methods

    virtual std::shared_ptr<uint8_t const> Data() const;
    virtual size_t DataSizeBytes() const;
    virtual ImageFormat Format() const;
    virtual Type BufferType() const;
    virtual char const* BufferTypeStr() const;
    virtual char const* FormatStr() const;
};

// direct descendants

class PreviewImpl;
class TileImpl;

Inherited Members

public:
    // typedefs

    typedef P1::IQP::ImageEnumerationAgent::AssembleStatus const PrivStructTypeCommon;

    // enums

    enum Type;
    enum Errors;

    // methods

    virtual std::shared_ptr<uint8_t const> Data() const = 0;
    virtual size_t DataSizeBytes() const = 0;
    virtual ImageFormat Format() const = 0;
    virtual Type BufferType() const = 0;
    virtual char const* BufferTypeStr() const = 0;
    virtual char const* FormatStr() const = 0;
    virtual uint32_t ImageId() const = 0;
    virtual bool AnyErrors() const = 0;
    virtual Errors ImageFileErrors() const = 0;
    virtual std::string ErrorsString() const = 0;
    virtual uint32_t ImageId() const;
    virtual bool AnyErrors() const;
    virtual IImageFileCommon::Errors ImageFileErrors() const;
    virtual std::string ErrorsString() const;

Detailed Documentation

Methods

virtual std::shared_ptr<uint8_t const> Data() const

Returns a pointer to the pixel buffer data.

virtual size_t DataSizeBytes() const

Returns the size of the pixel buffer in bytes.

virtual ImageFormat Format() const

Returns the image encoding type of this buffer (bitmap, jpeg)

virtual Type BufferType() const

Returns the type kind of this buffer, (preview or tile)

virtual char const* BufferTypeStr() const

Returns a string of the type kind of this buffer, (preview or tile)

virtual char const* FormatStr() const

Returns a string of the type kind of this buffer, (RGB, JPEG, etc.)