ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSessionIterator Class Reference

vtkSessionIterator is used to iterate over sessions in the global ProcessModule. More...

#include <vtkSessionIterator.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void InitTraversal ()
 Begin iterating over the composite dataset structure. More...
 
virtual void GoToNextItem ()
 Move the iterator to the next item in the collection. More...
 
virtual bool IsDoneWithTraversal ()
 Test whether the iterator is finished with the traversal. More...
 
vtkSessionGetCurrentSession ()
 Returns the current session. More...
 
vtkIdType GetCurrentSessionId ()
 Returns the current session id. More...
 

Static Public Member Functions

static vtkSessionIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSessionIteratorSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSessionIterator ()
 
 ~vtkSessionIterator ()
 

Protected Attributes

vtkInternals * Internals
 

Detailed Description

vtkSessionIterator is used to iterate over sessions in the global ProcessModule.

Definition at line 30 of file vtkSessionIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSessionIterator::Superclass

Definition at line 34 of file vtkSessionIterator.h.

Constructor & Destructor Documentation

◆ vtkSessionIterator()

vtkSessionIterator::vtkSessionIterator ( )
protected

◆ ~vtkSessionIterator()

vtkSessionIterator::~vtkSessionIterator ( )
protected

Member Function Documentation

◆ New()

static vtkSessionIterator* vtkSessionIterator::New ( )
static

◆ GetClassName()

virtual const char* vtkSessionIterator::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSessionIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ InitTraversal()

virtual void vtkSessionIterator::InitTraversal ( )
virtual

Begin iterating over the composite dataset structure.

◆ GoToNextItem()

virtual void vtkSessionIterator::GoToNextItem ( )
virtual

Move the iterator to the next item in the collection.

◆ IsDoneWithTraversal()

virtual bool vtkSessionIterator::IsDoneWithTraversal ( )
virtual

Test whether the iterator is finished with the traversal.

Returns 1 for yes, and 0 for no. It is safe to call any of the GetCurrent...() methods only when IsDoneWithTraversal() returns 0.

◆ GetCurrentSession()

vtkSession* vtkSessionIterator::GetCurrentSession ( )

Returns the current session.

◆ GetCurrentSessionId()

vtkIdType vtkSessionIterator::GetCurrentSessionId ( )

Returns the current session id.

Member Data Documentation

◆ Internals

vtkInternals* vtkSessionIterator::Internals
protected

Definition at line 69 of file vtkSessionIterator.h.


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