Wraps a binary output stream with a VTK interface. More...
#include <vtkOutputStream.h>
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkOutputStream * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual int | StartWriting () |
| virtual int | Write (void const *data, size_t length) |
| virtual int | EndWriting () |
| virtual void | SetStream (ostream *) |
| virtual ostream * | GetStream () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkOutputStream * | SafeDownCast (vtkObjectBase *o) |
| static vtkOutputStream * | New () |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkOutputStream () | |
| ~vtkOutputStream () | |
| int | WriteStream (const char *data, size_t length) |
Protected Attributes | |
| ostream * | Stream |
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 32 of file vtkOutputStream.h.
Member Typedef Documentation
| typedef vtkObject vtkOutputStream::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkBase64OutputStream.
Definition at line 35 of file vtkOutputStream.h.
Constructor & Destructor Documentation
| vtkOutputStream::vtkOutputStream | ( | ) | [protected] |
| vtkOutputStream::~vtkOutputStream | ( | ) | [protected] |
Member Function Documentation
| static int vtkOutputStream::IsTypeOf | ( | const char * | name | ) | [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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkBase64OutputStream.
| virtual int vtkOutputStream::IsA | ( | const char * | name | ) | [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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkBase64OutputStream.
| static vtkOutputStream* vtkOutputStream::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkBase64OutputStream.
| virtual vtkObjectBase* vtkOutputStream::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkBase64OutputStream.
| vtkOutputStream* vtkOutputStream::NewInstance | ( | ) | const |
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] |
Get/Set the real output stream.
| 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 | ( | void const * | data, |
| size_t | length | ||
| ) | [virtual] |
Write output data of the given length.
Reimplemented in vtkBase64OutputStream.
| 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.
| int vtkOutputStream::WriteStream | ( | const char * | data, |
| size_t | length | ||
| ) | [protected] |
Member Data Documentation
ostream* vtkOutputStream::Stream [protected] |
Definition at line 66 of file vtkOutputStream.h.
The documentation for this class was generated from the following file:
- dox/IO/Core/vtkOutputStream.h
