creaImageIO::tree::AttributeDescriptor Class Reference
[Attributed tree management]

Descriptor of an attribute of a node of a Tree (name, dicom group/element). More...

#include <creaImageIOTreeAttributeDescriptor.h>

List of all members.

Public Member Functions

 AttributeDescriptor ()
 Default ctor.
 AttributeDescriptor (const std::string &key, const std::string &name, unsigned short group, unsigned short element, unsigned int flags)
 Ctor with all explicitely.
 AttributeDescriptor (const std::string &key, const std::string &name, unsigned int flags=0)
 AttributeDescriptor (unsigned short group, unsigned short element, unsigned int flags=0)
const std::string & GetKey () const
 Returns the key of the attribute.
const std::string & GetName () const
 Returns the name of the attribute.
unsigned short GetGroup () const
 Returns the DICOM group code of the attribute.
unsigned short GetElement () const
 Returns the DICOM element code of the attribute.
unsigned int GetFlags () const
 Returns the flags of the attribute.
void CleanName (std::string &str) const
void DecodeType (unsigned int &type) const
 Decodes the type of attribute into the existing ones.
bool isDateEntry () const
bool isTimeEntry () const

Static Public Member Functions

static void GetDicomGroupElementFromKey (const std::string &key, unsigned short &group, unsigned short &elem)
 Extracts group and element from a key of the form "Dgroup_elem".

Static Public Attributes

static const unsigned int PRIVATE
static const unsigned int IDENTIFIER
 The attribute enters in unique identifier constitution.
static const unsigned int LABEL
 The attribute enters in label constitution (for printing).
static const unsigned int EDITABLE
 The attribute can be edited.
static const int NUMBER = 1
 The attribute is of numeric type.
static const int STRING = 2
 The attribute is of string type.
static const int UNKNOWN = 0
 The attribute's type is unknown.

Private Attributes

std::string mKey
std::string mName
unsigned short mGroup
unsigned short mElement
unsigned int mFlags


Detailed Description

Descriptor of an attribute of a node of a Tree (name, dicom group/element).

Definition at line 17 of file creaImageIOTreeAttributeDescriptor.h.


Constructor & Destructor Documentation

creaImageIO::tree::AttributeDescriptor::AttributeDescriptor (  )  [inline]

Default ctor.

Definition at line 39 of file creaImageIOTreeAttributeDescriptor.h.

00040         : mKey(""), mName(""), mGroup(0), mElement(0), mFlags(0)
00041       {
00042       }

creaImageIO::tree::AttributeDescriptor::AttributeDescriptor ( const std::string &  key,
const std::string &  name,
unsigned short  group,
unsigned short  element,
unsigned int  flags 
) [inline]

Ctor with all explicitely.

Definition at line 44 of file creaImageIOTreeAttributeDescriptor.h.

00049         : mKey(key), mName(name), mGroup(group), mElement(element), 
00050           mFlags(flags)
00051       {
00052       }

creaImageIO::tree::AttributeDescriptor::AttributeDescriptor ( const std::string &  key,
const std::string &  name,
unsigned int  flags = 0 
)

creaImageIO::tree::AttributeDescriptor::AttributeDescriptor ( unsigned short  group,
unsigned short  element,
unsigned int  flags = 0 
)


Member Function Documentation

const std::string& creaImageIO::tree::AttributeDescriptor::GetKey (  )  const [inline]

Returns the key of the attribute.

Definition at line 65 of file creaImageIOTreeAttributeDescriptor.h.

References mKey.

00065 { return mKey; }

const std::string& creaImageIO::tree::AttributeDescriptor::GetName (  )  const [inline]

Returns the name of the attribute.

Definition at line 67 of file creaImageIOTreeAttributeDescriptor.h.

References mName.

00067 { return mName; }

unsigned short creaImageIO::tree::AttributeDescriptor::GetGroup (  )  const [inline]

Returns the DICOM group code of the attribute.

Definition at line 69 of file creaImageIOTreeAttributeDescriptor.h.

References mGroup.

00069 { return mGroup; }

unsigned short creaImageIO::tree::AttributeDescriptor::GetElement (  )  const [inline]

Returns the DICOM element code of the attribute.

Definition at line 71 of file creaImageIOTreeAttributeDescriptor.h.

References mElement.

00071 { return mElement; }

unsigned int creaImageIO::tree::AttributeDescriptor::GetFlags (  )  const [inline]

Returns the flags of the attribute.

Definition at line 73 of file creaImageIOTreeAttributeDescriptor.h.

References mFlags.

00073 { return mFlags; }

static void creaImageIO::tree::AttributeDescriptor::GetDicomGroupElementFromKey ( const std::string &  key,
unsigned short &  group,
unsigned short &  elem 
) [static]

Extracts group and element from a key of the form "Dgroup_elem".

void creaImageIO::tree::AttributeDescriptor::CleanName ( std::string &  str  )  const

Cleans the name: Replace simple quote by double quotes Cut string at NULL chars

void creaImageIO::tree::AttributeDescriptor::DecodeType ( unsigned int &  type  )  const

Decodes the type of attribute into the existing ones.

bool creaImageIO::tree::AttributeDescriptor::isDateEntry (  )  const

bool creaImageIO::tree::AttributeDescriptor::isTimeEntry (  )  const


Member Data Documentation

const unsigned int creaImageIO::tree::AttributeDescriptor::PRIVATE [static]

Flags The attribute is hidden (not visible to user)

Definition at line 22 of file creaImageIOTreeAttributeDescriptor.h.

const unsigned int creaImageIO::tree::AttributeDescriptor::IDENTIFIER [static]

The attribute enters in unique identifier constitution.

Definition at line 24 of file creaImageIOTreeAttributeDescriptor.h.

const unsigned int creaImageIO::tree::AttributeDescriptor::LABEL [static]

The attribute enters in label constitution (for printing).

Definition at line 26 of file creaImageIOTreeAttributeDescriptor.h.

const unsigned int creaImageIO::tree::AttributeDescriptor::EDITABLE [static]

The attribute can be edited.

Definition at line 28 of file creaImageIOTreeAttributeDescriptor.h.

const int creaImageIO::tree::AttributeDescriptor::NUMBER = 1 [static]

The attribute is of numeric type.

Types

Definition at line 32 of file creaImageIOTreeAttributeDescriptor.h.

const int creaImageIO::tree::AttributeDescriptor::STRING = 2 [static]

The attribute is of string type.

Definition at line 34 of file creaImageIOTreeAttributeDescriptor.h.

const int creaImageIO::tree::AttributeDescriptor::UNKNOWN = 0 [static]

The attribute's type is unknown.

Definition at line 36 of file creaImageIOTreeAttributeDescriptor.h.

std::string creaImageIO::tree::AttributeDescriptor::mKey [private]

Definition at line 90 of file creaImageIOTreeAttributeDescriptor.h.

Referenced by GetKey().

std::string creaImageIO::tree::AttributeDescriptor::mName [private]

Definition at line 91 of file creaImageIOTreeAttributeDescriptor.h.

Referenced by GetName().

unsigned short creaImageIO::tree::AttributeDescriptor::mGroup [private]

Definition at line 92 of file creaImageIOTreeAttributeDescriptor.h.

Referenced by GetGroup().

unsigned short creaImageIO::tree::AttributeDescriptor::mElement [private]

Definition at line 93 of file creaImageIOTreeAttributeDescriptor.h.

Referenced by GetElement().

unsigned int creaImageIO::tree::AttributeDescriptor::mFlags [private]

Definition at line 94 of file creaImageIOTreeAttributeDescriptor.h.

Referenced by GetFlags().


The documentation for this class was generated from the following file:
Generated on Mon Jun 22 10:50:10 2009 for CreaImageIO by  doxygen 1.5.3