VAPOR3 3.9.4
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VAPoR::ImageWriter Class Referenceabstract

Interface for image writers. More...

#include <ImageWriter.h>

Inheritance diagram for VAPoR::ImageWriter:
Wasp::MyBase VAPoR::JPGWriter VAPoR::PNGWriter VAPoR::TIFWriter VAPoR::GeoTIFWriter

Public Types

enum class  Format { RGB }
 
- Public Types inherited from Wasp::MyBase
typedef void(* ErrMsgCB_T) (const char *msg, int err_code)
 
typedef void(* DiagMsgCB_T) (const char *msg)
 

Public Member Functions

virtual int Write (const unsigned char *buffer, const unsigned int width, const unsigned int height)=0
 
virtual ~ImageWriter ()
 
- Public Member Functions inherited from Wasp::MyBase
 MyBase ()
 
const string & getClassName () const
 

Static Public Member Functions

static ImageWriterCreateImageWriterForFile (const std::string &path)
 
static void RegisterFactory (ImageWriterFactory *factory)
 
- Static Public Member Functions inherited from Wasp::MyBase
static void SetErrMsg (const char *format,...)
 Record a formatted error message.
 
static void SetErrMsg (int errcode, const char *format,...)
 Record a formatted error message and an error code.
 
static const char * GetErrMsg ()
 
static void SetErrCode (int err_code)
 Record an error code.
 
static int GetErrCode ()
 Retrieve the current error code.
 
static void SetErrMsgCB (ErrMsgCB_T cb)
 
static ErrMsgCB_T GetErrMsgCB ()
 
static void SetErrMsgFilePtr (FILE *fp)
 
static const FILE * SetErrMsgFilePtr ()
 
static void SetDiagMsg (const char *format,...)
 Record a formatted diagnostic message.
 
static const char * GetDiagMsg ()
 
static void SetDiagMsgCB (DiagMsgCB_T cb)
 
static DiagMsgCB_T GetDiagMsgCB ()
 
static void SetDiagMsgFilePtr (FILE *fp)
 
static bool EnableErrMsg (bool enable)
 
static bool GetEnableErrMsg ()
 

Protected Member Functions

 ImageWriter (const std::string &path)
 
- Protected Member Functions inherited from Wasp::MyBase
void SetClassName (const string &name)
 

Protected Attributes

Format format
 
std::string path
 
bool opened
 

Additional Inherited Members

- Static Public Attributes inherited from Wasp::MyBase
static char * ErrMsg
 
static int ErrCode
 
static int ErrMsgSize
 
static FILE * ErrMsgFilePtr
 
static ErrMsgCB_T ErrMsgCB
 
static char * DiagMsg
 
static int DiagMsgSize
 
static FILE * DiagMsgFilePtr
 
static DiagMsgCB_T DiagMsgCB
 
static bool Enabled
 

Detailed Description

Interface for image writers.

Author
Stanislaw Jaroszynski

Definition at line 15 of file ImageWriter.h.

Member Enumeration Documentation

◆ Format

enum class VAPoR::ImageWriter::Format
strong
Enumerator
RGB 

Definition at line 17 of file ImageWriter.h.

Constructor & Destructor Documentation

◆ ~ImageWriter()

virtual VAPoR::ImageWriter::~ImageWriter ( )
inlinevirtual

Definition at line 21 of file ImageWriter.h.

◆ ImageWriter()

VAPoR::ImageWriter::ImageWriter ( const std::string &  path)
protected

Member Function Documentation

◆ CreateImageWriterForFile()

static ImageWriter * VAPoR::ImageWriter::CreateImageWriterForFile ( const std::string &  path)
static

◆ RegisterFactory()

static void VAPoR::ImageWriter::RegisterFactory ( ImageWriterFactory factory)
static

◆ Write()

virtual int VAPoR::ImageWriter::Write ( const unsigned char *  buffer,
const unsigned int  width,
const unsigned int  height 
)
pure virtual

Member Data Documentation

◆ format

Format VAPoR::ImageWriter::format
protected

Definition at line 27 of file ImageWriter.h.

◆ opened

bool VAPoR::ImageWriter::opened
protected

Definition at line 29 of file ImageWriter.h.

◆ path

std::string VAPoR::ImageWriter::path
protected

Definition at line 28 of file ImageWriter.h.


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