Computer Assited Medical Intervention Tool Kit  version 3.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
camitk::HistoryItem Class Reference

HistoryItem class describes the entry of an action used in a pipeline, in the history. More...

#include <HistoryItem.h>

Public Member Functions

void addProperty (QByteArray name, QVariant value)
 Add a property of the corresponding action to the history item. More...
 
 HistoryItem ()
 Empty constructor. More...
 
 HistoryItem (QString name)
 Default constructor. More...
 
void setInputComponents (ComponentList inputComponents)
 Set the input components of the history item action. More...
 
void setOutputComponents (ComponentList outputComponents)
 Set the output components of the historu item action. More...
 
virtual ~HistoryItem ()
 Virtual destructor. More...
 

Private Attributes

ComponentList inputComponents
 The input components for this action. More...
 
QString name
 The name of the action in the pipeline. More...
 
ComponentList outputComponents
 The outpu components for this action. More...
 
QMap< QByteArray, QVariant > properties
 The properties stored for this action. More...
 

Detailed Description

HistoryItem class describes the entry of an action used in a pipeline, in the history.

Each history item provides information about the processed action :

In CamiTK, every action is stored in a history. Each history entry is an instance of

The history is stored in the Application class and uses the "construct on first use" idiom/design-pattern (with singletons). It therefore avoids the infamous "static initialization order fiasco", see http://www.parashift.com/c++-faq/ctors.html

Constructor & Destructor Documentation

camitk::HistoryItem::HistoryItem ( )

Empty constructor.

camitk::HistoryItem::HistoryItem ( QString  name)

Default constructor.

Parameters
namename of the action stored in the history
virtual camitk::HistoryItem::~HistoryItem ( )
virtual

Virtual destructor.

Member Function Documentation

void camitk::HistoryItem::addProperty ( QByteArray  name,
QVariant  value 
)

Add a property of the corresponding action to the history item.

Parameters
nameName of the property to addProperty
valueValue of the property to add (no type specified)
void camitk::HistoryItem::setInputComponents ( ComponentList  inputComponents)

Set the input components of the history item action.

Parameters
inputComponentsThe list of input components
void camitk::HistoryItem::setOutputComponents ( ComponentList  outputComponents)

Set the output components of the historu item action.

Parameters
outputComponentsThe list of output components

Member Data Documentation

ComponentList camitk::HistoryItem::inputComponents
private

The input components for this action.

QString camitk::HistoryItem::name
private

The name of the action in the pipeline.

ComponentList camitk::HistoryItem::outputComponents
private

The outpu components for this action.

QMap<QByteArray, QVariant> camitk::HistoryItem::properties
private

The properties stored for this action.


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