VTK  9.3.20240612
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkExtentSplitter Class Reference

Split an extent across other extents. More...

#include <vtkExtentSplitter.h>

Inheritance diagram for vtkExtentSplitter:
[legend]
Collaboration diagram for vtkExtentSplitter:
[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.
 
vtkExtentSplitterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int ComputeSubExtents ()
 Split the extents currently in the queue among the available sources.
 
int GetNumberOfSubExtents ()
 Get the number of sub-extents into which the original set of extents have been split across the available sources.
 
int GetSubExtentSource (int index)
 Get the id of the source from which the sub-extent associated with the given index should be read.
 
void AddExtentSource (int id, int priority, int x0, int x1, int y0, int y1, int z0, int z1)
 Add/Remove a source providing the given extent.
 
void AddExtentSource (int id, int priority, int *extent)
 Add/Remove a source providing the given extent.
 
void RemoveExtentSource (int id)
 Add/Remove a source providing the given extent.
 
void RemoveAllExtentSources ()
 Add/Remove a source providing the given extent.
 
void AddExtent (int x0, int x1, int y0, int y1, int z0, int z1)
 Add an extent to the queue of extents to be split among the available sources.
 
void AddExtent (int *extent)
 Add an extent to the queue of extents to be split among the available sources.
 
int * GetSubExtent (int index)
 Get the sub-extent associated with the given index.
 
void GetSubExtent (int index, int *extent)
 Get the sub-extent associated with the given index.
 
virtual vtkTypeBool GetPointMode ()
 Get/Set whether "point mode" is on.
 
virtual void SetPointMode (vtkTypeBool)
 Get/Set whether "point mode" is on.
 
virtual void PointModeOn ()
 Get/Set whether "point mode" is on.
 
virtual void PointModeOff ()
 Get/Set whether "point mode" is on.
 
- 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 vtkExtentSplitterSafeDownCast (vtkObjectBase *o)
 
static vtkExtentSplitterNew ()
 
- 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
 
 vtkExtentSplitter ()
 
 ~vtkExtentSplitter () override
 
void SplitExtent (int *extent, int *subextent)
 
int IntersectExtents (const int *extent1, const int *extent2, int *result)
 
int Min (int a, int b)
 
int Max (int a, int b)
 
- 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

vtkExtentSplitterInternals * Internal
 
vtkTypeBool PointMode
 
- 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

Split an extent across other extents.

vtkExtentSplitter splits each input extent into non-overlapping sub-extents that are completely contained within other "source extents". A source extent corresponds to some resource providing an extent. Each source extent has an integer identifier, integer priority, and an extent. The input extents are split into sub-extents according to priority, availability, and amount of overlap of the source extents. This can be used by parallel data readers to read as few piece files as possible.

Definition at line 26 of file vtkExtentSplitter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkExtentSplitter.h.

Constructor & Destructor Documentation

◆ vtkExtentSplitter()

vtkExtentSplitter::vtkExtentSplitter ( )
protected

◆ ~vtkExtentSplitter()

vtkExtentSplitter::~vtkExtentSplitter ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkExtentSplitter::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 vtkExtentSplitter * vtkExtentSplitter::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkExtentSplitter::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkExtentSplitter * vtkExtentSplitter::NewInstance ( ) const

◆ PrintSelf()

void vtkExtentSplitter::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 vtkObjectBase.

◆ New()

static vtkExtentSplitter * vtkExtentSplitter::New ( )
static

◆ AddExtentSource() [1/2]

void vtkExtentSplitter::AddExtentSource ( int  id,
int  priority,
int  x0,
int  x1,
int  y0,
int  y1,
int  z0,
int  z1 
)

Add/Remove a source providing the given extent.

Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.

◆ AddExtentSource() [2/2]

void vtkExtentSplitter::AddExtentSource ( int  id,
int  priority,
int *  extent 
)

Add/Remove a source providing the given extent.

Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.

◆ RemoveExtentSource()

void vtkExtentSplitter::RemoveExtentSource ( int  id)

Add/Remove a source providing the given extent.

Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.

◆ RemoveAllExtentSources()

void vtkExtentSplitter::RemoveAllExtentSources ( )

Add/Remove a source providing the given extent.

Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.

◆ AddExtent() [1/2]

void vtkExtentSplitter::AddExtent ( int  x0,
int  x1,
int  y0,
int  y1,
int  z0,
int  z1 
)

Add an extent to the queue of extents to be split among the available sources.

◆ AddExtent() [2/2]

void vtkExtentSplitter::AddExtent ( int *  extent)

Add an extent to the queue of extents to be split among the available sources.

◆ ComputeSubExtents()

int vtkExtentSplitter::ComputeSubExtents ( )

Split the extents currently in the queue among the available sources.

The queue is empty when this returns. Returns 1 if all extents could be read. Returns 0 if any portion of any extent was not available through any source.

◆ GetNumberOfSubExtents()

int vtkExtentSplitter::GetNumberOfSubExtents ( )

Get the number of sub-extents into which the original set of extents have been split across the available sources.

Valid after a call to ComputeSubExtents.

◆ GetSubExtent() [1/2]

int * vtkExtentSplitter::GetSubExtent ( int  index)

Get the sub-extent associated with the given index.

Use GetSubExtentSource to get the id of the source from which this sub-extent should be read. Valid after a call to ComputeSubExtents.

◆ GetSubExtent() [2/2]

void vtkExtentSplitter::GetSubExtent ( int  index,
int *  extent 
)

Get the sub-extent associated with the given index.

Use GetSubExtentSource to get the id of the source from which this sub-extent should be read. Valid after a call to ComputeSubExtents.

◆ GetSubExtentSource()

int vtkExtentSplitter::GetSubExtentSource ( int  index)

Get the id of the source from which the sub-extent associated with the given index should be read.

Returns -1 if no source provides the sub-extent.

◆ GetPointMode()

virtual vtkTypeBool vtkExtentSplitter::GetPointMode ( )
virtual

Get/Set whether "point mode" is on.

In point mode, sub-extents are generated to ensure every point in the update request is read, but not necessarily every cell. This can be used when point data are stored in a planar slice per piece with no cell data. The default is OFF.

◆ SetPointMode()

virtual void vtkExtentSplitter::SetPointMode ( vtkTypeBool  )
virtual

Get/Set whether "point mode" is on.

In point mode, sub-extents are generated to ensure every point in the update request is read, but not necessarily every cell. This can be used when point data are stored in a planar slice per piece with no cell data. The default is OFF.

◆ PointModeOn()

virtual void vtkExtentSplitter::PointModeOn ( )
virtual

Get/Set whether "point mode" is on.

In point mode, sub-extents are generated to ensure every point in the update request is read, but not necessarily every cell. This can be used when point data are stored in a planar slice per piece with no cell data. The default is OFF.

◆ PointModeOff()

virtual void vtkExtentSplitter::PointModeOff ( )
virtual

Get/Set whether "point mode" is on.

In point mode, sub-extents are generated to ensure every point in the update request is read, but not necessarily every cell. This can be used when point data are stored in a planar slice per piece with no cell data. The default is OFF.

◆ SplitExtent()

void vtkExtentSplitter::SplitExtent ( int *  extent,
int *  subextent 
)
protected

◆ IntersectExtents()

int vtkExtentSplitter::IntersectExtents ( const int *  extent1,
const int *  extent2,
int *  result 
)
protected

◆ Min()

int vtkExtentSplitter::Min ( int  a,
int  b 
)
protected

◆ Max()

int vtkExtentSplitter::Max ( int  a,
int  b 
)
protected

Member Data Documentation

◆ Internal

vtkExtentSplitterInternals* vtkExtentSplitter::Internal
protected

Definition at line 111 of file vtkExtentSplitter.h.

◆ PointMode

vtkTypeBool vtkExtentSplitter::PointMode
protected

Definition at line 116 of file vtkExtentSplitter.h.


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