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
ctkXnatExperiment Class Reference

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

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

Public Member Functions

 ctkXnatExperiment (ctkXnatObject *parent=0, const QString &schemaType=ctkXnatDefaultSchemaTypes::XSI_EXPERIMENT)
 
QString dateOfAcquisition () const
 
QString imageModality () const
 
QString label () const
 
virtual QString name () const
 Returns the name, i.e. the label of the subject. More...
 
void reset ()
 
virtual QString resourceUri () const
 
QString scannerType () const
 
void setDateOfAcquisition (const QString &dateOfAcquisition)
 
void setImageModality (const QString &imageModality)
 
void setLabel (const QString &label)
 
virtual void setName (const QString &name)
 Sets the name, i.e. the label of the subject. More...
 
void setScannerType (const QString &scannerType)
 
void setTimeOfAcquisition (const QString &timeOfAcquisition)
 
QString timeOfAcquisition () const
 
virtual ~ctkXnatExperiment ()
 
- 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 DATE_OF_ACQUISITION
 
static const QString IMAGE_MODALITY
 
static const QString SCANNER_TYPE
 
static const QString TIME_OF_ACQUISITION
 
- 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 35 of file ctkXnatExperiment.h.

Constructor & Destructor Documentation

◆ ctkXnatExperiment()

ctkXnatExperiment::ctkXnatExperiment ( ctkXnatObject parent = 0,
const QString &  schemaType = ctkXnatDefaultSchemaTypes::XSI_EXPERIMENT 
)

◆ ~ctkXnatExperiment()

virtual ctkXnatExperiment::~ctkXnatExperiment ( )
virtual

Member Function Documentation

◆ dateOfAcquisition()

QString ctkXnatExperiment::dateOfAcquisition ( ) const

◆ imageModality()

QString ctkXnatExperiment::imageModality ( ) const

◆ label()

QString ctkXnatExperiment::label ( ) const

◆ name()

virtual QString ctkXnatExperiment::name ( ) const
virtual

Returns the name, i.e. the label of the subject.

Reimplemented from ctkXnatObject.

◆ reset()

void ctkXnatExperiment::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 ctkXnatExperiment::resourceUri ( ) const
virtual

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

Implements ctkXnatObject.

◆ scannerType()

QString ctkXnatExperiment::scannerType ( ) const

◆ setDateOfAcquisition()

void ctkXnatExperiment::setDateOfAcquisition ( const QString &  dateOfAcquisition)

◆ setImageModality()

void ctkXnatExperiment::setImageModality ( const QString &  imageModality)

◆ setLabel()

void ctkXnatExperiment::setLabel ( const QString &  label)

◆ setName()

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

Sets the name, i.e. the label of the subject.

Reimplemented from ctkXnatObject.

◆ setScannerType()

void ctkXnatExperiment::setScannerType ( const QString &  scannerType)

◆ setTimeOfAcquisition()

void ctkXnatExperiment::setTimeOfAcquisition ( const QString &  timeOfAcquisition)

◆ timeOfAcquisition()

QString ctkXnatExperiment::timeOfAcquisition ( ) const

Member Data Documentation

◆ DATE_OF_ACQUISITION

const QString ctkXnatExperiment::DATE_OF_ACQUISITION
static

Definition at line 68 of file ctkXnatExperiment.h.

◆ IMAGE_MODALITY

const QString ctkXnatExperiment::IMAGE_MODALITY
static

Definition at line 71 of file ctkXnatExperiment.h.

◆ SCANNER_TYPE

const QString ctkXnatExperiment::SCANNER_TYPE
static

Definition at line 70 of file ctkXnatExperiment.h.

◆ TIME_OF_ACQUISITION

const QString ctkXnatExperiment::TIME_OF_ACQUISITION
static

Definition at line 69 of file ctkXnatExperiment.h.


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