mitk::DICOMTagPath::NodeInfo Struct Reference

Describes a single node within a DICOMTagPath. More...

#include <mitkDICOMTagPath.h>

Collaboration diagram for mitk::DICOMTagPath::NodeInfo:

Public Types
enum class	NodeType {   Invalid , Element , SequenceSelection , AnySelection ,   AnyElement }
	Defines the type of a path node. More...

Public Member Functions
	NodeInfo ()
	Default constructor, creates an Invalid node. More...
	NodeInfo (const DICOMTag &tag, NodeType type=NodeType::Element, ItemSelectionIndex index=0)
	Construct a node info with specified tag, type, and optional selection index. More...
bool	Matches (const NodeInfo &right) const
	Check whether this node matches another node (respecting wildcards). More...
bool	operator== (const NodeInfo &right) const
	Equality operator; checks strict equality (no wildcard matching). More...

Public Attributes
NodeType	type
	The type of this node. More...
DICOMTag	tag
	The DICOM tag this node refers to. More...
ItemSelectionIndex	selection
	The item selection index (for SequenceSelection nodes). More...

Detailed Description

Describes a single node within a DICOMTagPath.

Definition at line 46 of file mitkDICOMTagPath.h.

Member Enumeration Documentation

NodeType

enum mitk::DICOMTagPath::NodeInfo::NodeType

strong

Defines the type of a path node.

Enumerator
Invalid	Node is non-existent or invalid.
Element	Selects a specific element given the node name.
SequenceSelection	Selects a specific item in a sequence of items and has an item selector ("[n]").
AnySelection	Selects all items of a specific element ("[*]").
AnyElement	Selects any element/item. Node name is wildcarded ("*"); item selection as well implicitly.

Definition at line 49 of file mitkDICOMTagPath.h.

Constructor & Destructor Documentation

NodeInfo() [1/2]

mitk::DICOMTagPath::NodeInfo::NodeInfo

(

)

Default constructor, creates an Invalid node.

NodeInfo() [2/2]

mitk::DICOMTagPath::NodeInfo::NodeInfo	(	const DICOMTag &	tag,
		NodeType	type = NodeType::Element,
		ItemSelectionIndex	index = 0
	)

Construct a node info with specified tag, type, and optional selection index.

Parameters

[in]	tag	The DICOM tag for this node.
[in]	type	The node type (default: Element).
[in]	index	The item selection index (default: 0).

Member Function Documentation

Matches()

bool mitk::DICOMTagPath::NodeInfo::Matches

(

const NodeInfo &

right

)

const

Check whether this node matches another node (respecting wildcards).

Parameters

[in]

right

The node to match against.

Returns

true if this node matches the given node.

operator==()

bool mitk::DICOMTagPath::NodeInfo::operator==

(

const NodeInfo &

right

)

const

Equality operator; checks strict equality (no wildcard matching).

Parameters

[in]

right

The node to compare with.

Returns

true if type, tag, and selection are identical.

Member Data Documentation

selection

ItemSelectionIndex mitk::DICOMTagPath::NodeInfo::selection

The item selection index (for SequenceSelection nodes).

Definition at line 60 of file mitkDICOMTagPath.h.

tag

DICOMTag mitk::DICOMTagPath::NodeInfo::tag

The DICOM tag this node refers to.

Definition at line 59 of file mitkDICOMTagPath.h.

type

NodeType mitk::DICOMTagPath::NodeInfo::type

The type of this node.

Definition at line 58 of file mitkDICOMTagPath.h.

---

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

• mitkDICOMTagPath.h