CNCSJPCVilIOStream Class Reference

#include <NCSJPCVilIOStream.h>

List of all members.

---

Detailed Description

Wrapper class that allows you to effectively "convert" a vil_stream to a CNCSJPCIOStream.

This class is used by vil_j2k_image to read JPEG 2000 imagery. A couple of notes: 1) This stream's home position (ie. the place it goes when you call Seek(0,START), is the current position of the stream that is passed to Open() at the time of that call.

See also:

Open() for more info.

Known Issues: 1) As of 2/24/05, the writing capability of this class has not been tested. In theory it should work just fine though.

Definition at line 24 of file NCSJPCVilIOStream.h.

Public Member Functions
	CNCSJPCVilIOStream ()
virtual CNCSError	Open (vil_stream *stream)
	Pass me the stream you want me to wrap.
virtual CNCSError	Close ()
virtual bool NCS_FASTCALL	Seek ()
virtual bool NCS_FASTCALL	Seek (INT64 offset, Origin origin=CURRENT)
virtual INT64 NCS_FASTCALL	Tell ()
virtual INT64 NCS_FASTCALL	Size ()
virtual bool NCS_FASTCALL	Read (void *buffer, UINT32 count)
virtual bool NCS_FASTCALL	Write (void *buffer, UINT32 count)
Protected Attributes
vil_stream *	mVilStream
	The stream I get all my data from (and write too).
vil_streampos	mHomePos
	This position is my home position (ie.

---

Constructor & Destructor Documentation

CNCSJPCVilIOStream::CNCSJPCVilIOStream (   )

Definition at line 12 of file NCSJPCVilIOStream.cxx.

---

Member Function Documentation

CNCSError CNCSJPCVilIOStream::Close (   )  [virtual]

Definition at line 28 of file NCSJPCVilIOStream.cxx.

CNCSError CNCSJPCVilIOStream::Open (  vil_stream *  stream  )  [virtual]

Pass me the stream you want me to wrap. stream->tell() at the time of this function call will become my home position. see See also: mHomePos for more details on what that means. Definition at line 17 of file NCSJPCVilIOStream.cxx.

bool NCS_FASTCALL CNCSJPCVilIOStream::Read (  void *  buffer, UINT32  count )  [virtual]

Definition at line 94 of file NCSJPCVilIOStream.cxx.

bool CNCSJPCVilIOStream::Seek (  INT64  offset, Origin  origin = CURRENT )  [virtual]

Definition at line 46 of file NCSJPCVilIOStream.cxx.

bool CNCSJPCVilIOStream::Seek (   )  [virtual]

Definition at line 41 of file NCSJPCVilIOStream.cxx.

INT64 NCS_FASTCALL CNCSJPCVilIOStream::Size (   )  [virtual]

Definition at line 89 of file NCSJPCVilIOStream.cxx.

INT64 NCS_FASTCALL CNCSJPCVilIOStream::Tell (   )  [virtual]

Definition at line 84 of file NCSJPCVilIOStream.cxx.

bool NCS_FASTCALL CNCSJPCVilIOStream::Write (  void *  buffer, UINT32  count )  [virtual]

Definition at line 104 of file NCSJPCVilIOStream.cxx.

---

Member Data Documentation

vil_streampos CNCSJPCVilIOStream::mHomePos [protected]

This position is my home position (ie. mVilStream->tell() when it was passed into me). All Seek()'s with an origin of START will be relative to me. Tell() is the position relative to this position etc. Definition at line 60 of file NCSJPCVilIOStream.h.

vil_stream* CNCSJPCVilIOStream::mVilStream [protected]

The stream I get all my data from (and write too). Definition at line 54 of file NCSJPCVilIOStream.h.

---

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

• core/vil/file_formats/NCSJPCVilIOStream.h
• core/vil/file_formats/NCSJPCVilIOStream.cxx

---