vtkUTF16TextCodec Class Reference

#include <vtkUTF16TextCodec.h>

Inheritance diagram for vtkUTF16TextCodec:

Inheritance graph
[legend]
Collaboration diagram for vtkUTF16TextCodec:

Collaboration graph
[legend]

List of all members.


Detailed Description

Class to read/write ascii text.

A virtual class interface for codecs that readers/writers can rely on

Thanks:
Thanks to Tim Shed from Sandia National Laboratories for his work on the concepts and to Marcus Hanwell and Jeff Baumes of Kitware for keeping me out of the weeds
See also:
vtkUTF16TextCodecFactory

Definition at line 42 of file vtkUTF16TextCodec.h.


Public Types

typedef vtkTextCodec Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetBigEndian (bool)
void FindEndianness (istream &InputStream)
virtual bool IsValid (istream &InputStream)
virtual
vtkUnicodeString::value_type 
NextUnicode (istream &inputStream)
virtual const char * Name ()
virtual bool CanHandle (const char *NameString)
virtual void ToUnicode (istream &InputStream, vtkTextCodec::OutputIterator &output)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkUTF16TextCodecSafeDownCast (vtkObject *o)
static vtkUTF16TextCodecNew ()

Protected Member Functions

 vtkUTF16TextCodec ()
 ~vtkUTF16TextCodec ()

Protected Attributes

bool _endianExplicitlySet
bool _bigEndian

Member Typedef Documentation

Reimplemented from vtkTextCodec.

Definition at line 45 of file vtkUTF16TextCodec.h.


Constructor & Destructor Documentation

vtkUTF16TextCodec::vtkUTF16TextCodec (  )  [protected]

vtkUTF16TextCodec::~vtkUTF16TextCodec (  )  [protected]


Member Function Documentation

virtual const char* vtkUTF16TextCodec::GetClassName (  )  [virtual]

Reimplemented from vtkTextCodec.

static int vtkUTF16TextCodec::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 vtkTextCodec.

virtual int vtkUTF16TextCodec::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 vtkTextCodec.

static vtkUTF16TextCodec* vtkUTF16TextCodec::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkTextCodec.

static vtkUTF16TextCodec* vtkUTF16TextCodec::New (  )  [static]

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

Reimplemented from vtkObject.

void vtkUTF16TextCodec::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

The name this codec goes by - should match the string the factory will take to create it

Reimplemented from vtkTextCodec.

virtual const char* vtkUTF16TextCodec::Name (  )  [virtual]

The name this codec goes by - should match the string the factory will take to create it

Reimplemented from vtkTextCodec.

virtual bool vtkUTF16TextCodec::CanHandle ( const char *  NameString  )  [virtual]

The name this codec goes by - should match the string the factory will take to create it

Reimplemented from vtkTextCodec.

void vtkUTF16TextCodec::SetBigEndian ( bool   ) 

Set the endianess - true if Big false is little

void vtkUTF16TextCodec::FindEndianness ( istream &  InputStream  ) 

Set the endianess - true if Big false is little

virtual bool vtkUTF16TextCodec::IsValid ( istream &  InputStream  )  [virtual]

is the given sample valid for this codec? - will take endianess into account

Reimplemented from vtkTextCodec.

virtual void vtkUTF16TextCodec::ToUnicode ( istream &  InputStream,
vtkTextCodec::OutputIterator output 
) [virtual]

Iterate through the sequence represented by the begin and end iterators assigning the result to the output iterator. This is the current pattern in vtkDelimitedTextReader

Implements vtkTextCodec.

virtual vtkUnicodeString::value_type vtkUTF16TextCodec::NextUnicode ( istream &  inputStream  )  [virtual]

Return the next code point from the sequence represented by the begin, end iterators advancing begin through however many places needed to assemble that code point

Implements vtkTextCodec.


Member Data Documentation

Definition at line 84 of file vtkUTF16TextCodec.h.

Definition at line 85 of file vtkUTF16TextCodec.h.


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

Generated on Wed Aug 24 12:16:59 2011 for VTK by  doxygen 1.5.6