Image Component Library (ICL)
Public Member Functions | Private Attributes | List of all members
icl::io::RSBImageOutput Class Reference

image output implementation using the "Robotics Service Bus (RSB)" More...

#include <RSBImageOutput.h>

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

Public Member Functions

ICLIO_API RSBImageOutput ()
 creates a null instance More...
 
ICLIO_API ~RSBImageOutput ()
 Destructor. More...
 
ICLIO_API RSBImageOutput (const std::string &scope, const std::string &transportList="spread")
 create RSBImageOutput with given scope and comma separated transport list More...
 
ICLIO_API void init (const std::string &scope, const std::string &transportList="spread")
 deferred initialization (see RSBImageOutput(const string&,const string&) More...
 
virtual ICLIO_API void send (const core::ImgBase *image)
 sender method More...
 
bool isNull () const
 returns whether this is a null instance More...
 
 operator bool () const
 returns whether this is not a null instance More...
 
- Public Member Functions inherited from icl::io::ImageOutput
virtual ~ImageOutput ()
 virtual destructor More...
 
virtual CompressionSpec getCompression () const
 provide the protectedly inherited image compressor options here More...
 
virtual void setCompression (const CompressionSpec &spec)
 provide the protectedly inherited image compressor options here More...
 

Private Attributes

Data * m_data
 pimpl type More...
 

Additional Inherited Members

- Protected Member Functions inherited from icl::io::ImageCompressor
Header uncompressHeader (const icl8u *compressedData, int len)
 only decodes an image header More...
 
Header createHeader (const core::ImgBase *image, bool skipMetaData)
 creates a header for a given image (not data will be null) More...
 
 ImageCompressor (const CompressionSpec &spec=CompressionSpec("none"))
 Creates an image Compressor with given compression mode. More...
 
 ~ImageCompressor ()
 Destructor. More...
 
virtual void setCompression (const CompressionSpec &spec)
 string based interface for setting the compression mode More...
 
virtual CompressionSpec getCompression () const
 can be implemented for returning the current compression mode More...
 
utils::Time pickTimeStamp (const icl8u *compressedData)
 this can help to find out wheter the data is new and must be encoded More...
 
const CompressedData compress (const core::ImgBase *image, bool skipMetaData=false)
 encodes a given image into the compressed code More...
 
const core::ImgBaseuncompress (const icl8u *compressedData, int len, core::ImgBase **dst=0)
 decodes the given byte segment More...
 
- Protected Member Functions inherited from icl::utils::Uncopyable
 Uncopyable ()
 Empty base constructor. More...
 

Detailed Description

image output implementation using the "Robotics Service Bus (RSB)"

Constructor & Destructor Documentation

◆ RSBImageOutput() [1/2]

ICLIO_API icl::io::RSBImageOutput::RSBImageOutput ( )

creates a null instance

◆ ~RSBImageOutput()

ICLIO_API icl::io::RSBImageOutput::~RSBImageOutput ( )

Destructor.

◆ RSBImageOutput() [2/2]

ICLIO_API icl::io::RSBImageOutput::RSBImageOutput ( const std::string &  scope,
const std::string &  transportList = "spread" 
)

create RSBImageOutput with given scope and comma separated transport list

supported transports are socket, spread and inprocess. Please note, that the spread-transport requires spread running.

Member Function Documentation

◆ init()

ICLIO_API void icl::io::RSBImageOutput::init ( const std::string &  scope,
const std::string &  transportList = "spread" 
)

deferred initialization (see RSBImageOutput(const string&,const string&)

supported transports are socket, spread and inprocess. Please note, that the spread-transport requires spread running.

◆ isNull()

bool icl::io::RSBImageOutput::isNull ( ) const
inline

returns whether this is a null instance

◆ operator bool()

icl::io::RSBImageOutput::operator bool ( ) const
inline

returns whether this is not a null instance

◆ send()

virtual ICLIO_API void icl::io::RSBImageOutput::send ( const core::ImgBase image)
virtual

sender method

Implements icl::io::ImageOutput.

Member Data Documentation

◆ m_data

Data* icl::io::RSBImageOutput::m_data
private

pimpl type

pimpl pointer


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