The class for handling with image information. More...

#include <ricoh_camera_sdk/camera_image.hpp>

Public Member Functions
virtual	~CameraImage ()=default

virtual const std::string &	getId () const =0
	Returns the ID of the image. More...

virtual const std::string &	getName () const =0
	Returns the name of the image. More...

virtual uint64_t	getSize () const =0
	Returns the size of the image. More...

virtual ImageType	getType () const =0
	Returns the type of the image. More...

virtual ImageFormat	getFormat () const =0
	Returns the format of the image. More...

virtual bool	hasThumbnail () const =0
	Returns `true` if a thumbnail can be acquired. More...

virtual time_t	getDateTime () const =0
	Returns the date and time of image creation. More...

virtual bool	isExist () const =0
	Returns `true` if the entity of image exists in device. More...

virtual std::shared_ptr< const CameraStorage >	getStorage () const =0
	Returns the storage having the image. More...

virtual Response	getData (std::ostream &outStream) const =0
	Writes image data to a stream. More...

virtual Response	getThumbnail (std::ostream &outStream) const =0
	Writes thumbnail data to a stream. More...

virtual Response	deleteData () const =0
	Deletes image data on camera device. More...

Detailed Description

The class for handling with image information.

Constructor & Destructor Documentation

virtual Ricoh::CameraController::CameraImage::~CameraImage ( )

virtualdefault

Member Function Documentation

virtual Response Ricoh::CameraController::CameraImage::deleteData ( ) const

pure virtual

Deletes image data on camera device.

Returns: The operation response

virtual Response Ricoh::CameraController::CameraImage::getData ( std::ostream & outStream ) const

pure virtual

Writes image data to a stream.

Parameters

outStream The written stream

Returns: The operation response

virtual time_t Ricoh::CameraController::CameraImage::getDateTime ( ) const

pure virtual

Returns the date and time of image creation.

Returns: The date and time

virtual ImageFormat Ricoh::CameraController::CameraImage::getFormat ( ) const

pure virtual

Returns the format of the image.

Returns: The format

virtual const std::string& Ricoh::CameraController::CameraImage::getId ( ) const

pure virtual

Returns the ID of the image.

Returns: The ID

virtual const std::string& Ricoh::CameraController::CameraImage::getName ( ) const

pure virtual

Returns the name of the image.

Returns: The name

virtual uint64_t Ricoh::CameraController::CameraImage::getSize ( ) const

pure virtual

Returns the size of the image.

Returns: The size

virtual std::shared_ptr<const CameraStorage> Ricoh::CameraController::CameraImage::getStorage ( ) const

pure virtual

Returns the storage having the image.

Returns: The storage

virtual Response Ricoh::CameraController::CameraImage::getThumbnail ( std::ostream & outStream ) const

pure virtual

Writes thumbnail data to a stream.

Parameters

outStream The written stream

Returns: The operation response

virtual ImageType Ricoh::CameraController::CameraImage::getType ( ) const

pure virtual

Returns the type of the image.

Returns: The type

virtual bool Ricoh::CameraController::CameraImage::hasThumbnail ( ) const

pure virtual

Returns true if a thumbnail can be acquired.

Returns: true If a thumbnail can be acquired and false otherwise

virtual bool Ricoh::CameraController::CameraImage::isExist ( ) const

pure virtual

Returns true if the entity of image exists in device.

Returns: true if the entity of image exists in device and false otherwise

The documentation for this class was generated from the following file:

include/ricoh_camera_sdk/camera_image.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation