ctkXnatScan Class Reference

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

Inheritance diagram for ctkXnatScan:

Collaboration diagram for ctkXnatScan:

Public Member Functions
	ctkXnatScan (ctkXnatObject *parent=0, const QString &schemaType=ctkXnatDefaultSchemaTypes::XSI_SCAN)
QString	quality () const
void	reset ()
virtual QString	resourceUri () const
QString	seriesDescription () const
void	setQuality (const QString &quality)
void	setSeriesDescription (const QString &seriesDescription)
void	setType (const QString &type)
QString	type () const
virtual	~ctkXnatScan ()
Public Member Functions inherited from ctkXnatObject
void	add (ctkXnatObject *child)
	Adds an object to the children of the current one. More...
virtual ctkXnatResource *	addResourceFolder (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...
virtual QString	name () const
	Gets the name of the object. More...
ctkXnatObject *	parent () 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	QUALITY
static const QString	SERIES_DESCRIPTION
static const QString	TYPE
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

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...
ctkXnatSession *	session () const
Protected Attributes inherited from ctkXnatObject
const QScopedPointer< ctkXnatObjectPrivate >	d_ptr
	The private implementation part of the object. More...

Detailed Description

Definition at line 37 of file ctkXnatScan.h.

Constructor & Destructor Documentation

ctkXnatScan()

ctkXnatScan::ctkXnatScan	(	ctkXnatObject *	parent = 0,
		const QString &	schemaType = ctkXnatDefaultSchemaTypes::XSI_SCAN
	)

~ctkXnatScan()

virtual ctkXnatScan::~ctkXnatScan ( )

virtual

Member Function Documentation

quality()

QString ctkXnatScan::quality

(

)

const

reset()

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

virtual

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

Implements ctkXnatObject.

seriesDescription()

QString ctkXnatScan::seriesDescription

(

)

const

setQuality()

void ctkXnatScan::setQuality

(

const QString &

quality

)

setSeriesDescription()

void ctkXnatScan::setSeriesDescription

(

const QString &

seriesDescription

)

setType()

void ctkXnatScan::setType

(

const QString &

type

)

type()

QString ctkXnatScan::type

(

)

const

Friends And Related Function Documentation

qRestResult

friend class qRestResult

friend

Definition at line 65 of file ctkXnatScan.h.

Member Data Documentation

QUALITY

const QString ctkXnatScan::QUALITY

static

Definition at line 59 of file ctkXnatScan.h.

SERIES_DESCRIPTION

const QString ctkXnatScan::SERIES_DESCRIPTION

static

Definition at line 60 of file ctkXnatScan.h.

TYPE

const QString ctkXnatScan::TYPE

static

Definition at line 61 of file ctkXnatScan.h.

---

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

• Libs/XNAT/Core/ctkXnatScan.h