VivoQuant 6.4.0
Loading...
Searching...
No Matches
IPACSWebDisk Class Reference

Description

Access the WebDisk functionallies of an iPACS.

See also VQ.webDisk() to obtain this object.

Public Member Functions

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

Member Function Documentation

◆ execReport()

string execReport ( string path)

Executes a report on the webdisk.

Parameters
pathThe report template path

◆ get()

bool get ( string src,
string dst )

Downloads a file from the webdisk.

Parameters
srcThe source file (on the webdisk)
dstThe destination file (local)
Returns
True if download succeeded, false otherwise

◆ getPublicLink()

string getPublicLink ( string file)

Gets a public link for a given file.

Parameters
fileThe file to obtain the link from
Returns
The link

◆ lsDir()

Object lsDir ( string path)

Lists the items of a webdisk directory.

Parameters
pathThe 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
pathThe source file
Returns
True if creation succeeded, false otherwise

◆ openInBrowser()

void openInBrowser ( string path)

Opens a link in the default web browser.

Parameters
pathThe file to be opened in the browser

◆ put()

bool put ( string src,
string dst )

Uploads a file to a webdisk.

Parameters
srcThe source file (local)
dstThe 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
pathThe 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
tThe extra timeout value in seconds