VTK  9.0.20200604
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSILBuilder Class Reference

helper class to build a SIL i.e. a directed graph used by reader producing composite datasets to describes the relationships among the blocks. More...

#include <vtkSILBuilder.h>

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

Public Types

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...
 
vtkSILBuilderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetSIL (vtkMutableDirectedGraph *)
 Get/Set the graph to populate. More...
 
virtual vtkMutableDirectedGraphGetSIL ()
 
void Initialize ()
 Initializes the data-structures. More...
 
vtkIdType AddVertex (const char *name)
 Add vertex, child-edge or cross-edge to the graph. More...
 
vtkIdType AddChildEdge (vtkIdType parent, vtkIdType child)
 
vtkIdType AddCrossEdge (vtkIdType src, vtkIdType dst)
 
virtual vtkIdType GetRootVertex ()
 Returns the vertex id for the root vertex. 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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkSILBuilderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSILBuilderSafeDownCast (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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSILBuilder ()
 
 ~vtkSILBuilder () 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkStringArrayNamesArray
 
vtkUnsignedCharArrayCrossEdgesArray
 
vtkMutableDirectedGraphSIL
 
vtkIdType RootVertex
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

helper class to build a SIL i.e. a directed graph used by reader producing composite datasets to describes the relationships among the blocks.

vtkSILBuilder is a helper class to build a SIL i.e. a directed graph used by reader producing composite datasets to describes the relationships among the blocks. Refer to http://www.paraview.org/Wiki/Block_Hierarchy_Meta_Data for details.

Definition at line 37 of file vtkSILBuilder.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkSILBuilder.h.

Constructor & Destructor Documentation

◆ vtkSILBuilder()

vtkSILBuilder::vtkSILBuilder ( )
protected

◆ ~vtkSILBuilder()

vtkSILBuilder::~vtkSILBuilder ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSILBuilder* vtkSILBuilder::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkSILBuilder::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSILBuilder::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkSILBuilder* vtkSILBuilder::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetSIL()

void vtkSILBuilder::SetSIL ( vtkMutableDirectedGraph )

Get/Set the graph to populate.

◆ GetSIL()

virtual vtkMutableDirectedGraph* vtkSILBuilder::GetSIL ( )
virtual

◆ Initialize()

void vtkSILBuilder::Initialize ( )

Initializes the data-structures.

◆ AddVertex()

vtkIdType vtkSILBuilder::AddVertex ( const char *  name)

Add vertex, child-edge or cross-edge to the graph.

◆ AddChildEdge()

vtkIdType vtkSILBuilder::AddChildEdge ( vtkIdType  parent,
vtkIdType  child 
)

◆ AddCrossEdge()

vtkIdType vtkSILBuilder::AddCrossEdge ( vtkIdType  src,
vtkIdType  dst 
)

◆ GetRootVertex()

virtual vtkIdType vtkSILBuilder::GetRootVertex ( )
virtual

Returns the vertex id for the root vertex.

Member Data Documentation

◆ NamesArray

vtkStringArray* vtkSILBuilder::NamesArray
protected

Definition at line 77 of file vtkSILBuilder.h.

◆ CrossEdgesArray

vtkUnsignedCharArray* vtkSILBuilder::CrossEdgesArray
protected

Definition at line 78 of file vtkSILBuilder.h.

◆ SIL

vtkMutableDirectedGraph* vtkSILBuilder::SIL
protected

Definition at line 79 of file vtkSILBuilder.h.

◆ RootVertex

vtkIdType vtkSILBuilder::RootVertex
protected

Definition at line 81 of file vtkSILBuilder.h.


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