Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

PXXVDecoder Class Reference

#include <PXXVDecoder.h>

Inheritance diagram for PXXVDecoder:

PXXObject TObject PXXNativeDecoder List of all members.

Public Member Functions

 SET_LOGGER ("PXXVDecoder")
virtual ~PXXVDecoder ()
virtual void Initialize ()=0
virtual void Dispose ()=0
virtual Int32b_t ReadBoolean (Bool8b_t &b)=0
virtual Int32b_t ReadByte (Char8b_t &c)=0
virtual Int32b_t SkipBytes (Int32b_t n)=0
virtual Int32b_t ReadShort (Short16b_t &s)=0
virtual Int32b_t ReadInt (Int32b_t &i)=0
virtual Int32b_t ReadFloat (Float32b_t &f)=0
virtual Int32b_t ReadLong (Long64b_t &l)=0
virtual Int32b_t ReadDouble (Double64b_t &d)=0
virtual void ActivateTheDecoder ()
virtual std::string GetDecoderName () const

Static Public Member Functions

static PXXVDecoderPtr GetDecoderPtr ()
static void OnByteSwap ()
static void OffByteSwap ()
static Bool8b_t IsByteSwapOn ()
static void SwitchByteSwap ()

Protected Member Functions

 PXXVDecoder ()

Constructor & Destructor Documentation

virtual PXXVDecoder::~PXXVDecoder (   )  [virtual]
 

Destructor

PXXVDecoder::PXXVDecoder (   )  [protected]
 

protected constructor because it is abstract class

Member Function Documentation

virtual void PXXVDecoder::ActivateTheDecoder (   )  [virtual]
 

It allows alternative choice among user-defined decoders. Only one decoder can be activated simultaneously, so if one of the decoders call the function, others are inactivated immediately.

virtual void PXXVDecoder::Dispose (   )  [pure virtual]
 

Dispose all allocated dynamic memories.

Implemented in PXXNativeDecoder.

virtual std::string PXXVDecoder::GetDecoderName (   )  const [inline, virtual]
 

Return decoder's name.

static PXXVDecoderPtr PXXVDecoder::GetDecoderPtr (   )  [inline, static]
 

Get current decoder

virtual void PXXVDecoder::Initialize (   )  [pure virtual]
 

Initialize a decoder. If you allocate dynamic memory here, you must dispose it at Dispose().

Implemented in PXXNativeDecoder.

static Bool8b_t PXXVDecoder::IsByteSwapOn (   )  [inline, static]
 

static void PXXVDecoder::OffByteSwap (   )  [inline, static]
 

static void PXXVDecoder::OnByteSwap (   )  [inline, static]
 

Byte swap switch. If fIsByteSwapOn_ is true, do byte swap inside the Read functions.

virtual Int32b_t PXXVDecoder::ReadBoolean (  Bool8b_t &  b  )  [pure virtual]
 

Reads boolean(1byte if the JAVA binary is written by java.io.DataOutput interface) and set it to the argument. true if that byte is nonzero, false if that byte is zero.

Returns:
int number of bytes actually read

Implemented in PXXNativeDecoder.

virtual Int32b_t PXXVDecoder::ReadByte (  Char8b_t &  c  )  [pure virtual]
 

Reads one input byte and set it to the argument. The byte is treated as a signed value in the range -128 through 127, inclusive.

Returns:
int number of bytes actually read

Implemented in PXXNativeDecoder.

virtual Int32b_t PXXVDecoder::ReadDouble (  Double64b_t &  d  )  [pure virtual]
 

Reads eight input bytes and set it to the argument.

Returns:
int number of bytes actually read

Implemented in PXXNativeDecoder.

virtual Int32b_t PXXVDecoder::ReadFloat (  Float32b_t &  f  )  [pure virtual]
 

Reads four input bytes and set it to the argument.

Returns:
int number of bytes actually read

Implemented in PXXNativeDecoder.

virtual Int32b_t PXXVDecoder::ReadInt (  Int32b_t &  i  )  [pure virtual]
 

Reads four input bytes and set it to the argument.

Returns:
int number of bytes actually read

Implemented in PXXNativeDecoder.

virtual Int32b_t PXXVDecoder::ReadLong (  Long64b_t &  l  )  [pure virtual]
 

Reads eight input bytes and set it to the argument.

Returns:
int number of bytes actually read

Implemented in PXXNativeDecoder.

virtual Int32b_t PXXVDecoder::ReadShort (  Short16b_t &  s  )  [pure virtual]
 

Reads two input bytes and set it to the argument.

Returns:
int number of bytes actually read

Implemented in PXXNativeDecoder.

PXXVDecoder::SET_LOGGER (  "PXXVDecoder"   ) 
 

virtual Int32b_t PXXVDecoder::SkipBytes (  Int32b_t  n  )  [pure virtual]
 

Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes. However, it may skip over some smaller number of bytes, possibly zero. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. Number of bytes skipped is returned.

Parameters:
n the number of bytes to be skipped.
Returns:
the number of bytes actually skipped.

Implemented in PXXNativeDecoder.

static void PXXVDecoder::SwitchByteSwap (   )  [inline, static]
 

Switch fIsByteSwapOn_ flag to opposite value.

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

Generated on Thu Nov 10 14:06:37 2005 by doxygen version 1.4.1