GDCM_NAME_SPACE::DicomEntry

GDCM_NAME_SPACE::DicomEntry Class Reference

a DicomEntry is an element contained by the Dict. It contains : More...

#include <gdcmDicomEntry.h>

Inheritance diagram for GDCM_NAME_SPACE::DicomEntry:

Inheritance graph
[legend]
Collaboration diagram for GDCM_NAME_SPACE::DicomEntry:

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.
const TagKey & GetKey () const
 Returns the Dicom Tag Key.
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
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 TagKey TranslateToKey (uint16_t group, uint16_t elem)

Protected Member Functions

 DicomEntry (const uint16_t &group, const uint16_t &elt, const VRKey &vr=GDCM_VRUNKNOWN)
 Constructor.
 ~DicomEntry ()
 Destructor.

Protected Attributes

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

Private Member Functions

 gdcmTypeMacro (DicomEntry)

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".

Detailed Description

a DicomEntry is an element contained by the Dict. It contains :

Definition at line 42 of file gdcmDicomEntry.h.

Constructor & Destructor Documentation

GDCM_NAME_SPACE::DicomEntry::DicomEntry (  const uint16_t &  group,
const uint16_t &  elem,
const VRKey &  vr = GDCM_VRUNKNOWN
)  [protected]
 

Constructor.

Parameters:
group DICOM-Group Number
elem DICOM-Element Number
vr Value Representation

Definition at line 37 of file gdcmDicomEntry.cxx.

References Tag.

00039 {
00040    //Tag.SetGroupElement(group);
00041    //Tag.SetElement(elem);
00042    Tag.SetGroupElement(group,elem);
00043    VR = vr;
00044 }

GDCM_NAME_SPACE::DicomEntry::~DicomEntry (   )  [protected]
 

Destructor.

Definition at line 49 of file gdcmDicomEntry.cxx.

00050 {
00051 }

Member Function Documentation

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

Delete the object.

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

Definition at line 41 of file gdcmRefCounter.h.

Referenced by GDCM_NAME_SPACE::SerieHelper::AddFileName(), GDCM_NAME_SPACE::Document::Backtrack(), GDCM_NAME_SPACE::FileHelper::CheckMandatoryElements(), GDCM_NAME_SPACE::FileHelper::CheckMandatoryEntry(), GDCM_NAME_SPACE::FileHelper::CopyMandatoryEntry(), GDCM_NAME_SPACE::Dict::DoTheLoadingJob(), GDCM_NAME_SPACE::FillDefaultDataDict(), GDCM_NAME_SPACE::DicomDirObject::FillObject(), vtkGdcmReader::GetFileInformation(), GDCM_NAME_SPACE::DocEntrySet::InsertEntryBinArea(), GDCM_NAME_SPACE::DocEntrySet::InsertEntryString(), GDCM_NAME_SPACE::DocEntrySet::InsertSeqEntry(), vtkGdcmReader::LoadFileInformation(), GDCM_NAME_SPACE::DicomDir::NewMeta(), GDCM_NAME_SPACE::DicomDirStudy::NewVisit(), GDCM_NAME_SPACE::Document::ReadNextDocEntry(), GDCM_NAME_SPACE::DicomDir::SetElement(), GDCM_NAME_SPACE::FileHelper::SetMandatoryEntry(), GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToExplicitVR(), GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToImplicitVR(), GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToJPEG(), GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToJPEG2000(), GDCM_NAME_SPACE::FileHelper::SetWriteToLibido(), GDCM_NAME_SPACE::DicomDir::~DicomDir(), GDCM_NAME_SPACE::DictSet::~DictSet(), and GDCM_NAME_SPACE::Global::~Global().

00041 { Unregister(); }

GDCM_NAME_SPACE::DicomEntry::gdcmTypeMacro (  DicomEntry   )  [private]
 

const uint16_t& GDCM_NAME_SPACE::DicomEntry::GetElement (   )  const [inline]
 

Returns the Dicom Element Number.

Returns:
the Dicom Element Number

Definition at line 56 of file gdcmDicomEntry.h.

00056 { return Tag[1]; }

const uint16_t& GDCM_NAME_SPACE::DicomEntry::GetGroup (   )  const [inline]
 

Returns the Dicom Group Number.

Returns:
the Dicom Group Number

Definition at line 52 of file gdcmDicomEntry.h.

00052 { return Tag[0]; }

const TagKey& GDCM_NAME_SPACE::DicomEntry::GetKey (   )  const [inline]
 

Definition at line 72 of file gdcmDicomEntry.h.

00072 { return Tag; }

const TagKey& GDCM_NAME_SPACE::DicomEntry::GetKey (   )  const [inline]
 

Returns the Dicom Tag Key.

Returns:
the Dicom Tag Key

Definition at line 60 of file gdcmDicomEntry.h.

Referenced by Print().

00060 { return Tag; }

int GDCM_NAME_SPACE::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_NAME_SPACE::RefCounter::GetRefCount (   )  const [inline, inherited]
 

Get the reference counting.

Returns:
Reference count

Definition at line 59 of file gdcmRefCounter.h.

00060    {
00061       return RefCount;
00062    }

const VRKey& GDCM_NAME_SPACE::DicomEntry::GetVR (   )  const [inline]
 

Returns the Dicom Value Representation.

Returns:
the Dicom Value Representation

Definition at line 67 of file gdcmDicomEntry.h.

00067 { return VR; }

bool GDCM_NAME_SPACE::DicomEntry::IsVRUnknown (   )  const [inline]
 

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

Returns:

Definition at line 70 of file gdcmDicomEntry.h.

References GDCM_NAME_SPACE::GDCM_VRUNKNOWN.

00070 { return VR == GDCM_VRUNKNOWN; }

void GDCM_NAME_SPACE::DicomEntry::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_NAME_SPACE::Base.

Definition at line 69 of file gdcmDicomEntry.cxx.

References GetKey().

00070 {
00071    os << GetKey(); 
00072    os << " [" << VR  << "] ";
00073 }

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

Register the object.

Remarks:
It increments the reference counting

Definition at line 46 of file gdcmRefCounter.h.

Referenced by GDCM_NAME_SPACE::SQItem::AddEntry(), GDCM_NAME_SPACE::SeqEntry::AddSQItem(), GDCM_NAME_SPACE::SeqEntry::Copy(), GDCM_NAME_SPACE::DicomDir::Copy(), GDCM_NAME_SPACE::FileHelper::FileHelper(), GDCM_NAME_SPACE::DocEntrySet::GetDictEntry(), GDCM_NAME_SPACE::DocEntry::GetName(), GDCM_NAME_SPACE::DocEntry::GetVM(), GDCM_NAME_SPACE::DocEntrySet::InsertEntryString(), GDCM_NAME_SPACE::CommandManager::InSetCommand(), GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::SeqEntry::SetDelimitationItem().

00046 { RefCount++; }

void GDCM_NAME_SPACE::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_NAME_SPACE::FileHelper::Print(), and GDCM_NAME_SPACE::DicomDir::Print().

00047 { PrintLevel = level; }

virtual void GDCM_NAME_SPACE::DicomEntry::SetVR (  VRKey const &  vr  )  [inline, virtual]
 

Set the Dicom Value Representation.

Parameters:
vr the Dicom Value Representation

Definition at line 64 of file gdcmDicomEntry.h.

00064 { VR = vr; }

static TagKey GDCM_NAME_SPACE::DicomEntry::TranslateToKey (  uint16_t  group,
uint16_t  elem
)  [inline, static]
 

Definition at line 75 of file gdcmDicomEntry.h.

00076                                 { return TagKey(group,elem); }

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

Unregister the object.

Remarks:
It decrements the reference counting

Definition at line 50 of file gdcmRefCounter.h.

Referenced by GDCM_NAME_SPACE::Document::ReadNextDocEntry(), GDCM_NAME_SPACE::SQItem::RemoveEntry(), GDCM_NAME_SPACE::ElementSet::RemoveEntry(), and GDCM_NAME_SPACE::FileHelper::~FileHelper().

00051    {
00052 //std::cout <<"================Unreg " << typeid(*this).name() << std::endl;
00053       RefCount--;
00054       if(RefCount<=0)
00055         delete this;
00056    }

Member Data Documentation

int GDCM_NAME_SPACE::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_NAME_SPACE::SeqEntry::Print(), GDCM_NAME_SPACE::FileHelper::Print(), GDCM_NAME_SPACE::ElementSet::Print(), GDCM_NAME_SPACE::DocEntry::Print(), GDCM_NAME_SPACE::DictEntry::Print(), GDCM_NAME_SPACE::DicomDirStudy::Print(), GDCM_NAME_SPACE::DicomDirSerie::Print(), GDCM_NAME_SPACE::DicomDirPatient::Print(), GDCM_NAME_SPACE::DicomDirMeta::Print(), GDCM_NAME_SPACE::DicomDir::Print(), and GDCM_NAME_SPACE::DataEntry::Print().

TagKey GDCM_NAME_SPACE::DicomEntry::Tag [private]
 

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

Definition at line 85 of file gdcmDicomEntry.h.

Referenced by DicomEntry().

VRKey GDCM_NAME_SPACE::DicomEntry::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 91 of file gdcmDicomEntry.h.

The documentation for this class was generated from the following files:
Generated on Fri Aug 24 13:01:36 2007 for gdcm by  doxygen 1.4.6