OpenMS  2.8.0
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
TOPPASResource Class Reference

Represents a data resource for TOPPAS workflows. More...

#include <OpenMS/VISUAL/TOPPASResource.h>

Inheritance diagram for TOPPASResource:
[legend]
Collaboration diagram for TOPPASResource:
[legend]

Public Member Functions

 TOPPASResource (const QString &file)
 Constructor. More...
 
 TOPPASResource (const QUrl &url)
 Constructor from URL. More...
 
 TOPPASResource (const TOPPASResource &rhs)
 Copy constructor. More...
 
 ~TOPPASResource () override
 Destructor. More...
 
TOPPASResourceoperator= (const TOPPASResource &rhs)
 Assignment operator. More...
 
void writeToFile (const QString &file_name)
 Writes this resource to the local file file. More...
 
const QString & getLocalFile () const
 Returns the file name of the local file, or "" if it has not been written yet. More...
 
const QUrl & getURL () const
 Returns the URL of this resource. More...
 
void fromLocalFile (const QString &file)
 Sets the URL of this resource from file. More...
 

Static Public Attributes

static QStringList supported_schemes
 Supported schemes. More...
 

Protected Attributes

QUrl url_
 The URL of this resource. More...
 
QString file_name_
 The name of the local file. More...
 

Detailed Description

Represents a data resource for TOPPAS workflows.

Currently, the only supported type of resource is local files.

Constructor & Destructor Documentation

◆ TOPPASResource() [1/3]

TOPPASResource ( const QString &  file)

Constructor.

◆ TOPPASResource() [2/3]

TOPPASResource ( const QUrl &  url)

Constructor from URL.

◆ TOPPASResource() [3/3]

TOPPASResource ( const TOPPASResource rhs)

Copy constructor.

◆ ~TOPPASResource()

~TOPPASResource ( )
override

Destructor.

Member Function Documentation

◆ fromLocalFile()

void fromLocalFile ( const QString &  file)

Sets the URL of this resource from file.

◆ getLocalFile()

const QString& getLocalFile ( ) const

Returns the file name of the local file, or "" if it has not been written yet.

◆ getURL()

const QUrl& getURL ( ) const

Returns the URL of this resource.

◆ operator=()

TOPPASResource& operator= ( const TOPPASResource rhs)

Assignment operator.

◆ writeToFile()

void writeToFile ( const QString &  file_name)

Writes this resource to the local file file.

Member Data Documentation

◆ file_name_

QString file_name_
protected

The name of the local file.

◆ supported_schemes

QStringList supported_schemes
static

Supported schemes.

◆ url_

QUrl url_
protected

The URL of this resource.