mitk::IOVolumeSplitReason Class Reference

#include <mitkIOVolumeSplitReason.h>

Collaboration diagram for mitk::IOVolumeSplitReason:

Public Types
enum class	ReasonType {   Unknown , ValueSplitDifference , ValueSortDistance , ImagePostionMissing ,   OverlappingSlices , GantryTiltDifference , SliceDistanceInconsistency , MissingSlices }
using	Self = IOVolumeSplitReason
using	Pointer = std::shared_ptr< IOVolumeSplitReason >
using	ConstPointer = std::shared_ptr< const IOVolumeSplitReason >

Public Member Functions
void	AddReason (ReasonType type, const std::string &detail="")
void	RemoveReason (ReasonType type)
bool	HasReasons () const
bool	HasReason (ReasonType type) const
std::string	GetReasonDetails (ReasonType type) const
Pointer	ExtendReason (ConstPointer otherReason) const
Pointer	Clone () const

Static Public Member Functions
static nlohmann::json	ToJSON (ConstPointer)
static Pointer	FromJSON (const nlohmann::json &j)
static std::string	TypeToString (ReasonType reasonType)
static IOVolumeSplitReason::ReasonType	StringToType (const std::string &reasonStr)
static Pointer	New ()

Protected Types
using	ReasonMapType = std::map< ReasonType, std::string >

Protected Attributes
ReasonMapType	m_ReasonMap

Detailed Description

Definition at line 25 of file mitkIOVolumeSplitReason.h.

Member Typedef Documentation

ConstPointer

using mitk::IOVolumeSplitReason::ConstPointer = std::shared_ptr<const IOVolumeSplitReason>

Definition at line 30 of file mitkIOVolumeSplitReason.h.

Pointer

using mitk::IOVolumeSplitReason::Pointer = std::shared_ptr<IOVolumeSplitReason>

Definition at line 29 of file mitkIOVolumeSplitReason.h.

ReasonMapType

using mitk::IOVolumeSplitReason::ReasonMapType = std::map<ReasonType, std::string>

protected

Definition at line 75 of file mitkIOVolumeSplitReason.h.

Self

using mitk::IOVolumeSplitReason::Self = IOVolumeSplitReason

Definition at line 28 of file mitkIOVolumeSplitReason.h.

Member Enumeration Documentation

ReasonType

enum mitk::IOVolumeSplitReason::ReasonType

strong

Enumerator
Unknown
ValueSplitDifference
ValueSortDistance
ImagePostionMissing
OverlappingSlices
GantryTiltDifference
SliceDistanceInconsistency
MissingSlices

Definition at line 32 of file mitkIOVolumeSplitReason.h.

Member Function Documentation

AddReason()

void mitk::IOVolumeSplitReason::AddReason	(	ReasonType	type,
		const std::string &	detail = ""
	)

Clone()

Pointer mitk::IOVolumeSplitReason::Clone

(

)

const

ExtendReason()

Pointer mitk::IOVolumeSplitReason::ExtendReason

(

ConstPointer

otherReason

)

const

This methods generates a clone of this instances and extends the clone by the reason types and details provided by another IOVolumeSplitReason instance.

Remarks

If the other instance contains a reason type that is already existing it will be ignored. Therefor only new types and details will be added to the extension.

Precondition

otherReason must point to a valid instance.

Returns

Pointer to the cloned and extended instance.

FromJSON()

static Pointer mitk::IOVolumeSplitReason::FromJSON ( const nlohmann::json &  j )

static

GetReasonDetails()

std::string mitk::IOVolumeSplitReason::GetReasonDetails

(

ReasonType

type

)

const

HasReason()

bool mitk::IOVolumeSplitReason::HasReason

(

ReasonType

type

)

const

HasReasons()

bool mitk::IOVolumeSplitReason::HasReasons

(

)

const

New()

static Pointer mitk::IOVolumeSplitReason::New ( )

static

RemoveReason()

void mitk::IOVolumeSplitReason::RemoveReason

(

ReasonType

type

)

StringToType()

static IOVolumeSplitReason::ReasonType mitk::IOVolumeSplitReason::StringToType ( const std::string &  reasonStr )

static

Referenced by mitk::from_json().

ToJSON()

static nlohmann::json mitk::IOVolumeSplitReason::ToJSON ( ConstPointer  )

static

TypeToString()

static std::string mitk::IOVolumeSplitReason::TypeToString ( ReasonType  reasonType )

static

Referenced by mitk::to_json().

Member Data Documentation

m_ReasonMap

ReasonMapType mitk::IOVolumeSplitReason::m_ReasonMap

protected

Definition at line 76 of file mitkIOVolumeSplitReason.h.

---

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

• mitkIOVolumeSplitReason.h