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

vtkOutputStream Class Reference

#include <vtkOutputStream.h>

Inheritance diagram for vtkOutputStream:

Inheritance graph
[legend]
Collaboration diagram for vtkOutputStream:

Collaboration graph
[legend]
List of all members.

Detailed Description

Wraps a binary output stream with a VTK interface.

vtkOutputStream provides a VTK-style interface wrapping around a standard output stream. The access methods are virtual so that subclasses can transparently provide encoding of the output. Data lengths for Write calls refer to the length of the data in memory. The actual length in the stream may differ for subclasses that implement an encoding scheme.

Definition at line 31 of file vtkOutputStream.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual int EndWriting ()
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetStream (ostream *)
virtual ostream * GetStream ()
virtual int StartWriting ()
virtual int Write (const unsigned char *data, unsigned long length)
int Write (const char *data, unsigned long length)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkOutputStreamSafeDownCast (vtkObject *o)
static vtkOutputStreamNew ()

Protected Member Functions

 vtkOutputStream ()
 ~vtkOutputStream ()

Protected Attributes

ostream * Stream


Member Typedef Documentation

typedef vtkObject vtkOutputStream::Superclass
 

Reimplemented from vtkObject.

Reimplemented in vtkBase64OutputStream.

Definition at line 34 of file vtkOutputStream.h.


Constructor & Destructor Documentation

vtkOutputStream::vtkOutputStream  )  [protected]
 

vtkOutputStream::~vtkOutputStream  )  [protected]
 


Member Function Documentation

virtual const char* vtkOutputStream::GetClassName  )  [virtual]
 

Reimplemented from vtkObject.

Reimplemented in vtkBase64OutputStream.

static int vtkOutputStream::IsTypeOf const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkBase64OutputStream.

virtual int vtkOutputStream::IsA const char *  type  )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkBase64OutputStream.

static vtkOutputStream* vtkOutputStream::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkObject.

Reimplemented in vtkBase64OutputStream.

static vtkOutputStream* vtkOutputStream::New  )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

Reimplemented in vtkBase64OutputStream.

void vtkOutputStream::PrintSelf ostream &  os,
vtkIndent  indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkBase64OutputStream.

virtual void vtkOutputStream::SetStream ostream *   )  [virtual]
 

Get/Set the real output stream.

virtual ostream* vtkOutputStream::GetStream  )  [virtual]
 

virtual int vtkOutputStream::StartWriting  )  [virtual]
 

Called after the stream position has been set by the caller, but before any Write calls. The stream position should not be adjusted by the caller until after an EndWriting call.

Reimplemented in vtkBase64OutputStream.

virtual int vtkOutputStream::Write const unsigned char *  data,
unsigned long  length
[virtual]
 

Write output data of the given length.

Reimplemented in vtkBase64OutputStream.

int vtkOutputStream::Write const char *  data,
unsigned long  length
 

Called after the stream position has been set by the caller, but before any Write calls. The stream position should not be adjusted by the caller until after an EndWriting call.

virtual int vtkOutputStream::EndWriting  )  [virtual]
 

Called after all desired calls to Write have been made. After this call, the caller is free to change the position of the stream. Additional writes should not be done until after another call to StartWriting.

Reimplemented in vtkBase64OutputStream.


Member Data Documentation

ostream* vtkOutputStream::Stream [protected]
 

Definition at line 68 of file vtkOutputStream.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:04:57 2008 for VTK by  doxygen 1.4.3-20050530