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

gdcm::DicomEntry Class Reference

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

#include <gdcmDicomEntry.h>

Inheritance diagram for gdcm::DicomEntry:

Inheritance graph
[legend]
Collaboration diagram for gdcm::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.
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)
 concatenates 2 uint16_t (supposed to be a Dicom group number and a Dicom element number)

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::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 gdcm::TagKey::SetElement(), gdcm::TagKey::SetGroup(), and Tag.

00039 {
00040    Tag.SetGroup(group);
00041    Tag.SetElement(elem);
00042    VR = vr;
00043 }

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

Destructor.

Definition at line 48 of file gdcmDicomEntry.cxx.

00049 {
00050 }

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::DicomEntry::gdcmTypeMacro (  DicomEntry   )  [private]
 

const uint16_t& gdcm::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::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::DicomEntry::GetKey (   )  const [inline]
 

Definition at line 68 of file gdcmDicomEntry.h.

Referenced by Print().

00068 { return Tag; }

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 VRKey& gdcm::DicomEntry::GetVR (   )  const [inline]
 

Returns the Dicom Value Representation.

Returns:
the Dicom Value Representation

Definition at line 63 of file gdcmDicomEntry.h.

00063 { return VR; }

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

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

Returns:

Definition at line 66 of file gdcmDicomEntry.h.

References gdcm::GDCM_VRUNKNOWN.

00066 { return VR == GDCM_VRUNKNOWN; }

void gdcm::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::Base.

Definition at line 82 of file gdcmDicomEntry.cxx.

References GetKey().

00083 {
00084    os << GetKey(); 
00085    os << " [" << VR  << "] ";
00086 }

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::DicomEntry::SetVR (  VRKey const &  vr  )  [inline, virtual]
 

Set the Dicom Value Representation.

Parameters:
vr the Dicom Value Representation

Definition at line 60 of file gdcmDicomEntry.h.

00060 { VR = vr; }

TagKey gdcm::DicomEntry::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 61 of file gdcmDicomEntry.cxx.

00062 {
00063    // according to 'Purify', TranslateToKey is one of the most
00064    // time consuming methods.
00065    // Let's try to shorten it !
00066    return TagKey(group,elem);
00067 }

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

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(), gdcm::DictEntry::Print(), gdcm::DicomDirStudy::Print(), gdcm::DicomDirSerie::Print(), gdcm::DicomDirPatient::Print(), gdcm::DicomDirMeta::Print(), gdcm::DicomDir::Print(), and gdcm::DataEntry::Print().

TagKey gdcm::DicomEntry::Tag [private]
 

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

Definition at line 80 of file gdcmDicomEntry.h.

Referenced by DicomEntry().

VRKey gdcm::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 86 of file gdcmDicomEntry.h.

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