Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
gdcm::DictEntry

gdcm::DictEntry Class Reference

the DictEntry in an element contained by the Dict. It contains : More...

#include <gdcmDictEntry.h>

Inheritance diagram for gdcm::DictEntry:

Inheritance graph
[legend]
Collaboration diagram for gdcm::DictEntry:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void Print (std::ostream &os=std::cout, std::string const &indent="")
 Prints an entry of the Dicom DictionaryEntry.
const uint16_t & GetGroup () const
 Returns the Dicom Group Number.
const uint16_t & GetElement () const
 Returns the Dicom Element Number.
virtual void SetVR (VRKey const &vr)
 Set the Dicom Value Representation.
const VRKey & GetVR () const
 Returns the Dicom Value Representation.
bool IsVRUnknown () const
 tells if the V(alue) R(epresentation) is known (?!)
const TagKey & GetKey () const
const TagName & GetVM () const
 returns the VM field of the current DictEntry
virtual void SetVM (TagName const &vm)
 Set the VM field of the current DictEntry.
bool IsVMUnknown () const
 tells if the V(alue) M(ultiplicity) is known (?!)
const TagName & GetName () const
 Returns the Dicom Name of the current DictEntry e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010).
void Delete ()
 Delete the object.
void Register ()
 Register the object.
void Unregister ()
 Unregister the object.
const unsigned long & GetRefCount () const
 Get the reference counting.
void SetPrintLevel (int level)
 Sets the print level for the Dicom Header Elements.
int GetPrintLevel ()
 Gets the print level for the Dicom Entries.

Static Public Member Functions

static DictEntry * New (uint16_t group, uint16_t elem, VRKey const &vr=GDCM_VRUNKNOWN, TagName const &vm=GDCM_UNKNOWN, TagName const &name=GDCM_UNKNOWN)
 Class allocator.
static TagKey TranslateToKey (uint16_t group, uint16_t elem)
 concatenates 2 uint16_t (supposed to be a Dicom group number and a Dicom element number)

Protected Member Functions

 DictEntry (uint16_t group, uint16_t elem, VRKey const &vr=GDCM_VRUNKNOWN, TagName const &vm=GDCM_UNKNOWN, TagName const &name=GDCM_UNKNOWN)
 Constructor.
 ~DictEntry ()
 Destructor.

Protected Attributes

int PrintLevel
 Amount of printed details for each Dicom Entries : 0 : stands for the least detail level.

Private Member Functions

 gdcmTypeMacro (DictEntry)

Private Attributes

TagKey Tag
 Dicom TagKey. Contains Dicom Group number and Dicom Element number.
VRKey VR
 Value Representation i.e. some clue about the nature of the data represented e.g.
  • "FD" short for "Floating Point Double"(see VR)
  • "PN" short for "Person Name".

TagName VM
 Value Multiplicity (e.g. "1", "1-n", "2-n", "6").
TagName Name
 English name of the entry (e.g. "Patient's Name").

Detailed Description

the DictEntry in an element contained by the Dict. It contains :

Definition at line 42 of file gdcmDictEntry.h.

Constructor & Destructor Documentation

gdcm::DictEntry::DictEntry (  uint16_t  group,
uint16_t  elem,
VRKey const &  vr = GDCM_VRUNKNOWN,
TagName const &  vm = GDCM_UNKNOWN,
TagName const &  name = GDCM_UNKNOWN
)  [protected]
 

Constructor.

Parameters:
group DICOM-Group Number
elem DICOM-Element Number
vr Value Representation
vm Value Multiplicity
name description of the element

Definition at line 39 of file gdcmDictEntry.cxx.

References Name, gdcm::TagKey::SetElement(), gdcm::TagKey::SetGroup(), Tag, and VM.

Referenced by New().

00044 {
00045    Tag.SetGroup(group);
00046    Tag.SetElement(elem);
00047    VR      = vr;
00048    VM      = vm;
00049    Name    = name;
00050 }

gdcm::DictEntry::~DictEntry (   )  [protected]
 

Destructor.

Definition at line 55 of file gdcmDictEntry.cxx.

00056 {
00057 }

Member Function Documentation

void gdcm::RefCounter::Delete (   )  [inline, inherited]
 

Delete the object.

Remarks:
The object is deleted only if its reference counting is to zero

Definition at line 39 of file gdcmRefCounter.h.

Referenced by gdcm::SerieHelper::AddFileName(), gdcm::Document::Backtrack(), gdcm::FileHelper::CheckMandatoryElements(), gdcm::FileHelper::CheckMandatoryEntry(), gdcm::FileHelper::CopyMandatoryEntry(), gdcm::DicomDir::CreateDicomDirChainedList(), gdcm::File::DoTheLoadingJob(), gdcm::Dict::DoTheLoadingJob(), gdcm::DicomDirObject::FillObject(), gdcm::DocEntrySet::InsertEntryBinArea(), gdcm::DocEntrySet::InsertEntryString(), gdcm::DocEntrySet::InsertSeqEntry(), vtkGdcmReader::LoadFileInformation(), vtkGdcmReader::LoadImageInMemory(), main(), gdcm::DicomDir::NewMeta(), gdcm::DicomDirStudy::NewVisit(), gdcm::Document::ParseDES(), gdcm::Document::ParseSQ(), gdcm::Document::ReadNextDocEntry(), gdcm::DicomDir::SetElement(), gdcm::FileHelper::SetMandatoryEntry(), gdcm::FileHelper::SetWriteFileTypeToExplicitVR(), gdcm::FileHelper::SetWriteFileTypeToImplicitVR(), gdcm::FileHelper::SetWriteFileTypeToJPEG(), gdcm::FileHelper::SetWriteToLibido(), gdcm::FileHelper::SetWriteToNoLibido(), gdcm::FileHelper::SetWriteToRaw(), gdcm::FileHelper::SetWriteToRGB(), vtkGdcmWriter::WriteDcmFile(), gdcm::DicomDir::~DicomDir(), and gdcm::Global::~Global().

00039 { Unregister(); }

gdcm::DictEntry::gdcmTypeMacro (  DictEntry   )  [private]
 

const uint16_t& gdcm::DictEntry::GetElement (   )  const [inline]
 

Returns the Dicom Element Number.

Returns:
the Dicom Element Number

Definition at line 61 of file gdcmDictEntry.h.

Referenced by gdcm::DocEntryArchive::Push().

00061 { return Tag[1]; }

const uint16_t& gdcm::DictEntry::GetGroup (   )  const [inline]
 

Returns the Dicom Group Number.

Returns:
the Dicom Group Number

Definition at line 57 of file gdcmDictEntry.h.

Referenced by gdcm::DocEntryArchive::Push().

00057 { return Tag[0]; }

const TagKey& gdcm::DictEntry::GetKey (   )  const [inline]
 

Definition at line 73 of file gdcmDictEntry.h.

Referenced by gdcm::Dict::AddEntry(), Print(), and gdcm::Dict::ReplaceEntry().

00073 { return Tag; }

const TagName& gdcm::DictEntry::GetName (   )  const [inline]
 

Returns the Dicom Name of the current DictEntry e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010).

Returns:
the Dicom Name

Definition at line 91 of file gdcmDictEntry.h.

Referenced by Print().

00091 { return Name; }

int gdcm::Base::GetPrintLevel (   )  [inline, inherited]
 

Gets the print level for the Dicom Entries.

Definition at line 50 of file gdcmBase.h.

00050 { return PrintLevel; }

const unsigned long& gdcm::RefCounter::GetRefCount (   )  const [inline, inherited]
 

Get the reference counting.

Returns:
Reference count

Definition at line 56 of file gdcmRefCounter.h.

00057    {
00058       return RefCount;
00059    }

const TagName& gdcm::DictEntry::GetVM (   )  const [inline]
 

returns the VM field of the current DictEntry

Returns:
The 'Value Multiplicity' field

Definition at line 80 of file gdcmDictEntry.h.

Referenced by gdcm::DocEntrySet::GetDictEntry().

00080 { return VM; }

const VRKey& gdcm::DictEntry::GetVR (   )  const [inline]
 

Returns the Dicom Value Representation.

Returns:
the Dicom Value Representation

Definition at line 68 of file gdcmDictEntry.h.

Referenced by gdcm::DocEntrySet::GetDictEntry(), and gdcm::Document::ReadNextDocEntry().

00068 { return VR; }

bool gdcm::DictEntry::IsVMUnknown (   )  const [inline]
 

tells if the V(alue) M(ultiplicity) is known (?!)

Returns:

Definition at line 86 of file gdcmDictEntry.h.

References gdcm::GDCM_UNKNOWN.

00086 { return VM == GDCM_UNKNOWN; }

bool gdcm::DictEntry::IsVRUnknown (   )  const [inline]
 

tells if the V(alue) R(epresentation) is known (?!)

Returns:

Definition at line 71 of file gdcmDictEntry.h.

References gdcm::GDCM_VRUNKNOWN.

00071 { return VR == GDCM_VRUNKNOWN; }

DictEntry * gdcm::DictEntry::New (  uint16_t  group,
uint16_t  elem,
VRKey const &  vr = GDCM_VRUNKNOWN,
TagName const &  vm = GDCM_UNKNOWN,
TagName const &  name = GDCM_UNKNOWN
)  [static]
 

Class allocator.

Parameters:
group DICOM-Group Number
elem DICOM-Element Number
vr Value Representation
vm Value Multiplicity
name description of the element

Definition at line 68 of file gdcmDictEntry.cxx.

References DictEntry().

Referenced by gdcm::File::DoTheLoadingJob(), gdcm::Dict::DoTheLoadingJob(), and gdcm::DocEntrySet::GetDictEntry().

00072 {
00073    return new DictEntry(group,elem,vr,vm,name);
00074 }

void gdcm::DictEntry::Print (  std::ostream &  os = std::cout,
std::string const &  indent = ""
)  [virtual]
 

Prints an entry of the Dicom DictionaryEntry.

Parameters:
os ostream we want to print in
indent Indentation string to be prepended during printing

Reimplemented from gdcm::Base.

Definition at line 104 of file gdcmDictEntry.cxx.

References GetKey(), GetName(), and gdcm::Base::PrintLevel.

00105 {
00106    os << GetKey(); 
00107    os << " [" << VR  << "] ";
00108 
00109    std::ostringstream s;
00110 
00111    if ( PrintLevel >= 1 )
00112    {
00113       s.setf(std::ios::left);
00114       s << std::setw(66-GetName().length()) << " ";
00115    }
00116 
00117    s << "[" << GetName()<< "]";
00118    os << s.str() << std::endl;
00119 }

void gdcm::RefCounter::Register (   )  [inline, inherited]
 

Register the object.

Remarks:
It increments the reference counting

Definition at line 44 of file gdcmRefCounter.h.

Referenced by gdcm::SQItem::AddEntry(), gdcm::ElementSet::AddEntry(), gdcm::Dict::AddEntry(), gdcm::SeqEntry::AddSQItem(), gdcm::SeqEntry::Copy(), gdcm::DicomDir::Copy(), gdcm::DocEntry::DocEntry(), gdcm::FileHelper::FileHelper(), gdcm::DocEntrySet::GetDictEntry(), gdcm::CommandManager::InSetCommand(), gdcm::DocEntryArchive::Push(), gdcm::Dict::ReplaceEntry(), and gdcm::SeqEntry::SetDelimitationItem().

00044 { RefCount++; }

void gdcm::Base::SetPrintLevel (  int  level  )  [inline, inherited]
 

Sets the print level for the Dicom Header Elements.

Note:
0 for Light Print; 1 for 'medium' Print, 2 for Heavy Print

Definition at line 47 of file gdcmBase.h.

Referenced by gdcm::SQItem::Print(), gdcm::SeqEntry::Print(), gdcm::FileHelper::Print(), gdcm::ElementSet::Print(), and gdcm::DicomDir::Print().

00047 { PrintLevel = level; }

virtual void gdcm::DictEntry::SetVM (  TagName const &  vm  )  [inline, virtual]
 

Set the VM field of the current DictEntry.

Parameters:
vm the'Value Multiplicity'

Definition at line 83 of file gdcmDictEntry.h.

00083 { VM = vm; }

virtual void gdcm::DictEntry::SetVR (  VRKey const &  vr  )  [inline, virtual]
 

Set the Dicom Value Representation.

Parameters:
vr the Dicom Value Representation

Definition at line 65 of file gdcmDictEntry.h.

00065 { VR = vr; }

TagKey gdcm::DictEntry::TranslateToKey (  uint16_t  group,
uint16_t  elem
)  [static]
 

concatenates 2 uint16_t (supposed to be a Dicom group number and a Dicom element number)

Parameters:
group the Dicom group number used to build the tag
elem the Dicom element number used to build the tag
Returns:
the built tag

Definition at line 83 of file gdcmDictEntry.cxx.

Referenced by gdcm::ElementSet::GetDocEntry(), gdcm::Dict::GetEntry(), gdcm::DocEntry::Print(), gdcm::DicomDirElement::Print(), gdcm::DocEntryArchive::Push(), gdcm::File::ReadTag(), gdcm::File::ReadTagLength(), gdcm::Dict::RemoveEntry(), and gdcm::DocEntryArchive::Restore().

00084 {
00085    // according to 'Purify', TranslateToKey is one of the most
00086    // time consuming methods.
00087    // Let's try to shorten it !
00088    return TagKey(group,elem);
00089 }

void gdcm::RefCounter::Unregister (   )  [inline, inherited]
 

Unregister the object.

Remarks:
It decrements the reference counting

Definition at line 48 of file gdcmRefCounter.h.

Referenced by gdcm::SeqEntry::ClearSQItem(), gdcm::DicomDir::Copy(), gdcm::DocEntrySet::GetDictEntry(), gdcm::CommandManager::InSetCommand(), gdcm::DocEntrySet::NewDataEntry(), gdcm::DocEntrySet::NewSeqEntry(), gdcm::Document::ReadNextDocEntry(), gdcm::SQItem::RemoveEntry(), gdcm::ElementSet::RemoveEntry(), gdcm::SeqEntry::SetDelimitationItem(), gdcm::DocEntry::~DocEntry(), and gdcm::FileHelper::~FileHelper().

00049    {
00050       RefCount--;
00051       if(RefCount<=0)
00052          delete this;
00053    }

Member Data Documentation

TagName gdcm::DictEntry::Name [private]
 

English name of the entry (e.g. "Patient's Name").

Definition at line 115 of file gdcmDictEntry.h.

Referenced by DictEntry().

int gdcm::Base::PrintLevel [protected, inherited]
 

Amount of printed details for each Dicom Entries : 0 : stands for the least detail level.

Definition at line 55 of file gdcmBase.h.

Referenced by gdcm::SQItem::Print(), gdcm::SeqEntry::Print(), gdcm::FileHelper::Print(), gdcm::ElementSet::Print(), gdcm::DocEntry::Print(), Print(), gdcm::DicomDirStudy::Print(), gdcm::DicomDirSerie::Print(), gdcm::DicomDirPatient::Print(), gdcm::DicomDirMeta::Print(), gdcm::DicomDir::Print(), and gdcm::DataEntry::Print().

TagKey gdcm::DictEntry::Tag [private]
 

Dicom TagKey. Contains Dicom Group number and Dicom Element number.

Definition at line 103 of file gdcmDictEntry.h.

Referenced by DictEntry().

TagName gdcm::DictEntry::VM [private]
 

Value Multiplicity (e.g. "1", "1-n", "2-n", "6").

Definition at line 112 of file gdcmDictEntry.h.

Referenced by DictEntry().

VRKey gdcm::DictEntry::VR [private]
 

Value Representation i.e. some clue about the nature of the data represented e.g.

  • "FD" short for "Floating Point Double"(see VR)
  • "PN" short for "Person Name".

Definition at line 109 of file gdcmDictEntry.h.

The documentation for this class was generated from the following files:
Generated on Fri Jan 20 10:14:34 2006 for gdcm by  doxygen 1.4.4