degate  0.1.2
Public Member Functions | Protected Member Functions | Private Attributes
degate::ImageWriterBase< ImageType > Class Template Reference

The base class for image readers. More...

#include <ImageWriterBase.h>

Inheritance diagram for degate::ImageWriterBase< ImageType >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ImageWriterBase (unsigned int _width, unsigned int _height, std::string const &_filename)
 Constructor.
virtual ~ImageWriterBase ()
 The destructor.
std::string get_filename () const
 Get the filename.
unsigned int get_width () const
 Get the image width.
unsigned int get_height () const
 Get the image height.
virtual bool write_image (std::shared_ptr< ImageType > img)=0
 Writer the image into a file.

Protected Member Functions

void set_width (unsigned int _width)
 Set the width of the image.
void set_height (unsigned int _height)
 Set the height of the image.

Private Attributes

std::string filename
unsigned int width
unsigned int height

Detailed Description

template<class ImageType>
class degate::ImageWriterBase< ImageType >

The base class for image readers.

Definition at line 42 of file ImageWriterBase.h.


Constructor & Destructor Documentation

template<class ImageType >
degate::ImageWriterBase< ImageType >::ImageWriterBase ( unsigned int  _width,
unsigned int  _height,
std::string const &  _filename 
) [inline]

Constructor.

Definition at line 72 of file ImageWriterBase.h.

                                                 :
      filename(_filename),
      width(_width),
      height(_height) {}
template<class ImageType >
virtual degate::ImageWriterBase< ImageType >::~ImageWriterBase ( ) [inline, virtual]

The destructor.

Definition at line 83 of file ImageWriterBase.h.

{}

Member Function Documentation

template<class ImageType >
std::string degate::ImageWriterBase< ImageType >::get_filename ( ) const [inline]

Get the filename.

Definition at line 89 of file ImageWriterBase.h.

References degate::ImageWriterBase< ImageType >::filename.

{ return filename; }
template<class ImageType >
unsigned int degate::ImageWriterBase< ImageType >::get_height ( ) const [inline]

Get the image height.

You have to call read() before.

Definition at line 103 of file ImageWriterBase.h.

References degate::ImageWriterBase< ImageType >::height.

{ return height; }
template<class ImageType >
unsigned int degate::ImageWriterBase< ImageType >::get_width ( ) const [inline]

Get the image width.

You have to call read() before.

Definition at line 96 of file ImageWriterBase.h.

References degate::ImageWriterBase< ImageType >::width.

{ return width; }
template<class ImageType >
void degate::ImageWriterBase< ImageType >::set_height ( unsigned int  _height) [inline, protected]

Set the height of the image.

This method should be called by derived image readers to set the image size.

Definition at line 63 of file ImageWriterBase.h.

References degate::ImageWriterBase< ImageType >::height.

{ height = _height; }
template<class ImageType >
void degate::ImageWriterBase< ImageType >::set_width ( unsigned int  _width) [inline, protected]

Set the width of the image.

This method should be called by derived image readers to set the image size.

Definition at line 55 of file ImageWriterBase.h.

References degate::ImageWriterBase< ImageType >::width.

{ width = _width; }
template<class ImageType >
virtual bool degate::ImageWriterBase< ImageType >::write_image ( std::shared_ptr< ImageType >  img) [pure virtual]

Writer the image into a file.

Implemented in degate::TIFFWriter< ImageType >.


Member Data Documentation

template<class ImageType >
std::string degate::ImageWriterBase< ImageType >::filename [private]
template<class ImageType >
unsigned int degate::ImageWriterBase< ImageType >::height [private]
template<class ImageType >
unsigned int degate::ImageWriterBase< ImageType >::width [private]

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