SignConfiguration Class Reference

#include <SignConfiguration.h>

Collaboration diagram for SignConfiguration:

[legend]List of all members.

---

Detailed Description

Handles SIGN configuration options.

This class retrieves SIGN configuration options from the MRML file and stores them in a configuration map to make them accessible for other SIGN classes.

Author:

Arne Hans

Public Member Functions
	SignConfiguration ()
virtual	~SignConfiguration ()
void	BuildSIGNConfigurationFromMRML (SignContext *context)
std::string	GetConfigurationOption (const std::string name)
	If the option is not found, an exception is thrown.
std::string	GetConfigurationOption (const std::string name, const std::string defaultValue)
void	SetConfigurationOption (const std::string name, const std::string value)
	Sets a configuration option to a give value.
RegistrationTransformList *	GetRegistrationTransforms (std::string sink)
	Returns all registration transforms.
CalibrationTransformList *	GetCalibrationTransforms (std::string sink)
	Returns all calibration transforms.
void	AddRegistrationTransform (std::string source, std::string target)
	Adds a registration transform.
ControlLineList *	GetControlLines ()
	Returns all control lines.
CatheterList *	GetCatheters ()
	Returns all catheters.
CatheterViewerList *	Get3DViewersForCatheter (std::string name)
	Returns all 3D viewers for a given catheter.
CatheterViewerList *	Get2DViewersForCatheter (std::string name)
	Returns all 2D viewers for a given catheter.
ProbeList *	GetProbes ()
	Returns all probes.
ProbeViewerList *	Get2DViewersForProbe (std::string name)
	Returns all 2D viewers for a given probe.
void	Add2DViewerForProbe (std::string probe, std::string viewer)
	Adds a 2D viewer for a given probe.
Protected Member Functions
void	BuildConfigurationMap ()

---

Constructor & Destructor Documentation

SignConfiguration::SignConfiguration (   )

SignConfiguration::~SignConfiguration (   )  [virtual]

---

Member Function Documentation

void SignConfiguration::Add2DViewerForProbe (  std::string  probe, std::string  viewer )

Adds a 2D viewer for a given probe.

void SignConfiguration::AddRegistrationTransform (  std::string  source, std::string  target )

Adds a registration transform.

void SignConfiguration::BuildConfigurationMap (   )  [protected]

void SignConfiguration::BuildSIGNConfigurationFromMRML (  SignContext *  context  )

Builds a configuration map from the MRML file that is associated with a given context Parameters: context  SIGN context

CatheterViewerList * SignConfiguration::Get2DViewersForCatheter (  std::string  name  )

Returns all 2D viewers for a given catheter.

ProbeViewerList * SignConfiguration::Get2DViewersForProbe (  std::string  name  )

Returns all 2D viewers for a given probe.

CatheterViewerList * SignConfiguration::Get3DViewersForCatheter (  std::string  name  )

Returns all 3D viewers for a given catheter.

CalibrationTransformList * SignConfiguration::GetCalibrationTransforms (  std::string  sink  )

Returns all calibration transforms.

CatheterList * SignConfiguration::GetCatheters (   )

Returns all catheters.

string SignConfiguration::GetConfigurationOption (  const std::string  name, const std::string  defaultValue )

Returns the value of a configuration option. If the option is not found, the default value is returned.

string SignConfiguration::GetConfigurationOption (  const std::string  name  )

If the option is not found, an exception is thrown. Returns the value of a configuration option.

ControlLineList * SignConfiguration::GetControlLines (   )

Returns all control lines.

ProbeList * SignConfiguration::GetProbes (   )

Returns all probes.

RegistrationTransformList * SignConfiguration::GetRegistrationTransforms (  std::string  sink  )

Returns all registration transforms.

void SignConfiguration::SetConfigurationOption (  const std::string  name, const std::string  value )

Sets a configuration option to a give value.

---

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

• utils/SignConfiguration.h
• utils/SignConfiguration.cxx

---