MeVisLab Toolbox Reference
ml::PrivateDICOMTags::PrivateTagDesc Class Reference

Small helper container to manage private tag information. More...

#include <mlPrivateDICOMTags.h>

Public Types

enum  Completeness { InValid = 0 , Partial , Complete }
 Describes the completeness of the information in the current instance. More...
 

Public Member Functions

 PrivateTagDesc ()
 Default constructor. More...
 
 PrivateTagDesc (const char *argPrivateCreator, const char *argTagName, MLuint16 argGroupId, MLuint16 argElementId, DCMTree::Vr argVr, const char *argVM, const char *argComment, Completeness argCompleteness=Complete)
 Additional convenience constructor for all members which allows better matching for c-string than the previous one. More...
 
 PrivateTagDesc (const char *argPrivateCreator, MLuint16 argGroupId, MLuint16 argElementId, DCMTree::Vr argVr, const char *argVM, const char *argTagName)
 Alternative version for gdcm tags. The first argument is not used any more. More...
 
bool operator== (const PrivateTagDesc &other) const
 Equality. More...
 

Public Attributes

std::string manufacturer
 If available then this contains the company defined this private tag, otherwise empty. More...
 
std::string privateCreator
 Name of the private creator or the private tag group the tag belongs to. More...
 
std::string tagName
 Name of tag as it is defined by the manufacturer as a private one. More...
 
unsigned int groupId
 Identifier of the tag group. More...
 
unsigned int elementId
 Element identifier of tag. More...
 
DCMTree::Vr vr
 Tags value representation. More...
 
std::string vm
 Value multiplicity. More...
 
std::string comment
 If available some manufacturer's comments or descriptions, otherwise empty. More...
 
Completeness completeness
 InValid, Partial, or Complete information available. More...
 

Detailed Description

Small helper container to manage private tag information.

Definition at line 72 of file mlPrivateDICOMTags.h.

Member Enumeration Documentation

◆ Completeness

Describes the completeness of the information in the current instance.

Enumerator
InValid 

The container does not contain valid information.

Partial 

The container contains valid group and manufacturer information, but tagName is unknown.

Complete 

The container contains full information.

Definition at line 75 of file mlPrivateDICOMTags.h.

Constructor & Destructor Documentation

◆ PrivateTagDesc() [1/3]

ml::PrivateDICOMTags::PrivateTagDesc::PrivateTagDesc ( )
inline

Default constructor.

Definition at line 82 of file mlPrivateDICOMTags.h.

◆ PrivateTagDesc() [2/3]

ml::PrivateDICOMTags::PrivateTagDesc::PrivateTagDesc ( const char *  argPrivateCreator,
const char *  argTagName,
MLuint16  argGroupId,
MLuint16  argElementId,
DCMTree::Vr  argVr,
const char *  argVM,
const char *  argComment,
Completeness  argCompleteness = Complete 
)
inline

Additional convenience constructor for all members which allows better matching for c-string than the previous one.

It reduces compile time and generated code significantly for large tables used internally.

Definition at line 98 of file mlPrivateDICOMTags.h.

◆ PrivateTagDesc() [3/3]

ml::PrivateDICOMTags::PrivateTagDesc::PrivateTagDesc ( const char *  argPrivateCreator,
MLuint16  argGroupId,
MLuint16  argElementId,
DCMTree::Vr  argVr,
const char *  argVM,
const char *  argTagName 
)
inline

Alternative version for gdcm tags. The first argument is not used any more.

Definition at line 119 of file mlPrivateDICOMTags.h.

Member Function Documentation

◆ operator==()

bool ml::PrivateDICOMTags::PrivateTagDesc::operator== ( const PrivateTagDesc other) const

Equality.

Member Data Documentation

◆ comment

std::string ml::PrivateDICOMTags::PrivateTagDesc::comment

If available some manufacturer's comments or descriptions, otherwise empty.

Definition at line 161 of file mlPrivateDICOMTags.h.

◆ completeness

Completeness ml::PrivateDICOMTags::PrivateTagDesc::completeness

InValid, Partial, or Complete information available.

Definition at line 164 of file mlPrivateDICOMTags.h.

◆ elementId

unsigned int ml::PrivateDICOMTags::PrivateTagDesc::elementId

Element identifier of tag.

Definition at line 153 of file mlPrivateDICOMTags.h.

◆ groupId

unsigned int ml::PrivateDICOMTags::PrivateTagDesc::groupId

Identifier of the tag group.

Definition at line 150 of file mlPrivateDICOMTags.h.

◆ manufacturer

std::string ml::PrivateDICOMTags::PrivateTagDesc::manufacturer

If available then this contains the company defined this private tag, otherwise empty.

Definition at line 141 of file mlPrivateDICOMTags.h.

◆ privateCreator

std::string ml::PrivateDICOMTags::PrivateTagDesc::privateCreator

Name of the private creator or the private tag group the tag belongs to.

Definition at line 144 of file mlPrivateDICOMTags.h.

◆ tagName

std::string ml::PrivateDICOMTags::PrivateTagDesc::tagName

Name of tag as it is defined by the manufacturer as a private one.

Definition at line 147 of file mlPrivateDICOMTags.h.

◆ vm

std::string ml::PrivateDICOMTags::PrivateTagDesc::vm

Value multiplicity.

Definition at line 158 of file mlPrivateDICOMTags.h.

◆ vr

DCMTree::Vr ml::PrivateDICOMTags::PrivateTagDesc::vr

Tags value representation.

Definition at line 156 of file mlPrivateDICOMTags.h.


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