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

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

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

Public Member Functions

virtual QString childDataType () const
 Gets a human readable name of the child object type. More...
 
 ctkXnatProject (ctkXnatObject *parent=0, const QString &schemaType=ctkXnatDefaultSchemaTypes::XSI_PROJECT)
 
const QString piFirstName () const
 
const QString piLastName () const
 
QString projectDescription () const
 
void reset ()
 
virtual QString resourceUri () const
 
const QString secondaryId () const
 
void setPiFirstName (const QString &piFirstName)
 
void setPiLastName (const QString &piLastName)
 
void setProjectDescription (const QString &description)
 
void setSecondaryId (const QString &secondaryId)
 
virtual ~ctkXnatProject ()
 
- 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="")
 
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...
 
virtual QString name () const
 Gets the name of the object. 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...
 
virtual void setName (const QString &name)
 Sets the name of the object. 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 DESCRIPTION
 
static const QString PI_FIRSTNAME
 
static const QString PI_LASTNAME
 
static const QString SECONDARY_ID
 
- 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 ctkXnatProject.h.

Constructor & Destructor Documentation

◆ ctkXnatProject()

ctkXnatProject::ctkXnatProject ( ctkXnatObject parent = 0,
const QString &  schemaType = ctkXnatDefaultSchemaTypes::XSI_PROJECT 
)

◆ ~ctkXnatProject()

virtual ctkXnatProject::~ctkXnatProject ( )
virtual

Member Function Documentation

◆ childDataType()

virtual QString ctkXnatProject::childDataType ( ) const
virtual

Gets a human readable name of the child object type.

Reimplemented from ctkXnatObject.

◆ piFirstName()

const QString ctkXnatProject::piFirstName ( ) const

◆ piLastName()

const QString ctkXnatProject::piLastName ( ) const

◆ projectDescription()

QString ctkXnatProject::projectDescription ( ) const

◆ reset()

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

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

Implements ctkXnatObject.

◆ secondaryId()

const QString ctkXnatProject::secondaryId ( ) const

◆ setPiFirstName()

void ctkXnatProject::setPiFirstName ( const QString &  piFirstName)

◆ setPiLastName()

void ctkXnatProject::setPiLastName ( const QString &  piLastName)

◆ setProjectDescription()

void ctkXnatProject::setProjectDescription ( const QString &  description)

◆ setSecondaryId()

void ctkXnatProject::setSecondaryId ( const QString &  secondaryId)

Member Data Documentation

◆ DESCRIPTION

const QString ctkXnatProject::DESCRIPTION
static

Definition at line 64 of file ctkXnatProject.h.

◆ PI_FIRSTNAME

const QString ctkXnatProject::PI_FIRSTNAME
static

Definition at line 65 of file ctkXnatProject.h.

◆ PI_LASTNAME

const QString ctkXnatProject::PI_LASTNAME
static

Definition at line 66 of file ctkXnatProject.h.

◆ SECONDARY_ID

const QString ctkXnatProject::SECONDARY_ID
static

Definition at line 63 of file ctkXnatProject.h.


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