mirtk::Object Class Reference

#include <Object.h>

Inheritance diagram for mirtk::Object:

Collaboration diagram for mirtk::Object:

Public Member Functions
virtual const char *	NameOfClass () const =0
	Get name of class, which this object is an instance of.
virtual ParameterList	Parameter () const
	Get parameter name/value pairs.
bool	Parameter (const ParameterList &)
	Set parameters from name/value pairs.
virtual bool	Set (const char *name, const char *value)
virtual	~Object ()
	Destructor.

Static Public Member Functions
static const char *	NameOfType ()
	Get name of this class type.

Protected Member Functions
template<typename... Args>
void	Throw (ErrorType err, const char *func, Args... args) const

Static Protected Member Functions
template<typename... Args>
static void	ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)

Detailed Description

Base class for all MIRTK object classes

Note

This base class must be a virtual interface without any own data members to not change the type size of subclasses! Derive another intermediate abstract base class from it to add data members shared by a more specific class of objects.

Definition at line 51 of file Object.h.

Member Function Documentation

Set()

bool mirtk::Object::Set ( const char *  name, const char *  value  )

inlinevirtual

Set parameter value from string

Parameters

[in]	name	Parameter name.
[in]	value	Parameter value.

Returns

Whether the named parameter is valid and a valid value was set from the provided string representation of the value.

Reimplemented in mirtk::GenericRegistrationFilter, mirtk::Transformation, mirtk::PointCorrespondence, mirtk::DeformableSurfaceModel, mirtk::MultiLevelTransformation, mirtk::BSplineFreeFormTransformationSV, mirtk::FreeFormTransformation, mirtk::RegistrationEnergy, mirtk::PartialMultiLevelStationaryVelocityTransformation, mirtk::BSplineFreeFormTransformationStatistical, mirtk::BSplineFreeFormTransformationTD, mirtk::BSplineFreeFormTransformation3D, mirtk::LocalOptimizer, mirtk::AffineTransformation, mirtk::Configurable, mirtk::PartialBSplineFreeFormTransformationSV, mirtk::FuzzyCorrespondence, mirtk::EulerMethod, mirtk::LineSearch, mirtk::GradientDescent, mirtk::InexactLineSearch, mirtk::RobustPointMatch, mirtk::ClosestCell, mirtk::ClosestPoint, mirtk::RobustClosestPoint, mirtk::SpectralMatch, mirtk::LimitedMemoryBFGSDescent, mirtk::ConjugateGradientDescent, mirtk::EulerMethodWithDamping, mirtk::EulerMethodWithMomentum, mirtk::BrentLineSearch, mirtk::AdaptiveLineSearch, mirtk::FiducialMatch, mirtk::GradientFieldSimilarity, mirtk::GaussianErrorFunction, mirtk::PeronaMalikErrorFunction, and mirtk::CharbonnierErrorFunction.

Definition at line 133 of file Object.h.

Throw()

template<typename... Args>

void mirtk::Object::Throw ( ErrorType  err, const char *  func, Args...  args  ) const

protected

Raise error in member function

The current implementation prints the error message to STDERR and terminates the program with exit code 1. In future releases, when all library code has been rewritten to use this function, a suitable runtime exception may be thrown instead.

Parameters

[in]	err	Error type. Unused at the moment, but may be used in future releases to throw the appropriate exception type.
[in]	func	Name of member function which is throwing the error (i.e., func).
[in]	args	Error message. The given arguments are converted to strings using the ToString template function. These strings are then concatenated to produce the complete error message.

Definition at line 166 of file Object.h.

ThrowStatic()

template<typename... Args>

void mirtk::Object::ThrowStatic ( ErrorType  err, const char *  cls, const char *  func, Args...  args  )

staticprotected

Raise error in member function

The current implementation prints the error message to STDERR and terminates the program with exit code 1. In future releases, when all library code has been rewritten to use this function, a suitable runtime exception may be thrown instead.

Parameters

[in]	err	Error type. Unused at the moment, but may be used in future releases to throw the appropriate exception type.
[in]	cls	Name of class that defines the member function.
[in]	func	Name of member function which is throwing the error (i.e., func).
[in]	args	Error message. The given arguments are converted to strings using the ToString template function. These strings are then concatenated to produce the complete error message.

Definition at line 156 of file Object.h.

---

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

• Object.h