Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules 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...
 
QList< HistoryComponentgetInputHistoryComponents ()
 Get the input components of the history item action. More...
 
QString getName ()
 Get the name of the corresponding action in the pipeline. More...
 
QList< HistoryComponentgetOutputHistoryComponents ()
 Get the output components of the history item action. More...
 
 HistoryItem ()
 Empty constructor. More...
 
 HistoryItem (QString name)
 Default constructor. More...
 
void setInputHistoryComponents (QList< HistoryComponent > inputHistoryComponents)
 Set the input components of the history item action. More...
 
void setOutputHistoryComponents (QList< HistoryComponent > outputHistoryComponents)
 Set the output components of the history item action. More...
 
virtual ~HistoryItem ()
 Virtual destructor. More...
 

Private Attributes

QList< HistoryComponentinputHistoryComponents
 The input components for this action. More...
 
QString name
 The name of the action in the pipeline. More...
 
QList< HistoryComponentoutputHistoryComponents
 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.

In CamiTK, every Action are stored in a history, which can be saved as a XML file.
Each history entry is an instance of HistoryItem and provides information about the processed action :

History items are mainly useful for getting back to a previous state by undoing an action or for scripting by storing in a file a pipeline of actions written in Python.
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

See also
HistoryComponent

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).
QList<HistoryComponent> camitk::HistoryItem::getInputHistoryComponents ( )

Get the input components of the history item action.

Returns
The input components required to the corresponding action to work.
QString camitk::HistoryItem::getName ( )

Get the name of the corresponding action in the pipeline.

Returns
the name of the action in the pipeline.
QList<HistoryComponent> camitk::HistoryItem::getOutputHistoryComponents ( )

Get the output components of the history item action.

Returns
The output components that the action has created / modified.
void camitk::HistoryItem::setInputHistoryComponents ( QList< HistoryComponent inputHistoryComponents)

Set the input components of the history item action.

Parameters
inputHistoryComponentsThe list of input HistoryComponent.
void camitk::HistoryItem::setOutputHistoryComponents ( QList< HistoryComponent outputHistoryComponents)

Set the output components of the history item action.

Parameters
outputHistoryComponentsThe list of output HistoryComponent.

Member Data Documentation

QList<HistoryComponent> camitk::HistoryItem::inputHistoryComponents
private

The input components for this action.

QString camitk::HistoryItem::name
private

The name of the action in the pipeline.

QList<HistoryComponent> camitk::HistoryItem::outputHistoryComponents
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: