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 | Friends | List of all members
ctkXnatSubject Class Reference

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

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

Public Member Functions

 ctkXnatSubject (ctkXnatObject *parent=0, const QString &schemaType=ctkXnatDefaultSchemaTypes::XSI_SUBJECT)
 
ctkXnatProjectgetPrimaryProject () const
 
QList< ctkXnatProject * > getProjects () const
 
const QString & insertDate () const
 
const QString & insertUser () 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
 
void setInsertDate (const QString &insertDate)
 
void setInsertUser (const QString &insertUser)
 
void setLabel (const QString &label)
 
virtual void setName (const QString &name)
 Sets the name, i.e. the label of the subject. More...
 
virtual ~ctkXnatSubject ()
 
- 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 INSERT_DATE
 
static const QString INSERT_USER
 
- Static Public Attributes inherited from ctkXnatObject
static const QString ID
 
static const QString LABEL
 
static const QString NAME
 

Friends

class qRestResult
 

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 ctkXnatSubject.h.

Constructor & Destructor Documentation

ctkXnatSubject::ctkXnatSubject ( ctkXnatObject parent = 0,
const QString &  schemaType = ctkXnatDefaultSchemaTypes::XSI_SUBJECT 
)
virtual ctkXnatSubject::~ctkXnatSubject ( )
virtual

Member Function Documentation

ctkXnatProject* ctkXnatSubject::getPrimaryProject ( ) const
QList<ctkXnatProject*> ctkXnatSubject::getProjects ( ) const
const QString& ctkXnatSubject::insertDate ( ) const
const QString& ctkXnatSubject::insertUser ( ) const
QString ctkXnatSubject::label ( ) const
virtual QString ctkXnatSubject::name ( ) const
virtual

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

Reimplemented from ctkXnatObject.

void ctkXnatSubject::reset ( )
virtual

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

Reimplemented from ctkXnatObject.

virtual QString ctkXnatSubject::resourceUri ( ) const
virtual

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

Implements ctkXnatObject.

void ctkXnatSubject::setInsertDate ( const QString &  insertDate)
Warning
does not overwrite the insert date on the server, since this is read only
void ctkXnatSubject::setInsertUser ( const QString &  insertUser)
Warning
does not overwrite the insert user on the server, since this is read only
void ctkXnatSubject::setLabel ( const QString &  label)
virtual void ctkXnatSubject::setName ( const QString &  name)
virtual

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

Reimplemented from ctkXnatObject.

Friends And Related Function Documentation

friend class qRestResult
friend

Definition at line 75 of file ctkXnatSubject.h.

Member Data Documentation

const QString ctkXnatSubject::INSERT_DATE
static

Definition at line 70 of file ctkXnatSubject.h.

const QString ctkXnatSubject::INSERT_USER
static

Definition at line 71 of file ctkXnatSubject.h.


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