Slicer  5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkURIHandler Class Reference

#include <Libs/MRML/Core/vtkURIHandler.h>

Inheritance diagram for vtkURIHandler:
Inheritance graph
[legend]
Collaboration diagram for vtkURIHandler:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

size_t BufferedWrite (char *buffer, size_t size, size_t nitems)
 
This function writes the downloaded data in a buffered manner More...
 
virtual int CanHandleURI (const char *vtkNotUsed(uri))
 need something that goes the other way too... More...
 
virtual const char * GetClassName ()
 
virtual char * GetHostName ()
 
virtual char * GetName ()
 
virtual vtkPermissionPrompterGetPermissionPrompter ()
 
virtual char * GetPrefix ()
 
virtual int GetRequiresPermission ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
int ProgressCallback (FILE *outputFile, double dltotal, double dlnow, double ultotal, double ulnow)
 
This function gives us some feedback on how our download is going. More...
 
virtual void SetHostName (const char *)
 
virtual void SetLocalFile (FILE *localFile)
 
Use this function to set LocalFile More...
 
virtual void SetName (const char *)
 
virtual void SetPermissionPrompter (vtkPermissionPrompter *prompter)
 
virtual void SetPrefix (const char *)
 
virtual void SetRequiresPermission (int)
 
virtual void StageFileRead (const char *source, const char *destination)
 
virtual void StageFileRead (const char *source, const char *destination, const char *username, const char *password, const char *hostname)
 
various Read/Write method footprints useful to redefine in specific handlers. More...
 
virtual void StageFileWrite (const char *source, const char *destination)
 
virtual void StageFileWrite (const char *source, const char *username, const char *password, const char *hostname, const char *sessionID)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkURIHandlerNew ()
 The Usual vtk class functions. More...
 
static vtkURIHandlerSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkURIHandler &)
 
 vtkURIHandler ()
 
 vtkURIHandler (const vtkURIHandler &)
 
 ~vtkURIHandler () override
 

Protected Attributes

char * HostName
 
FILE * LocalFile
 
local file, it gets passed to C functions in libcurl More...
 
char * Name
 
char * Prefix
 

Detailed Description

Definition at line 11 of file vtkURIHandler.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkURIHandler::Superclass

Definition at line 17 of file vtkURIHandler.h.

Constructor & Destructor Documentation

◆ vtkURIHandler() [1/2]

vtkURIHandler::vtkURIHandler ( )
protected

◆ ~vtkURIHandler()

vtkURIHandler::~vtkURIHandler ( )
overrideprotected

◆ vtkURIHandler() [2/2]

vtkURIHandler::vtkURIHandler ( const vtkURIHandler )
protected

Member Function Documentation

◆ BufferedWrite()

size_t vtkURIHandler::BufferedWrite ( char *  buffer,
size_t  size,
size_t  nitems 
)


This function writes the downloaded data in a buffered manner

◆ CanHandleURI()

virtual int vtkURIHandler::CanHandleURI ( const char *  vtkNotUseduri)
inlinevirtual

need something that goes the other way too...

Determine whether protocol is appropriate for this handler. NOTE: Subclasses should implement this method

Definition at line 48 of file vtkURIHandler.h.

◆ GetClassName()

virtual const char* vtkURIHandler::GetClassName ( )
virtual

Reimplemented in vtkHTTPHandler.

◆ GetHostName()

virtual char* vtkURIHandler::GetHostName ( )
virtual

◆ GetName()

virtual char* vtkURIHandler::GetName ( )
virtual

◆ GetPermissionPrompter()

virtual vtkPermissionPrompter* vtkURIHandler::GetPermissionPrompter ( )
virtual

◆ GetPrefix()

virtual char* vtkURIHandler::GetPrefix ( )
virtual

◆ GetRequiresPermission()

virtual int vtkURIHandler::GetRequiresPermission ( )
virtual

◆ IsA()

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

Reimplemented in vtkHTTPHandler.

◆ IsTypeOf()

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

◆ New()

static vtkURIHandler* vtkURIHandler::New ( )
static

The Usual vtk class functions.

◆ operator=()

void vtkURIHandler::operator= ( const vtkURIHandler )
protected

◆ PrintSelf()

void vtkURIHandler::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ProgressCallback()

int vtkURIHandler::ProgressCallback ( FILE *  outputFile,
double  dltotal,
double  dlnow,
double  ultotal,
double  ulnow 
)


This function gives us some feedback on how our download is going.

◆ SafeDownCast()

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

◆ SetHostName()

virtual void vtkURIHandler::SetHostName ( const char *  )
virtual

◆ SetLocalFile()

virtual void vtkURIHandler::SetLocalFile ( FILE *  localFile)
virtual


Use this function to set LocalFile

◆ SetName()

virtual void vtkURIHandler::SetName ( const char *  )
virtual

◆ SetPermissionPrompter()

virtual void vtkURIHandler::SetPermissionPrompter ( vtkPermissionPrompter prompter)
virtual

◆ SetPrefix()

virtual void vtkURIHandler::SetPrefix ( const char *  )
virtual

◆ SetRequiresPermission()

virtual void vtkURIHandler::SetRequiresPermission ( int  )
virtual

◆ StageFileRead() [1/2]

virtual void vtkURIHandler::StageFileRead ( const char *  source,
const char *  destination 
)
virtual

virtual methods to be defined in subclasses. (Maybe these should be defined to handle default file operations)

Reimplemented in vtkHTTPHandler.

◆ StageFileRead() [2/2]

virtual void vtkURIHandler::StageFileRead ( const char *  source,
const char *  destination,
const char *  username,
const char *  password,
const char *  hostname 
)
virtual


various Read/Write method footprints useful to redefine in specific handlers.

◆ StageFileWrite() [1/2]

virtual void vtkURIHandler::StageFileWrite ( const char *  source,
const char *  destination 
)
virtual

Reimplemented in vtkHTTPHandler.

◆ StageFileWrite() [2/2]

virtual void vtkURIHandler::StageFileWrite ( const char *  source,
const char *  username,
const char *  password,
const char *  hostname,
const char *  sessionID 
)
virtual

Member Data Documentation

◆ HostName

char* vtkURIHandler::HostName
protected

Definition at line 98 of file vtkURIHandler.h.

◆ LocalFile

FILE* vtkURIHandler::LocalFile
protected


local file, it gets passed to C functions in libcurl

Definition at line 95 of file vtkURIHandler.h.

◆ Name

char* vtkURIHandler::Name
protected

Definition at line 97 of file vtkURIHandler.h.

◆ Prefix

char* vtkURIHandler::Prefix
protected

Definition at line 96 of file vtkURIHandler.h.


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