class for writing geographic images to files or streams
More...
#include <lti_geoFileImageWriter.h>
This abstract class extends LTIImageWriter by adding functions for controlling the output form (either a file or a stream) and world file generation.
- Examples:
- DerivedImageWriter.cpp.
Definition at line 30 of file lti_geoFileImageWriter.h.
§ ~LTIGeoFileImageWriter()
virtual LTIGeoFileImageWriter::~LTIGeoFileImageWriter |
( |
| ) |
|
|
virtual |
§ LTIGeoFileImageWriter()
LTIGeoFileImageWriter::LTIGeoFileImageWriter |
( |
bool |
supportsStreams | ) |
|
|
protected |
Constructs a writer which will write to files or streams. The supportsStreams
parameter is used to indicate whether the derived class can write directly to a stream or only to files.
- Parameters
-
supportsStreams | set to true if output to streams is allowed |
§ deleteOutput()
virtual LT_STATUS LTIGeoFileImageWriter::deleteOutput |
( |
void |
| ) |
|
|
virtual |
This function should delete any output files that were create during the calls to writeBegin() and writeStrip().
This function is called by write(). Derived classes must implement this function.
- Returns
- status code indicating the failure of operation
Implements LTIImageWriter.
Reimplemented in LTIBBBImageWriter.
§ getFileSpec()
LTFileSpec* LTIGeoFileImageWriter::getFileSpec |
( |
| ) |
const |
|
protected |
Returns the name of the file being written to.
If the output target is set by the user to be a stream, the returned filename will be NULL.
- Returns
- the filename (may be NULL)
§ getStream()
Returns the stream being written to.
If the output target is a filename, the returned stream will be NULL until the write() sequence has begun.
- Returns
- the stream (may be NULL)
- Examples:
- DerivedImageWriter.cpp.
§ setOutputFileSpec() [1/2]
Sets the output target to the given filename. Must be called prior to calling write().
- Parameters
-
fileSpec | the name of the file to write to |
- Returns
- status code indicating success or failure
- Examples:
- GeoScene.cpp.
§ setOutputFileSpec() [2/2]
virtual LT_STATUS LTIGeoFileImageWriter::setOutputFileSpec |
( |
const char * |
fileSpec | ) |
|
|
virtual |
Sets the output target to the given filename. Must be called prior to calling write().
- Parameters
-
fileSpec | the name of the file to write to |
- Returns
- success or failure
§ setOutputStream()
Sets the output target to the given stream. Must be called prior to calling write().
This operation will only succeed if the derived class has set the supportsStream
parameter to the LTIGeoFileImageWriter ctor to true.
- Parameters
-
stream | the stream to write to (may not be NULL) |
- Returns
- status code indicating success or failure
§ setWriteWorldFile()
virtual void LTIGeoFileImageWriter::setWriteWorldFile |
( |
bool |
enabled | ) |
|
|
virtual |
Enables or disables automatic generation of a world file. Only applicable when the output target is a filename.
The default is to not generate a world file.
- Parameters
-
enabled | set to true for world file generation |
§ writeBegin()
§ writeEnd()
virtual LT_STATUS LTIGeoFileImageWriter::writeEnd |
( |
void |
| ) |
|
|
virtual |
§ writeStrip()
The documentation for this class was generated from the following file: