mitk::NavigationToolStorage Class Reference

An object of this class represents a collection of navigation tools. You may add/delete navigation tools or store/load the whole collection to/from the harddisc by using the class NavigationToolStorageSerializer and NavigationToolStorageDeserializer. More...

#include <mitkNavigationToolStorage.h>

List of all members.

Public Types
typedef NavigationToolStorage	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual const char *	GetClassName () const
bool	AddTool (mitk::NavigationTool::Pointer tool)
	Adds a tool to the storage. Be sure that the tool has a unique identifier which is not already part of this storage.
mitk::NavigationTool::Pointer	GetTool (int number)
mitk::NavigationTool::Pointer	GetTool (std::string identifier)
bool	DeleteTool (int number)
	Deletes a tool from the collection.
int	GetToolCount ()
bool	isEmpty ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	NavigationToolStorage ()
	~NavigationToolStorage ()
Protected Attributes
std::vector < mitk::NavigationTool::Pointer >	m_ToolCollection

---

Detailed Description

An object of this class represents a collection of navigation tools. You may add/delete navigation tools or store/load the whole collection to/from the harddisc by using the class NavigationToolStorageSerializer and NavigationToolStorageDeserializer.

Documentation

Definition at line 38 of file mitkNavigationToolStorage.h.

---

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::NavigationToolStorage::ConstPointer

Definition at line 41 of file mitkNavigationToolStorage.h.

typedef itk::SmartPointer<Self> mitk::NavigationToolStorage::Pointer

Definition at line 41 of file mitkNavigationToolStorage.h.

typedef NavigationToolStorage mitk::NavigationToolStorage::Self

Definition at line 41 of file mitkNavigationToolStorage.h.

typedef itk::Object mitk::NavigationToolStorage::Superclass

Definition at line 41 of file mitkNavigationToolStorage.h.

---

Constructor & Destructor Documentation

mitk::NavigationToolStorage::NavigationToolStorage

(

)

[protected]

Definition at line 20 of file mitkNavigationToolStorage.cpp.

References m_ToolCollection.

  {
  m_ToolCollection = std::vector<mitk::NavigationTool::Pointer>();
  }

mitk::NavigationToolStorage::~NavigationToolStorage

(

)

[protected]

Definition at line 25 of file mitkNavigationToolStorage.cpp.

  {

  }

---

Member Function Documentation

bool mitk::NavigationToolStorage::AddTool

(

mitk::NavigationTool::Pointer

tool )

Adds a tool to the storage. Be sure that the tool has a unique identifier which is not already part of this storage.

Returns:

Returns true if the tool was added to the storage, false if not (false can be returned if the identifier already exists in this storage for example).

Definition at line 38 of file mitkNavigationToolStorage.cpp.

  {
  if (GetTool(tool->GetIdentifier()).IsNotNull()) return false;
  else
    {
    m_ToolCollection.push_back(tool);
    return true;
    }
  }

bool mitk::NavigationToolStorage::DeleteTool

(

int

number )

Deletes a tool from the collection.

Definition at line 30 of file mitkNavigationToolStorage.cpp.

  {
    if ((unsigned int)number > m_ToolCollection.size()) return false;
    std::vector<mitk::NavigationTool::Pointer>::iterator it = m_ToolCollection.begin() + number;
    m_ToolCollection.erase(it);
    return true;
  }

virtual const char* mitk::NavigationToolStorage::GetClassName

(

)

const [virtual]

mitk::NavigationTool::Pointer mitk::NavigationToolStorage::GetTool

(

int

number )

Returns:

Returns the tracking tool at the position "number" in the storage. Returns NULL if there is no tracking tool at this position.

Definition at line 48 of file mitkNavigationToolStorage.cpp.

  {
  return m_ToolCollection.at(number);
  }

mitk::NavigationTool::Pointer mitk::NavigationToolStorage::GetTool

(

std::string

identifier )

Returns:

Returns the tracking tool with the given identifier. Returns NULL if there is no tracking tool with this identifier in the storage.

Definition at line 53 of file mitkNavigationToolStorage.cpp.

  {
  for (int i=0; i<GetToolCount(); i++) if ((GetTool(i)->GetIdentifier())==identifier) return GetTool(i);
  return NULL;
  }

int mitk::NavigationToolStorage::GetToolCount

(

)

Returns:

Returns the number of tools stored in the storage.

Definition at line 59 of file mitkNavigationToolStorage.cpp.

  {
  return m_ToolCollection.size();
  }

bool mitk::NavigationToolStorage::isEmpty

(

)

Returns:

Returns true if the storage is empty, false if not.

Definition at line 64 of file mitkNavigationToolStorage.cpp.

  {
  return m_ToolCollection.empty();
  }

static Pointer mitk::NavigationToolStorage::New

(

)

[static]

Referenced by mitk::NavigationToolStorageDeserializer::Deserialize(), QmitkNavigationToolManagementWidget::QmitkNavigationToolManagementWidget(), mitkNavigationToolStorageTestClass::TestAddAndDelete(), mitkNavigationToolStorageTestClass::TestAddAndDelete100Tools(), mitkNavigationToolStorageTestClass::TestGetTool(), and mitkNavigationToolStorageTestClass::TestInstantiation().

---

Member Data Documentation

std::vector<mitk::NavigationTool::Pointer> mitk::NavigationToolStorage::m_ToolCollection [protected]

Definition at line 87 of file mitkNavigationToolStorage.h.

Referenced by NavigationToolStorage().

---

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

• mitkNavigationToolStorage.h
• mitkNavigationToolStorage.cpp