server side object used to check if manipulate a directory More...

#include <vtkPVFilePathEncodingHelper.h>

Inheritance diagram for vtkPVFilePathEncodingHelper:

Collaboration diagram for vtkPVFilePathEncodingHelper:

[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

bool	MakeDirectory ()
	Create a directory named Path. More...

bool	DeleteDirectory ()
	Delete a directory named Path. More...

bool	OpenDirectory ()
	Open a directory named Path. More...

bool	RenameDirectory ()
	Rename a directory named Path to SecondaryPath. More...

bool	IsDirectory ()
	Check is directory named Path exists. More...

bool	GetActiveFileIsReadable ()
	Returns if this->Path is a readable file. More...


virtual void	SetPath (const char *)
	Get/Set the path that will be used by the helper. More...

virtual char *	GetPath ()
	Get/Set the path that will be used by the helper. More...


virtual void	SetSecondaryPath (const char *)
	Get/Set the secondary path that will potentially be used by the helper. More...

virtual char *	GetSecondaryPath ()
	Get/Set the secondary path that will potentially be used by the helper. More...


virtual int	GetActiveGlobalId ()
	Get/Set the globalId of the vtkDirectory present of the server that we will use to manipulate directories. More...

virtual void	SetActiveGlobalId (int)
	Get/Set the globalId of the vtkDirectory present of the server that we will use to manipulate directories. 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 vtkPVFilePathEncodingHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkPVFilePathEncodingHelper *	SafeDownCast (vtkObject *o)

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
	vtkPVFilePathEncodingHelper ()

	~vtkPVFilePathEncodingHelper () override

bool	CallObjectMethod (const char *method, bool ignoreError=false)

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 &)

Protected Attributes
char *	Path

char *	SecondaryPath

int	ActiveGlobalId

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

server side object used to check if manipulate a directory

Server side object to list, create and remove directory the main reason for this helper to exist is to convert the file path from utf8 to locale encoding

Definition at line 18 of file vtkPVFilePathEncodingHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVFilePathEncodingHelper::Superclass

Definition at line 22 of file vtkPVFilePathEncodingHelper.h.

Constructor & Destructor Documentation

◆ vtkPVFilePathEncodingHelper()

vtkPVFilePathEncodingHelper::vtkPVFilePathEncodingHelper ( )

protected

◆ ~vtkPVFilePathEncodingHelper()

vtkPVFilePathEncodingHelper::~vtkPVFilePathEncodingHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVFilePathEncodingHelper* vtkPVFilePathEncodingHelper::New ( )

static

◆ GetClassName()

virtual const char* vtkPVFilePathEncodingHelper::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ SetPath()

virtual void vtkPVFilePathEncodingHelper::SetPath ( const char * )

virtual

Get/Set the path that will be used by the helper.

◆ GetPath()

virtual char* vtkPVFilePathEncodingHelper::GetPath ( )

virtual

Get/Set the path that will be used by the helper.

◆ SetSecondaryPath()

virtual void vtkPVFilePathEncodingHelper::SetSecondaryPath ( const char * )

virtual

Get/Set the secondary path that will potentially be used by the helper.

◆ GetSecondaryPath()

virtual char* vtkPVFilePathEncodingHelper::GetSecondaryPath ( )

virtual

Get/Set the secondary path that will potentially be used by the helper.

◆ GetActiveGlobalId()

virtual int vtkPVFilePathEncodingHelper::GetActiveGlobalId ( )

virtual

Get/Set the globalId of the vtkDirectory present of the server that we will use to manipulate directories.

◆ SetActiveGlobalId()

virtual void vtkPVFilePathEncodingHelper::SetActiveGlobalId ( int )

virtual

Get/Set the globalId of the vtkDirectory present of the server that we will use to manipulate directories.

◆ MakeDirectory()

bool vtkPVFilePathEncodingHelper::MakeDirectory ( )

Create a directory named Path.

◆ DeleteDirectory()

bool vtkPVFilePathEncodingHelper::DeleteDirectory ( )

Delete a directory named Path.

◆ OpenDirectory()

bool vtkPVFilePathEncodingHelper::OpenDirectory ( )

Open a directory named Path.

◆ RenameDirectory()

bool vtkPVFilePathEncodingHelper::RenameDirectory ( )

Rename a directory named Path to SecondaryPath.

◆ IsDirectory()

bool vtkPVFilePathEncodingHelper::IsDirectory ( )

Check is directory named Path exists.

◆ GetActiveFileIsReadable()

bool vtkPVFilePathEncodingHelper::GetActiveFileIsReadable ( )

Returns if this->Path is a readable file.

◆ CallObjectMethod()

bool vtkPVFilePathEncodingHelper::CallObjectMethod	(	const char *	method,
		bool	ignoreError = `false`
	)

protected

Member Data Documentation

◆ Path

char* vtkPVFilePathEncodingHelper::Path

protected

Definition at line 86 of file vtkPVFilePathEncodingHelper.h.

◆ SecondaryPath

char* vtkPVFilePathEncodingHelper::SecondaryPath

protected

Definition at line 87 of file vtkPVFilePathEncodingHelper.h.

◆ ActiveGlobalId

int vtkPVFilePathEncodingHelper::ActiveGlobalId

protected

Definition at line 88 of file vtkPVFilePathEncodingHelper.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVFilePathEncodingHelper()

◆ ~vtkPVFilePathEncodingHelper()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetPath()

◆ GetPath()

◆ SetSecondaryPath()

◆ GetSecondaryPath()

◆ GetActiveGlobalId()

◆ SetActiveGlobalId()

◆ MakeDirectory()

◆ DeleteDirectory()

◆ OpenDirectory()

◆ RenameDirectory()

◆ IsDirectory()

◆ GetActiveFileIsReadable()

◆ CallObjectMethod()

Member Data Documentation

◆ Path

◆ SecondaryPath

◆ ActiveGlobalId