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

Publisher, that can be used to publish images via SharedMemorySegment. More...

#include <SharedMemoryPublisher.h>

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

Public Member Functions

 SharedMemoryPublisher (const std::string &memorySegmentName="")
 Creates a new publisher instance. More...
 
 ~SharedMemoryPublisher ()
 Destructor. More...
 
void createPublisher (const std::string &memorySegmentName="")
 sets the publisher to use a new segment More...
 
void publish (const core::ImgBase *image)
 publishs given image More...
 
virtual void send (const core::ImgBase *image)
 wraps publish to implement ImageOutput interface More...
 
std::string getMemorySegmentName () const
 returns current memory segment name 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
 intenal data 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

Publisher, that can be used to publish images via SharedMemorySegment.

Constructor & Destructor Documentation

◆ SharedMemoryPublisher()

icl::io::SharedMemoryPublisher::SharedMemoryPublisher ( const std::string &  memorySegmentName = "")

Creates a new publisher instance.

If memorySegmentName is "", no connection is performed

◆ ~SharedMemoryPublisher()

icl::io::SharedMemoryPublisher::~SharedMemoryPublisher ( )

Destructor.

Member Function Documentation

◆ createPublisher()

void icl::io::SharedMemoryPublisher::createPublisher ( const std::string &  memorySegmentName = "")

sets the publisher to use a new segment

◆ getMemorySegmentName()

std::string icl::io::SharedMemoryPublisher::getMemorySegmentName ( ) const

returns current memory segment name

◆ publish()

void icl::io::SharedMemoryPublisher::publish ( const core::ImgBase image)

publishs given image

◆ send()

virtual void icl::io::SharedMemoryPublisher::send ( const core::ImgBase image)
inlinevirtual

wraps publish to implement ImageOutput interface

Implements icl::io::ImageOutput.

Member Data Documentation

◆ m_data

Data* icl::io::SharedMemoryPublisher::m_data
private

intenal data

intenal data


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