vtkUTF16TextCodec Class Reference

Class to read/write ascii text. More...

#include <vtkUTF16TextCodec.h>

Inheritance diagram for vtkUTF16TextCodec:

Collaboration diagram for vtkUTF16TextCodec:

Public Types
typedef vtkTextCodec	Superclass
Public Types inherited from vtkTextCodec
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkUTF16TextCodec *	NewInstance () const
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)
Public Member Functions inherited from vtkTextCodec
vtkTextCodec *	NewInstance () const
vtkUnicodeString	ToUnicode (istream &inputStream)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkUTF16TextCodec *	SafeDownCast (vtkObjectBase *o)
static vtkUTF16TextCodec *	New ()
Static Public Member Functions inherited from vtkTextCodec
static int	IsTypeOf (const char *type)
static vtkTextCodec *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkUTF16TextCodec ()
	~vtkUTF16TextCodec ()
Protected Member Functions inherited from vtkTextCodec
	vtkTextCodec ()
	~vtkTextCodec ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
bool	_endianExplicitlySet
bool	_bigEndian
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 43 of file vtkUTF16TextCodec.h.

Member Typedef Documentation

typedef vtkTextCodec vtkUTF16TextCodec::Superclass

Definition at line 46 of file vtkUTF16TextCodec.h.

Constructor & Destructor Documentation

vtkUTF16TextCodec::vtkUTF16TextCodec ( )

protected

vtkUTF16TextCodec::~vtkUTF16TextCodec ( )

protected

Member Function Documentation

static int vtkUTF16TextCodec::IsTypeOf ( const char *  type )

static

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 ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkUTF16TextCodec::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTextCodec.

vtkUTF16TextCodec* vtkUTF16TextCodec::NewInstance

(

)

const

static vtkUTF16TextCodec* vtkUTF16TextCodec::New ( )

static

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 endianness - true if Big false is little

void vtkUTF16TextCodec::FindEndianness

(

istream &

InputStream

)

Set the endianness - true if Big false is little

virtual bool vtkUTF16TextCodec::IsValid ( istream &  InputStream )

virtual

is the given sample valid for this codec? - will take endianness 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

bool vtkUTF16TextCodec::_endianExplicitlySet

protected

Definition at line 85 of file vtkUTF16TextCodec.h.

bool vtkUTF16TextCodec::_bigEndian

protected

Definition at line 86 of file vtkUTF16TextCodec.h.

---

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

• dox/IO/Core/vtkUTF16TextCodec.h