GDCM_NAME_SPACE::Command

GDCM_NAME_SPACE::Command Class Reference

Command base class to react on a gdcm event. More...

#include <gdcmCommand.h>

Inheritance diagram for GDCM_NAME_SPACE::Command:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

void SetType (unsigned int type)
unsigned int GetType () const
void SetObject (Base *object)
Base * GetObject () const
void SetConstObject (const Base *object)
const Base * GetConstObject () const
void SetText (const std::string &text)
const std::string & GetText () const
virtual void Execute ()
void Delete ()
 Delete the object.
void Register ()
 Register the object.
void Unregister ()
 Unregister the object.
const unsigned long & GetRefCount () const
 Get the reference counting.
virtual void Print (std::ostream &=std::cout, std::string const &="")
 Printer.
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 const char * GetCommandAsString (unsigned int command)

Protected Member Functions

 Command ()
 Constructor used when we want to generate dicom files from scratch.
virtual ~Command ()
 Canonical destructor.

Protected Attributes

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

Private Member Functions

 gdcmTypeMacro (Command)
 gdcmNewMacro (Command)

Private Attributes

std::string Text
Base * Object
const Base * ConstObject
unsigned int Cmd

Detailed Description

Command base class to react on a gdcm event.

Remarks:
The execution parameter depends on the

Definition at line 48 of file gdcmCommand.h.

Constructor & Destructor Documentation

GDCM_NAME_SPACE::Command::Command (   )  [protected]
 

Constructor used when we want to generate dicom files from scratch.

Definition at line 28 of file gdcmCommand.cxx.

References Cmd, GDCM_NAME_SPACE::CMD_UNKNOWN, ConstObject, Object, and Text.

00029 {
00030    Cmd = CMD_UNKNOWN;
00031    Object = NULL;
00032    ConstObject = NULL;
00033    Text = "";
00034 }

GDCM_NAME_SPACE::Command::~Command (   )  [protected, virtual]
 

Canonical destructor.

Definition at line 40 of file gdcmCommand.cxx.

00041 {
00042 }

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(); }

void GDCM_NAME_SPACE::Command::Execute (   )  [virtual]
 

Reimplemented in GDCM_NAME_SPACE::CallbackCommand.

Definition at line 89 of file gdcmCommand.cxx.

Referenced by GDCM_NAME_SPACE::CommandManager::InExecuteCommand(), and GDCM_NAME_SPACE::CommandManager::InExecuteCommandConst().

00090 {
00091 }

GDCM_NAME_SPACE::Command::gdcmNewMacro (  Command   )  [private]
 

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

const char * GDCM_NAME_SPACE::Command::GetCommandAsString (  unsigned int  command  )  [static]
 

Definition at line 93 of file gdcmCommand.cxx.

References GDCM_NAME_SPACE::CMD_ASSERT, GDCM_NAME_SPACE::CMD_DEBUG, GDCM_NAME_SPACE::CMD_ENDPROGRESS, GDCM_NAME_SPACE::CMD_ERROR, GDCM_NAME_SPACE::CMD_PROGRESS, GDCM_NAME_SPACE::CMD_STARTPROGRESS, GDCM_NAME_SPACE::CMD_UNKNOWN, and GDCM_NAME_SPACE::CMD_WARNING.

Referenced by GDCM_NAME_SPACE::CommandManager::Print(), and GDCM_NAME_SPACE::Debug::SendToOutput().

00094 {
00095    switch(command)
00096    {
00097       case CMD_UNKNOWN:
00098          return "Unknown";
00099       case CMD_DEBUG:
00100          return "Debug";
00101       case CMD_WARNING:
00102          return "Warning";
00103       case CMD_ERROR:
00104          return "Error";
00105       case CMD_ASSERT:
00106          return "Assert";
00107       case CMD_STARTPROGRESS:
00108          return "StartProgress";
00109       case CMD_ENDPROGRESS:
00110          return "EndProgress";
00111       case CMD_PROGRESS:
00112          return "Progress";
00113       default:
00114          return "Undefined !!!";
00115    }
00116 }

const Base * GDCM_NAME_SPACE::Command::GetConstObject (   )  const
 

Definition at line 71 of file gdcmCommand.cxx.

References ConstObject, and GetObject().

00072 {
00073    if(ConstObject)
00074       return ConstObject;
00075    else
00076       return GetObject();
00077 }

Base * GDCM_NAME_SPACE::Command::GetObject (   )  const
 

Definition at line 61 of file gdcmCommand.cxx.

References Object.

Referenced by GetConstObject().

00062 {
00063    return Object;
00064 }

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 std::string & GDCM_NAME_SPACE::Command::GetText (   )  const
 

Definition at line 84 of file gdcmCommand.cxx.

References Text.

00085 {
00086    return Text;
00087 }

unsigned int GDCM_NAME_SPACE::Command::GetType (   )  const
 

Definition at line 51 of file gdcmCommand.cxx.

References Cmd.

00052 {
00053    return Cmd;
00054 }

virtual void GDCM_NAME_SPACE::Base::Print (  std::ostream &  = std::cout,
std::string const &  = ""
)  [inline, virtual, inherited]
 

Printer.

Reimplemented in GDCM_NAME_SPACE::CommandManager, GDCM_NAME_SPACE::DataEntry, GDCM_NAME_SPACE::DicomDir, GDCM_NAME_SPACE::DicomDirElement, GDCM_NAME_SPACE::DicomDirImage, GDCM_NAME_SPACE::DicomDirMeta, GDCM_NAME_SPACE::DicomDirPatient, GDCM_NAME_SPACE::DicomDirPrivate, GDCM_NAME_SPACE::DicomDirSerie, GDCM_NAME_SPACE::DicomDirStudy, GDCM_NAME_SPACE::DicomDirVisit, GDCM_NAME_SPACE::DicomEntry, GDCM_NAME_SPACE::Dict, GDCM_NAME_SPACE::DictEntry, GDCM_NAME_SPACE::DictGroupName, GDCM_NAME_SPACE::DictSet, GDCM_NAME_SPACE::DirList, GDCM_NAME_SPACE::DocEntry, GDCM_NAME_SPACE::ElementSet, GDCM_NAME_SPACE::FileHelper, GDCM_NAME_SPACE::JPEGFragment, GDCM_NAME_SPACE::PixelReadConvert, GDCM_NAME_SPACE::RLEFrame, GDCM_NAME_SPACE::SeqEntry, GDCM_NAME_SPACE::SerieHelper, GDCM_NAME_SPACE::SQItem, and GDCM_NAME_SPACE::VR.

Definition at line 42 of file gdcmBase.h.

00043                                                {};

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::Command::SetConstObject (  const Base *  object  ) 
 

Definition at line 66 of file gdcmCommand.cxx.

References ConstObject.

Referenced by GDCM_NAME_SPACE::CommandManager::InExecuteCommandConst().

00067 {
00068    ConstObject = object;
00069 }

void GDCM_NAME_SPACE::Command::SetObject (  Base *  object  ) 
 

Definition at line 56 of file gdcmCommand.cxx.

References Object.

Referenced by GDCM_NAME_SPACE::CommandManager::InExecuteCommand().

00057 {
00058    Object = object;
00059 }

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; }

void GDCM_NAME_SPACE::Command::SetText (  const std::string &  text  ) 
 

Definition at line 79 of file gdcmCommand.cxx.

References Text.

Referenced by GDCM_NAME_SPACE::CommandManager::InExecuteCommand(), and GDCM_NAME_SPACE::CommandManager::InExecuteCommandConst().

00080 {
00081    Text = text;
00082 }

void GDCM_NAME_SPACE::Command::SetType (  unsigned int  type  ) 
 

Definition at line 46 of file gdcmCommand.cxx.

References Cmd.

Referenced by GDCM_NAME_SPACE::CommandManager::InExecuteCommand(), and GDCM_NAME_SPACE::CommandManager::InExecuteCommandConst().

00047 {
00048    Cmd = type;
00049 }

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

unsigned int GDCM_NAME_SPACE::Command::Cmd [private]
 

Definition at line 78 of file gdcmCommand.h.

Referenced by Command(), GetType(), and SetType().

const Base* GDCM_NAME_SPACE::Command::ConstObject [private]
 

Definition at line 77 of file gdcmCommand.h.

Referenced by Command(), GetConstObject(), and SetConstObject().

Base* GDCM_NAME_SPACE::Command::Object [private]
 

Definition at line 76 of file gdcmCommand.h.

Referenced by Command(), GetObject(), and SetObject().

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().

std::string GDCM_NAME_SPACE::Command::Text [private]
 

Definition at line 75 of file gdcmCommand.h.

Referenced by Command(), GetText(), and SetText().

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