VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkASCIITextCodec Class Reference

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

#include <vtkASCIITextCodec.h>

Inheritance diagram for vtkASCIITextCodec:
[legend]
Collaboration diagram for vtkASCIITextCodec:
[legend]

Public Types

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

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkASCIITextCodecNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
const char * Name () override
 The name this codec goes by - should match the string the factory will take to create it. More...
 
bool CanHandle (const char *NameString) override
 
bool IsValid (istream &InputStream) override
 is the given sample valid for this codec? More...
 
void ToUnicode (istream &InputStream, vtkTextCodec::OutputIterator &output) override
 Iterate through the sequence represented by the stream assigning the result to the output iterator. More...
 
vtkUnicodeString::value_type NextUnicode (istream &inputStream) override
 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. More...
 
- Public Member Functions inherited from vtkTextCodec
vtkTextCodecNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkUnicodeString ToUnicode (istream &inputStream)
 convenience method to take data from the stream and put it into a vtkUnicodeString. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkASCIITextCodecSafeDownCast (vtkObjectBase *o)
 
static vtkASCIITextCodecNew ()
 
- Static Public Member Functions inherited from vtkTextCodec
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTextCodecSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkASCIITextCodec ()
 
 ~vtkASCIITextCodec () override
 
- Protected Member Functions inherited from vtkTextCodec
 vtkTextCodec ()
 
 ~vtkTextCodec () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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
std::atomic< int32_t > 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

◆ Superclass

Definition at line 46 of file vtkASCIITextCodec.h.

Constructor & Destructor Documentation

◆ vtkASCIITextCodec()

vtkASCIITextCodec::vtkASCIITextCodec ( )
protected

◆ ~vtkASCIITextCodec()

vtkASCIITextCodec::~vtkASCIITextCodec ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkASCIITextCodec::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTextCodec.

◆ NewInstance()

vtkASCIITextCodec* vtkASCIITextCodec::NewInstance ( ) const

◆ New()

static vtkASCIITextCodec* vtkASCIITextCodec::New ( )
static

◆ PrintSelf()

void vtkASCIITextCodec::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ Name()

const char* vtkASCIITextCodec::Name ( )
overridevirtual

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

Reimplemented from vtkTextCodec.

◆ CanHandle()

bool vtkASCIITextCodec::CanHandle ( const char *  NameString)
overridevirtual

Reimplemented from vtkTextCodec.

◆ IsValid()

bool vtkASCIITextCodec::IsValid ( istream &  InputStream)
overridevirtual

is the given sample valid for this codec?

Reimplemented from vtkTextCodec.

◆ ToUnicode()

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

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.

◆ NextUnicode()

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

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: