file system utilties More...

#include <vtkSMFileUtilities.h>

Inheritance diagram for vtkSMFileUtilities:

Collaboration diagram for vtkSMFileUtilities:

[legend]

Public Types
typedef vtkSMSessionObject	Superclass

Public Types inherited from vtkSMSessionObject
typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

bool	MakeDirectory (const std::string &name, vtkTypeUInt32 location)
	Make a directory on the specified location. More...

bool	DeleteDirectory (const std::string &name, vtkTypeUInt32 location)
	Delete a directory on the specified location. More...

bool	RenameDirectory (const std::string &name, const std::string &newname, vtkTypeUInt32 location)
	Rename a directory on the specified location. More...

Public Member Functions inherited from vtkSMSessionObject
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual void	SetSession (vtkSMSession *)
	Get/Set the session on wihch this object exists. More...

virtual vtkSMSession *	GetSession ()
	Get/Set the session on wihch this object exists. More...

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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkSMFileUtilities *	New ()

static int	IsTypeOf (const char *type)

static vtkSMFileUtilities *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMFileUtilities ()

	~vtkSMFileUtilities () override

Protected Member Functions inherited from vtkSMSessionObject
	vtkSMSessionObject ()

	~vtkSMSessionObject () override

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () 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 vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	Identifies the session id to which this object is related. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

file system utilties

vtkSMFileUtilities can be used to make various file-system related queries and updates by applications. It is intended to be used instead of the ("misc", "Directory") proxy (or vtkSMDirectoryProxy) since this class can better support MPI and symmetric-MPI mode of operation. It does that as follows:

Any API call that modifies the directory structure only gets called on the root-node, and never on the satellites. This avoids unnecessary overheads encountered by the filesystem to avoid race-conditions on parallel file systems.
In symmetric-MPI mode, since the server-manager level code is called on all ranks including the satellites, this class ensures that while the filesystem updates are only triggered on the root node, the status is correctly shared among all the satellites. Thus the function call will return correct status on all ranks.

Definition at line 31 of file vtkSMFileUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMSessionObject vtkSMFileUtilities::Superclass

Definition at line 35 of file vtkSMFileUtilities.h.

Constructor & Destructor Documentation

◆ vtkSMFileUtilities()

vtkSMFileUtilities::vtkSMFileUtilities ( )

protected

◆ ~vtkSMFileUtilities()

vtkSMFileUtilities::~vtkSMFileUtilities ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMFileUtilities* vtkSMFileUtilities::New ( )

static

◆ GetClassName()

virtual const char* vtkSMFileUtilities::GetClassName ( )

virtual

Reimplemented from vtkSMSessionObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMSessionObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ MakeDirectory()

bool vtkSMFileUtilities::MakeDirectory	(	const std::string &	name,
		vtkTypeUInt32	location
	)

Make a directory on the specified location.

Returns true on success or if the directory already exists.

In symmetric MPI mode, this method must be called on all MPI ranks otherwise it will cause a deadlock.

◆ DeleteDirectory()

bool vtkSMFileUtilities::DeleteDirectory	(	const std::string &	name,
		vtkTypeUInt32	location
	)

Delete a directory on the specified location.

Returns true on success.

In symmetric MPI mode, this method must be called on all MPI ranks otherwise it will cause a deadlock.

◆ RenameDirectory()

bool vtkSMFileUtilities::RenameDirectory	(	const std::string &	name,
		const std::string &	newname,
		vtkTypeUInt32	location
	)

Rename a directory on the specified location.

Returns true on success.

In symmetric MPI mode, this method must be called on all MPI ranks otherwise it will cause a deadlock.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMFileUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMFileUtilities()

◆ ~vtkSMFileUtilities()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ MakeDirectory()

◆ DeleteDirectory()

◆ RenameDirectory()