OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Member Functions | Protected Attributes | List of all members
ossimKakaduJ2kCodec Class Reference

#include <ossimKakaduJ2kCodec.h>

Inheritance diagram for ossimKakaduJ2kCodec:
ossimCodecBase ossimObject ossimPropertyInterface ossimReferenced

Public Member Functions

 ossimKakaduJ2kCodec ()
 
virtual ossimString getCodecType () const
 Will return the identifier used to identify the codec type. More...
 
virtual bool encode (const ossimRefPtr< ossimImageData > &in, std::vector< ossim_uint8 > &out) const
 Encode method. More...
 
virtual bool decode (const std::vector< ossim_uint8 > &in, ossimRefPtr< ossimImageData > &out) const
 Decode method. More...
 
virtual const std::string & getExtension () const
 
virtual bool loadState (const ossimKeywordlist &kwl, const char *prefix=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 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)
 

Protected Attributes

std::string m_extension
 
ossimString m_codecType
 

Additional Inherited Members

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

Detailed Description

Definition at line 5 of file ossimKakaduJ2kCodec.h.

Constructor & Destructor Documentation

◆ ossimKakaduJ2kCodec()

ossimKakaduJ2kCodec::ossimKakaduJ2kCodec ( )

Definition at line 3 of file ossimKakaduJ2kCodec.cpp.

4  : m_extension("jp2"),
5  m_codecType("j2k")
6 {
7 
8 }

Member Function Documentation

◆ decode()

bool ossimKakaduJ2kCodec::decode ( const std::vector< ossim_uint8 > &  in,
ossimRefPtr< ossimImageData > &  out 
) const
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.

Implements ossimCodecBase.

Definition at line 23 of file ossimKakaduJ2kCodec.cpp.

25 {
26  bool result = false;
27 
28  return false;
29 }

◆ encode()

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

Encode method.

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

Implements ossimCodecBase.

Definition at line 15 of file ossimKakaduJ2kCodec.cpp.

17 {
18  bool result = false;
19 
20  return false;
21 }

◆ getCodecType()

ossimString ossimKakaduJ2kCodec::getCodecType ( ) const
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

Implements ossimCodecBase.

Definition at line 10 of file ossimKakaduJ2kCodec.cpp.

References m_codecType.

11 {
12  return m_codecType;
13 }

◆ getExtension()

const std::string & ossimKakaduJ2kCodec::getExtension ( ) const
virtual

Implements ossimCodecBase.

Definition at line 31 of file ossimKakaduJ2kCodec.cpp.

References m_extension.

32 {
33  return m_extension;
34 }

◆ loadState()

bool ossimKakaduJ2kCodec::loadState ( const ossimKeywordlist kwl,
const char *  prefix = 0 
)
virtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 36 of file ossimKakaduJ2kCodec.cpp.

37 {
38  std::cout << "LOADING AND INITIALIZING THE DECOMPRESSOR AND COMPRESSORS\n";
39 }

Member Data Documentation

◆ m_codecType

ossimString ossimKakaduJ2kCodec::m_codecType
protected

Definition at line 54 of file ossimKakaduJ2kCodec.h.

Referenced by getCodecType().

◆ m_extension

std::string ossimKakaduJ2kCodec::m_extension
protected

Definition at line 53 of file ossimKakaduJ2kCodec.h.

Referenced by getExtension().


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