OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Member Functions | List of all members
ossimCodecBase Class Referenceabstract

#include <ossimCodecBase.h>

Inheritance diagram for ossimCodecBase:
ossimObject ossimPropertyInterface ossimReferenced ossimJpegCodec ossimKakaduJ2kCodec ossimPngCodec

Public Member Functions

virtual ossimString getCodecType () const =0
 Will return the identifier used to identify the codec type. More...
 
virtual bool encode (const ossimRefPtr< ossimImageData > &in, std::vector< ossim_uint8 > &out) const =0
 Encode method. More...
 
virtual bool decode (const std::vector< ossim_uint8 > &in, ossimRefPtr< ossimImageData > &out) const =0
 Decode method. More...
 
virtual const std::string & getExtension () const =0
 
- Public Member Functions inherited from ossimObject
 ossimObject ()
 
virtual ~ossimObject ()
 
virtual ossimObjectdup () const
 
virtual ossimString getShortName () const
 
virtual ossimString getLongName () const
 
virtual ossimString getDescription () const
 
virtual ossimString getClassName () const
 
virtual RTTItypeid getType () const
 
virtual bool canCastTo (ossimObject *obj) const
 
virtual bool canCastTo (const RTTItypeid &id) const
 
virtual bool canCastTo (const ossimString &parentClassName) const
 
virtual bool saveState (ossimKeywordlist &kwl, const char *prefix=0) const
 
virtual bool loadState (const ossimKeywordlist &kwl, const char *prefix=0)
 
virtual std::ostream & print (std::ostream &out) const
 Generic print method. More...
 
virtual bool isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
 
virtual void accept (ossimVisitor &visitor)
 
- Public Member Functions inherited from ossimReferenced
 ossimReferenced ()
 
 ossimReferenced (const ossimReferenced &)
 
ossimReferencedoperator= (const ossimReferenced &)
 
void ref () const
 increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
void unref () const
 decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
 
void unref_nodelete () const
 decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
 
int referenceCount () const
 
- Public Member Functions inherited from ossimPropertyInterface
 ossimPropertyInterface ()
 
virtual ~ossimPropertyInterface ()
 
virtual void setProperty (const ossimString &name, const ossimString &value)
 
virtual void setProperty (ossimRefPtr< ossimProperty > property)
 
virtual ossimRefPtr< ossimPropertygetProperty (const ossimString &name) const
 
virtual ossimString getPropertyValueAsString (const ossimString &name) const
 
virtual void getPropertyNames (std::vector< ossimString > &propertyNames) const
 
void getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const
 
void setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)
 

Additional Inherited Members

- Protected Member Functions inherited from ossimReferenced
virtual ~ossimReferenced ()
 

Detailed Description

Definition at line 17 of file ossimCodecBase.h.

Member Function Documentation

◆ decode()

virtual bool ossimCodecBase::decode ( const std::vector< ossim_uint8 > &  in,
ossimRefPtr< ossimImageData > &  out 
) const
pure virtual

Decode method.

Parameters
inInput data to decode.
outOutput tile. If the pointer to ossimImageData is null internally it will be created. For code loops it is better to pre initialized to correct size.
Note
Caller should set "out's" image rectangle upon successful decode.
Returns
true on success, false on failure.

Implemented in ossimJpegCodec, ossimKakaduJ2kCodec, and ossimPngCodec.

◆ encode()

virtual bool ossimCodecBase::encode ( const ossimRefPtr< ossimImageData > &  in,
std::vector< ossim_uint8 > &  out 
) const
pure virtual

Encode method.

Pure virtual method that encodes the passed in buffer to this codec.

Parameters
inInput data to encode.
outEncoded output data.
Returns
true on success, false on failure.

Implemented in ossimJpegCodec, ossimKakaduJ2kCodec, and ossimPngCodec.

Referenced by ossimGpkgWriter::writeTile().

◆ getCodecType()

virtual ossimString ossimCodecBase::getCodecType ( ) const
pure virtual

Will return the identifier used to identify the codec type.

For example the Jpeg codec will have "jpeg" as the identifier

Returns
Codec identifier

Implemented in ossimJpegCodec, ossimKakaduJ2kCodec, and ossimPngCodec.

◆ getExtension()

virtual const std::string& ossimCodecBase::getExtension ( ) const
pure virtual

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