IPACSWebDisk Class Reference

Access the WebDisk functionallies of an iPACS. More...

Public Member Functions
Object	lsDir (string path)
	Lists the items of a webdisk directory. More...
bool	put (string src, string dst)
	Uploads a file to a webdisk. More...
bool	mkdir (string path)
	Creates a new directory on a webdisk. More...
bool	rm (string path, bool recursive=false)
	Removes a new directory from a webdisk. More...
bool	get (string src, string dst)
	Downloads a file from the webdisk. More...
string	getPublicLink (string file)
	Gets a public link for a given file. More...
void	setExtraTimeout (int t)
	Sets and extra timeout for upload and download. More...
string	execReport (string path)
	Executes a report on the webdisk. More...
void	openInBrowser (string path)
	Opens a link in the default web browser. More...

Detailed Description

Access the WebDisk functionallies of an iPACS.

See also ScriptMaster::webDisk() to obtain this object.

Member Function Documentation

execReport()

string execReport

(

string

path

)

Executes a report on the webdisk.

Parameters

path	The report template path

get()

bool get	(	string	src,
		string	dst
	)

Downloads a file from the webdisk.

Parameters

src	The source file (on the webdisk)
dst	The destination file (local)

Returns

True if download succeeded, false otherwise

getPublicLink()

string getPublicLink

(

string

file

)

Gets a public link for a given file.

Parameters

file	The file to obtain the link from

Returns

The link

lsDir()

Object lsDir

(

string

path

)

Lists the items of a webdisk directory.

Parameters

path	The directory path

Returns

A list of containing pairs of properties for each file

Note

The properties can be: date, entry, full, gid, icon isidir, isvideo, mode, mtime, name, "nlink, proj_id, size, type, uid, wdname.

mkdir()

bool mkdir

(

string

path

)

Creates a new directory on a webdisk.

Parameters

path	The source file

Returns

True if creation succeeded, false otherwise

openInBrowser()

void openInBrowser

(

string

path

)

Opens a link in the default web browser.

Parameters

path	The file to be opened in the browser

put()

bool put	(	string	src,
		string	dst
	)

Uploads a file to a webdisk.

Parameters

src	The source file (local)
dst	The destination file (on the webdisk)

Returns

True if upload succeeded, false otherwise

rm()

bool rm	(	string	path,
		bool	recursive = false
	)

Removes a new directory from a webdisk.

Parameters

path	The source file
recursive	(optional) Enabled recursive removal

Returns

True if removal succeeded, false otherwise

setExtraTimeout()

void setExtraTimeout ( int  t )

inline

Sets and extra timeout for upload and download.

Parameters

t	The extra timeout value in seconds