CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Member Functions | Static Public Attributes | List of all members
ctkXnatFile Class Reference

#include <Libs/XNAT/Core/ctkXnatFile.h>

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

Public Member Functions

 ctkXnatFile (ctkXnatObject *parent=0, const QString &schemaType=ctkXnatDefaultSchemaTypes::XSI_FILE)
 
QString fileContent () const
 
QString fileFormat () const
 
QString fileTags () const
 
QString localFilePath () const
 
virtual QString name () const
 Gets the name of the object. More...
 
void reset ()
 
virtual QString resourceUri () const
 
void setFileContent (const QString &fileContent)
 
void setFileFormat (const QString &fileFormat)
 
void setFileTags (const QString &fileTags)
 
void setLocalFilePath (const QString &filepath)
 
virtual void setName (const QString &name)
 Sets the name of the object. More...
 
virtual ~ctkXnatFile ()
 
- Public Member Functions inherited from ctkXnatObject
void add (ctkXnatObject *child)
 Adds an object to the children of the current one. More...
 
virtual ctkXnatResourceaddResourceFolder (QString foldername, QString format="", QString content="", QString tags="")
 
virtual QString childDataType () const
 Gets a human readable name of the child object type. More...
 
QList< ctkXnatObject * > children () const
 Gets the children of the object. More...
 
QString description () const
 Gets the description of the object. More...
 
void download (const QString &)
 
void erase ()
 Deletes the object on the XNAT server and removes it from its parent. More...
 
bool exists () const
 Checks if the object exists on the XNAT server. More...
 
void fetch (bool forceFetch=false)
 Fetches the children and the properties of the object. More...
 
virtual QString id () const
 Gets the global ID of the object. More...
 
bool isFetched () const
 Tells if the children and the properties of the objects have been fetched. More...
 
virtual QDateTime lastModifiedTimeOnServer ()
 Gets the last modification time from the server. More...
 
ctkXnatObjectparent () const
 
const QMap< QString, QString > & properties () const
 Gets the properties of the object. More...
 
QString property (const QString &name) const
 Gets the value of the property with the given name. More...
 
void remove (ctkXnatObject *child)
 Removes the object from the children of the current object. More...
 
void save (bool overwrite=true)
 
QString schemaType () const
 
void setDescription (const QString &description)
 Sets the description of the object. More...
 
virtual void setId (const QString &id)
 
void setLastModifiedTime (const QDateTime &lastModifiedTime)
 Sets the last modfication time on the server. More...
 
void setParent (ctkXnatObject *parent)
 Sets the parent of the object in the data hierarchy. More...
 
void setProperty (const QString &name, const QVariant &value)
 Sets the value of the property with the given name. More...
 
virtual ~ctkXnatObject ()
 Destructs the ctkXnatObject. More...
 

Static Public Attributes

static const QString FILE_CONTENT
 
static const QString FILE_FORMAT
 
static const QString FILE_NAME
 
static const QString FILE_TAGS
 
- Static Public Attributes inherited from ctkXnatObject
static const QString ID
 
static const QString LABEL
 
static const QString NAME
 
static const QString URI
 
static const QString XSI_SCHEMA_TYPE
 

Additional Inherited Members

- Protected Member Functions inherited from ctkXnatObject
 ctkXnatObject (const ctkXnatObject &)
 
 ctkXnatObject (ctkXnatObject *parent=0, const QString &schemaType=QString::null)
 Constructs the ctkXnatObject. More...
 
 ctkXnatObject (ctkXnatObjectPrivate &dd, ctkXnatObject *parent=0, const QString &schemaType=QString::null)
 Constructs the ctkXnatObject with the given private part. More...
 
virtual void fetchResources (const QString &path="/resources")
 Fetches the resources of the object. More...
 
ctkXnatSessionsession () const
 
- Protected Attributes inherited from ctkXnatObject
const QScopedPointer< ctkXnatObjectPrivate > d_ptr
 The private implementation part of the object. More...
 

Detailed Description

Definition at line 36 of file ctkXnatFile.h.

Constructor & Destructor Documentation

◆ ctkXnatFile()

ctkXnatFile::ctkXnatFile ( ctkXnatObject parent = 0,
const QString &  schemaType = ctkXnatDefaultSchemaTypes::XSI_FILE 
)

◆ ~ctkXnatFile()

virtual ctkXnatFile::~ctkXnatFile ( )
virtual

Member Function Documentation

◆ fileContent()

QString ctkXnatFile::fileContent ( ) const

◆ fileFormat()

QString ctkXnatFile::fileFormat ( ) const

◆ fileTags()

QString ctkXnatFile::fileTags ( ) const

◆ localFilePath()

QString ctkXnatFile::localFilePath ( ) const

◆ name()

virtual QString ctkXnatFile::name ( ) const
virtual

Gets the name of the object.

Reimplemented from ctkXnatObject.

◆ reset()

void ctkXnatFile::reset ( )
virtual

Resets the object so that its properties and children needs to be fetched again at the next request.

Reimplemented from ctkXnatObject.

◆ resourceUri()

virtual QString ctkXnatFile::resourceUri ( ) const
virtual

Gets the resource URI of the object that can be used to access it through the REST API.

Implements ctkXnatObject.

◆ setFileContent()

void ctkXnatFile::setFileContent ( const QString &  fileContent)

◆ setFileFormat()

void ctkXnatFile::setFileFormat ( const QString &  fileFormat)

◆ setFileTags()

void ctkXnatFile::setFileTags ( const QString &  fileTags)

◆ setLocalFilePath()

void ctkXnatFile::setLocalFilePath ( const QString &  filepath)

◆ setName()

virtual void ctkXnatFile::setName ( const QString &  name)
virtual

Sets the name of the object.

Reimplemented from ctkXnatObject.

Member Data Documentation

◆ FILE_CONTENT

const QString ctkXnatFile::FILE_CONTENT
static

Definition at line 67 of file ctkXnatFile.h.

◆ FILE_FORMAT

const QString ctkXnatFile::FILE_FORMAT
static

Definition at line 66 of file ctkXnatFile.h.

◆ FILE_NAME

const QString ctkXnatFile::FILE_NAME
static

Definition at line 64 of file ctkXnatFile.h.

◆ FILE_TAGS

const QString ctkXnatFile::FILE_TAGS
static

Definition at line 65 of file ctkXnatFile.h.


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