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

Serialize/deserialize vtkSelection to/from xml. More...

#include <vtkSelectionSerializer.h>

Inheritance diagram for vtkSelectionSerializer:
Inheritance graph
[legend]
Collaboration diagram for vtkSelectionSerializer:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
- 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)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSelectionSerializerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSelectionSerializerSafeDownCast (vtkObject *o)
 
static vtkInformationIntegerKeyORIGINAL_SOURCE_ID ()
 ID of the dataset or algorithm that the selection belongs to. More...
 
static void PrintXML (int printData, vtkSelection *selection)
 Serialize the selection tree to a stream as xml. More...
 
static void PrintXML (ostream &os, vtkIndent indent, int printData, vtkSelection *selection)
 Serialize the selection tree to a stream as xml. More...
 
static void Parse (const char *xml, vtkSelection *root)
 Parse an xml string to create a new selection tree. More...
 
static void Parse (const char *xml, unsigned int length, vtkSelection *root)
 Parse an xml string to create a new selection tree. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSelectionSerializer ()
 
 ~vtkSelectionSerializer () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
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

Serialize/deserialize vtkSelection to/from xml.

vtkSelectionSerializer is a helper class that can serialize/deserialize vtkSelection to/from xml. Currently, it supports only a subset of properties: CONTENT_TYPE, SOURCE_ID, PROP_ID, PROCESS_ID, ORIGINAL_SOURCE_ID

See also
vtkSelection

Definition at line 26 of file vtkSelectionSerializer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 30 of file vtkSelectionSerializer.h.

Constructor & Destructor Documentation

◆ vtkSelectionSerializer()

vtkSelectionSerializer::vtkSelectionSerializer ( )
protected

◆ ~vtkSelectionSerializer()

vtkSelectionSerializer::~vtkSelectionSerializer ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSelectionSerializer* vtkSelectionSerializer::New ( )
static

◆ GetClassName()

virtual const char* vtkSelectionSerializer::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkSelectionSerializer::IsA ( const char *  type)
virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkSelectionSerializer* vtkSelectionSerializer::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ PrintXML() [1/2]

static void vtkSelectionSerializer::PrintXML ( int  printData,
vtkSelection selection 
)
static

Serialize the selection tree to a stream as xml.

For now, only keys of type vtkInformationIntegerKey are supported.

◆ PrintXML() [2/2]

static void vtkSelectionSerializer::PrintXML ( ostream &  os,
vtkIndent  indent,
int  printData,
vtkSelection selection 
)
static

Serialize the selection tree to a stream as xml.

For now, only keys of type vtkInformationIntegerKey are supported.

◆ Parse() [1/2]

static void vtkSelectionSerializer::Parse ( const char *  xml,
vtkSelection root 
)
static

Parse an xml string to create a new selection tree.

The string is 0 terminated for the first version of this function, or we specify the length of the string for the second version. Currently, this supports only a subset of properties: CONTENT_TYPE, SOURCE_ID, PROP_ID, PROCESS_ID

◆ Parse() [2/2]

static void vtkSelectionSerializer::Parse ( const char *  xml,
unsigned int  length,
vtkSelection root 
)
static

Parse an xml string to create a new selection tree.

The string is 0 terminated for the first version of this function, or we specify the length of the string for the second version. Currently, this supports only a subset of properties: CONTENT_TYPE, SOURCE_ID, PROP_ID, PROCESS_ID

◆ ORIGINAL_SOURCE_ID()

static vtkInformationIntegerKey* vtkSelectionSerializer::ORIGINAL_SOURCE_ID ( )
static

ID of the dataset or algorithm that the selection belongs to.

What ID means is application specific.


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