vtkTextCodec Class Reference

Virtual class to act as an interface for all text codecs. More...

#include <vtkTextCodec.h>

Inheritance diagram for vtkTextCodec:

Collaboration diagram for vtkTextCodec:

Classes
class	OutputIterator

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

Public Member Functions
virtual int	IsA (const char *type)
vtkTextCodec *	NewInstance () const
virtual bool	CanHandle (const char *NameString)
virtual bool	IsValid (istream &InputStream)
vtkUnicodeString	ToUnicode (istream &inputStream)
virtual vtkUnicodeString::value_type	NextUnicode (istream &inputStream)=0
virtual const char *	Name ()
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ToUnicode (istream &InputStream, vtkTextCodec::OutputIterator &output)=0
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 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
	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 &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Virtual class to act as an interface for all text codecs.

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

vtkTextCodecFactory

Definition at line 43 of file vtkTextCodec.h.

Member Typedef Documentation

typedef vtkObject vtkTextCodec::Superclass

Definition at line 46 of file vtkTextCodec.h.

Constructor & Destructor Documentation

vtkTextCodec::vtkTextCodec ( )

protected

vtkTextCodec::~vtkTextCodec ( )

protected

Member Function Documentation

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

static

virtual int vtkTextCodec::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 vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.

static vtkTextCodec* vtkTextCodec::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkTextCodec::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.

vtkTextCodec* vtkTextCodec::NewInstance

(

)

const

virtual const char* vtkTextCodec::Name ( )

virtual

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

Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.

void vtkTextCodec::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 vtkObject.

Reimplemented in vtkUTF16TextCodec, and vtkUTF8TextCodec.

virtual bool vtkTextCodec::CanHandle ( const char *  NameString )

virtual

Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.

virtual bool vtkTextCodec::IsValid ( istream &  InputStream )

virtual

is the given sample valid for this codec? The stream will not be advanced.

Reimplemented in vtkUTF16TextCodec, vtkASCIITextCodec, and vtkUTF8TextCodec.

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

pure virtual

Iterate through the sequence represented by the stream assigning the result to the output iterator. The stream will be advanced to its end so subsequent use would need to reset it.

Implemented in vtkUTF16TextCodec, vtkASCIITextCodec, and vtkUTF8TextCodec.

vtkUnicodeString vtkTextCodec::ToUnicode

(

istream &

inputStream

)

convinience method to take data from the stream and put it into a vtkUnicodeString.

virtual vtkUnicodeString::value_type vtkTextCodec::NextUnicode ( istream &  inputStream )

pure virtual

Return the next code point from the sequence represented by the stream advancing the stream through however many places needed to assemble that code point.

Implemented in vtkUTF16TextCodec, vtkASCIITextCodec, and vtkUTF8TextCodec.

---

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

• dox/IO/Core/vtkTextCodec.h