vtkASCIITextCodec Class Reference

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

#include <vtkASCIITextCodec.h>

Inheritance diagram for vtkASCIITextCodec:

Collaboration diagram for vtkASCIITextCodec:

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)
vtkASCIITextCodec *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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)
void	PrintSelf (ostream &os, vtkIndent indent)
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 vtkASCIITextCodec *	SafeDownCast (vtkObjectBase *o)
static vtkASCIITextCodec *	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
	vtkASCIITextCodec ()
	~vtkASCIITextCodec ()
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 &)

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

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

vtkASCIITextCodecFactory

Definition at line 43 of file vtkASCIITextCodec.h.

Member Typedef Documentation

typedef vtkTextCodec vtkASCIITextCodec::Superclass

Definition at line 46 of file vtkASCIITextCodec.h.

Constructor & Destructor Documentation

vtkASCIITextCodec::vtkASCIITextCodec ( )

protected

vtkASCIITextCodec::~vtkASCIITextCodec ( )

protected

Member Function Documentation

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

static

virtual int vtkASCIITextCodec::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 vtkASCIITextCodec* vtkASCIITextCodec::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkASCIITextCodec::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTextCodec.

vtkASCIITextCodec* vtkASCIITextCodec::NewInstance

(

)

const

static vtkASCIITextCodec* vtkASCIITextCodec::New ( )

static

void vtkASCIITextCodec::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.

virtual const char* vtkASCIITextCodec::Name ( )

virtual

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

Reimplemented from vtkTextCodec.

virtual bool vtkASCIITextCodec::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.

virtual bool vtkASCIITextCodec::IsValid ( istream &  InputStream )

virtual

is the given sample valid for this codec?

Reimplemented from vtkTextCodec.

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

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.

Implements vtkTextCodec.

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

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

Implements vtkTextCodec.

---

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

• dox/IO/Core/vtkASCIITextCodec.h