Image Component Library (ICL)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes
icl::io::GenericImageOutput Class Reference

Generic Sink for images. More...

#include <GenericImageOutput.h>

Inheritance diagram for icl::io::GenericImageOutput:
icl::io::ImageOutput icl::io::ImageCompressor icl::utils::Uncopyable

List of all members.

Public Member Functions

 GenericImageOutput ()
 Null constructor.
 GenericImageOutput (const std::string &type, const std::string &description)
 Create and initialize.
 GenericImageOutput (const utils::ProgArg &pa)
 Create from given program argument.
void init (const std::string &type, const std::string &description)
 initialize this instance
void init (const utils::ProgArg &pa)
 initialization method (from given progarg)
virtual void send (const core::ImgBase *image)
 sends a new image
bool isNull () const
 returns whether this instance was already initialized
const std::string & getType () const
 retusn current type string
const std::string & getDescription () const
 retusn current description string
virtual void setCompression (const ImageCompressor::CompressionSpec &spec)
 sets the implementations compression options
virtual CompressionSpec getCompression () const
 returns the implementation's current compression type (result.first) and quality (result.second)

Private Attributes

std::string type
std::string description
utils::SmartPtr< ImageOutputimpl

Detailed Description

Generic Sink for images.

Like the GenericGrabber, the GenericImageOutput provides a string-configurable interface for arbitrary image sinks.

Supported Backends

Supported Backends are:

Image Meta Data

Only a few backends do actually support sending also image meta data. So far, this is only supported by the RSB and by the shared memory backend, however, we plan to add this feature at least for the .icl-file core::format. The corresponding GenericGrabber backends for these types are also able to deserialize the images meta data


Constructor & Destructor Documentation

Null constructor.

icl::io::GenericImageOutput::GenericImageOutput ( const std::string &  type,
const std::string &  description 
)

Create and initialize.

See also:
init

Create from given program argument.


Member Function Documentation

virtual CompressionSpec icl::io::GenericImageOutput::getCompression ( ) const [inline, virtual]

returns the implementation's current compression type (result.first) and quality (result.second)

Reimplemented from icl::io::ImageCompressor.

const std::string& icl::io::GenericImageOutput::getDescription ( ) const [inline]

retusn current description string

const std::string& icl::io::GenericImageOutput::getType ( ) const [inline]

retusn current type string

void icl::io::GenericImageOutput::init ( const std::string &  type,
const std::string &  description 
)

initialize this instance

initialization method (from given progarg)

bool icl::io::GenericImageOutput::isNull ( ) const [inline]

returns whether this instance was already initialized

virtual void icl::io::GenericImageOutput::send ( const core::ImgBase image) [inline, virtual]

sends a new image

Implements icl::io::ImageOutput.

virtual void icl::io::GenericImageOutput::setCompression ( const ImageCompressor::CompressionSpec spec) [inline, virtual]

sets the implementations compression options

Reimplemented from icl::io::ImageCompressor.


Member Data Documentation

std::string icl::io::GenericImageOutput::type [private]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines