cmtk::StudyList Class Reference [cmtkIO Library]

#include <cmtkStudyList.h>

Inheritance diagram for cmtk::StudyList:

Collaboration diagram for cmtk::StudyList:

List of all members.

Public Types
typedef StudyList	Self
	This class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer to StudyList.
typedef StudyToStudyToXform	Superclass
	Parent class.
Public Member Functions
	StudyList ()
	Default constructor.
	StudyList (const StudyList &slist)
	Copy constructor.
const Study *	GetStudy (const unsigned int studyIndex) const
	Get constant Study object by index.
Study::SmartPtr	GetStudy (const unsigned int studyIndex)
	Get non-constant Study object by index.
const Study *	FindStudyPath (const char *fileSystemPath) const
	Find constant Study object by file system path.
Study::SmartPtr	FindStudyPath (const char *fileSystemPath, const bool create=false)
	Find non-constant Study object by file system path.
const Study *	FindStudyName (const char *name) const
	Find constant Study object by file system path.
Study::SmartPtr	FindStudyName (const char *name)
	Find non-constant Study object by file system path.
Study::SmartPtr	AddStudy (const char *fileSystemPath)
	Add a new study entry.
void	AddStudy (Study::SmartPtr &study)
	Add an existing study object.
void	AddXform (Study::SmartPtr &fromStudy, Study::SmartPtr &toStudy, AffineXform::SmartPtr &affineXform, WarpXform::SmartPtr &warpXform=WarpXform::SmartPtr::Null)
	Add a coordinate transformation between two studies.
void	AddXform (const char *fromStudyPath, const char *toStudyPath, AffineXform::SmartPtr &affineXform, WarpXform::SmartPtr &warpXform=WarpXform::SmartPtr::Null)
	Add a coordinate transformation between two studies.
void	DeleteStudy (const Study *study)
	Remove and delete given study object.
void	DeleteStudy (const unsigned int studyIndex)
	Remove and delete given study object.

---

Detailed Description

Definition at line 56 of file cmtkStudyList.h.

---

Member Typedef Documentation

typedef StudyList cmtk::StudyList::Self

This class.

Definition at line 62 of file cmtkStudyList.h.

typedef SmartPointer<Self> cmtk::StudyList::SmartPtr

Smart pointer to StudyList.

Definition at line 65 of file cmtkStudyList.h.

typedef StudyToStudyToXform cmtk::StudyList::Superclass

Parent class.

Definition at line 68 of file cmtkStudyList.h.

---

Constructor & Destructor Documentation

cmtk::StudyList::StudyList

(

)

[inline]

Default constructor.

Do nothing really, except be there.

Definition at line 73 of file cmtkStudyList.h.

cmtk::StudyList::StudyList

(

const StudyList &

slist )

[inline]

Copy constructor.

Todo:

Implement copying of transformation links between studies.

Definition at line 78 of file cmtkStudyList.h.

---

Member Function Documentation

void cmtk::StudyList::DeleteStudy

(

const unsigned int

studyIndex )

Remove and delete given study object.

Parameters:

studyIndex

Index of study to delete from the list.

---

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

• libs/IO/cmtkStudyList.h
• libs/IO/cmtkStudyList.cxx