VTK  9.3.20240721
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkUTF16TextCodec Class Reference

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

#include <vtkUTF16TextCodec.h>

Inheritance diagram for vtkUTF16TextCodec:
[legend]
Collaboration diagram for vtkUTF16TextCodec:
[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.
 
vtkUTF16TextCodecNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 The name this codec goes by - should match the string the factory will take to create it.
 
void SetBigEndian (bool)
 Set the endianness - true if Big false is little.
 
void FindEndianness (istream &InputStream)
 Set the endianness - true if Big false is little.
 
void ToUnicode (istream &InputStream, vtkTextCodec::OutputIterator &output) override
 Iterate through the sequence represented by the begin and end iterators assigning the result to the output iterator.
 
vtkTypeUInt32 NextUTF32CodePoint (istream &inputStream) override
 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.
 
const char * Name () override
 The name this codec goes by - should match the string the factory will take to create it.
 
bool CanHandle (const char *NameString) override
 The name this codec goes by - should match the string the factory will take to create it.
 
- Public Member Functions inherited from vtkTextCodec
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkTextCodecNewInstance () const
 
virtual bool CanHandle (const char *NameString)
 
virtual bool IsValid (istream &InputStream)
 is the given sample valid for this codec? The stream will not be advanced.
 
virtual void ToUnicode (istream &inputStream, vtkTextCodec::OutputIterator &output)
 Iterate through the sequence represented by the stream assigning the result to the output iterator.
 
std::string ToString (istream &inputStream)
 Convenience method to take data from the stream and put it into a string.
 
virtual vtkTypeUInt32 NextUTF32CodePoint (istream &inputStream)=0
 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.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUTF16TextCodecSafeDownCast (vtkObjectBase *o)
 
static vtkUTF16TextCodecNew ()
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkUTF16TextCodec ()
 
 ~vtkUTF16TextCodec () override
 
- Protected Member Functions inherited from vtkTextCodec
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

bool _endianExplicitlySet
 
bool _bigEndian
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkUTF16TextCodec.h.

Constructor & Destructor Documentation

◆ vtkUTF16TextCodec()

vtkUTF16TextCodec::vtkUTF16TextCodec ( )
protected

◆ ~vtkUTF16TextCodec()

vtkUTF16TextCodec::~vtkUTF16TextCodec ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkUTF16TextCodec::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTextCodec.

◆ NewInstance()

vtkUTF16TextCodec * vtkUTF16TextCodec::NewInstance ( ) const

◆ New()

static vtkUTF16TextCodec * vtkUTF16TextCodec::New ( )
static

◆ PrintSelf()

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

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

Reimplemented from vtkTextCodec.

◆ Name()

const char * vtkUTF16TextCodec::Name ( )
overridevirtual

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

Reimplemented from vtkTextCodec.

◆ CanHandle()

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

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

Reimplemented from vtkTextCodec.

◆ SetBigEndian()

void vtkUTF16TextCodec::SetBigEndian ( bool  )

Set the endianness - true if Big false is little.

◆ FindEndianness()

void vtkUTF16TextCodec::FindEndianness ( istream &  InputStream)

Set the endianness - true if Big false is little.

◆ ToUnicode()

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

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

Reimplemented from vtkTextCodec.

◆ NextUTF32CodePoint()

vtkTypeUInt32 vtkUTF16TextCodec::NextUTF32CodePoint ( istream &  inputStream)
overridevirtual

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

◆ _endianExplicitlySet

bool vtkUTF16TextCodec::_endianExplicitlySet
protected

Definition at line 69 of file vtkUTF16TextCodec.h.

◆ _bigEndian

bool vtkUTF16TextCodec::_bigEndian
protected

Definition at line 70 of file vtkUTF16TextCodec.h.


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