vtkTextCodec Class Reference
#include <vtkTextCodec.h>
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 42 of file vtkTextCodec.h.
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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 |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkTextCodec * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkTextCodec () | |
| ~vtkTextCodec () | |
Classes | |
| class | OutputIterator |
Member Typedef Documentation
| typedef vtkObject vtkTextCodec::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
Definition at line 45 of file vtkTextCodec.h.
Constructor & Destructor Documentation
| vtkTextCodec::vtkTextCodec | ( | ) | [protected] |
| vtkTextCodec::~vtkTextCodec | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkTextCodec::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
| static int vtkTextCodec::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 vtkObject.
Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
| 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 | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
| 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 vtkASCIITextCodec, 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 vtkASCIITextCodec, vtkUTF16TextCodec, 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 vtkASCIITextCodec, vtkUTF16TextCodec, 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 vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
The documentation for this class was generated from the following file:
- dox/IO/vtkTextCodec.h
