Inheritance diagram for DcmPersonName:
Public Member Functions | |
DcmPersonName (const DcmTag &tag, const Uint32 len=0) | |
constructor. | |
DcmPersonName (const DcmPersonName &old) | |
copy constructor | |
virtual | ~DcmPersonName () |
destructor | |
DcmPersonName & | operator= (const DcmPersonName &obj) |
assignment operator | |
virtual DcmObject * | clone () const |
clone method | |
virtual DcmEVR | ident () const |
get element type identifier | |
virtual OFCondition | getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue) |
get a copy of a particular string component | |
OFCondition | getNameComponents (OFString &lastName, OFString &firstName, OFString &middleName, OFString &namePrefix, OFString &nameSuffix, const unsigned long pos=0, const unsigned int componentGroup=0) |
get name components from the element value. | |
OFCondition | getFormattedName (OFString &formattedName, const unsigned long pos=0, const unsigned int componentGroup=0) |
get current element value as a formatted/readable name. | |
OFCondition | putNameComponents (const OFString &lastName, const OFString &firstName, const OFString &middleName, const OFString &namePrefix, const OFString &nameSuffix) |
put element value from specified name components. | |
Static Public Member Functions | |
static OFCondition | getNameComponentsFromString (const OFString &dicomName, OFString &lastName, OFString &firstName, OFString &middleName, OFString &namePrefix, OFString &nameSuffix, const unsigned int componentGroup=0) |
get name components from specified DICOM person name. | |
static OFCondition | getFormattedNameFromString (const OFString &dicomName, OFString &formattedName, const unsigned int componentGroup=0) |
get specified DICOM person name as a formatted/readable name. | |
static OFCondition | getFormattedNameFromComponents (const OFString &lastName, const OFString &firstName, const OFString &middleName, const OFString &namePrefix, const OFString &nameSuffix, OFString &formattedName) |
get formatted/readable name from specified name components. | |
static OFCondition | getStringFromNameComponents (const OFString &lastName, const OFString &firstName, const OFString &middleName, const OFString &namePrefix, const OFString &nameSuffix, OFString &dicomName) |
get DICOM Person Name (PN) from specified name components. |
Definition at line 45 of file dcvrpn.h.
DcmPersonName::DcmPersonName | ( | const DcmTag & | tag, | |
const Uint32 | len = 0 | |||
) |
constructor.
Create new element from given tag and length.
tag | DICOM tag for the new element | |
len | value length for the new element |
Referenced by clone().
DcmPersonName::DcmPersonName | ( | const DcmPersonName & | old | ) |
copy constructor
old | element to be copied |
DcmPersonName& DcmPersonName::operator= | ( | const DcmPersonName & | obj | ) |
assignment operator
obj | element to be assigned/copied |
virtual DcmObject* DcmPersonName::clone | ( | ) | const [inline, virtual] |
clone method
Reimplemented from DcmCharString.
Definition at line 77 of file dcvrpn.h.
References DcmPersonName().
virtual DcmEVR DcmPersonName::ident | ( | ) | const [virtual] |
get element type identifier
Reimplemented from DcmByteString.
virtual OFCondition DcmPersonName::getOFString | ( | OFString & | stringVal, | |
const unsigned long | pos, | |||
OFBool | normalize = OFTrue | |||
) | [virtual] |
get a copy of a particular string component
stringVal | variable in which the result value is stored | |
pos | index of the value in case of multi-valued elements (0..vm-1) | |
normalize | delete leading and trailing spaces if OFTrue |
Reimplemented from DcmByteString.
OFCondition DcmPersonName::getNameComponents | ( | OFString & | lastName, | |
OFString & | firstName, | |||
OFString & | middleName, | |||
OFString & | namePrefix, | |||
OFString & | nameSuffix, | |||
const unsigned long | pos = 0 , |
|||
const unsigned int | componentGroup = 0 | |||
) |
get name components from the element value.
The DICOM PN consists of up to three component groups separated by a "=". The supported format is "[CG0][=CG1][=CG2]" where the brackets enclose optional parts and CG0 is a single-byte character representation, CG1 an ideographic representation, and CG2 a phonetic representation of the name. Each component group may consist of up to five components separated by a "^". The format is "[lastName[^firstName[^middleName[^namePrefix[^nameSuffix]]]]"; each component might be empty. If this function fails the result variables are cleared automatically. If the format is valid but does not comply with the above described scheme ("=" and "^") the full person name is returned in the 'lastName' variable.
lastName | reference to string variable where the "last name" is stored | |
firstName | reference to string variable where the "first name" is stored | |
middleName | reference to string variable where the "middle name" is stored | |
namePrefix | reference to string variable where the "name prefix" is stored | |
nameSuffix | reference to string variable where the "name suffix" is stored | |
pos | index of the element component in case of value multiplicity (0..vm-1) | |
componentGroup | index of the component group (0..2) to be used, see above |
OFCondition DcmPersonName::getFormattedName | ( | OFString & | formattedName, | |
const unsigned long | pos = 0 , |
|||
const unsigned int | componentGroup = 0 | |||
) |
get current element value as a formatted/readable name.
The current element value is expected to be in DICOM PN format as described above. The output format is "[namePrefix][ firstName][ middleName][ lastName][, nameSuffix]"; the delimiters (" " and ", ") are only inserted if required. If this function fails the result variable 'formattedName' is cleared automatically.
formattedName | reference to string variable where the result is stored | |
pos | index of the element component in case of value multiplicity (0..vm-1) | |
componentGroup | index of the component group (0..2) to be used, see above |
OFCondition DcmPersonName::putNameComponents | ( | const OFString & | lastName, | |
const OFString & | firstName, | |||
const OFString & | middleName, | |||
const OFString & | namePrefix, | |||
const OFString & | nameSuffix | |||
) |
put element value from specified name components.
The stored format is "[lastName[^firstName[^middleName[^namePrefix[^nameSuffix]]]]]", i.e. a DICOM Person Name (PN). Component groups are not (yet) supported. If this function fails the currently stored value is not modified.
lastName | reference to string variable where the "last name" is stored | |
firstName | reference to string variable where the "first name" is stored | |
middleName | reference to string variable where the "middle name" is stored | |
namePrefix | reference to string variable where the "name prefix" is stored | |
nameSuffix | reference to string variable where the "name suffix" is stored |
static OFCondition DcmPersonName::getNameComponentsFromString | ( | const OFString & | dicomName, | |
OFString & | lastName, | |||
OFString & | firstName, | |||
OFString & | middleName, | |||
OFString & | namePrefix, | |||
OFString & | nameSuffix, | |||
const unsigned int | componentGroup = 0 | |||
) | [static] |
get name components from specified DICOM person name.
The DICOM PN consists of up to three component groups separated by a "=". The supported format is "[CG0][=CG1][=CG2]" where the brackets enclose optional parts and CG0 is a single-byte character representation, CG1 an ideographic representation, and CG2 a phonetic representation of the name. Each component group may consist of up to five components separated by a "^". The format is "[lastName[^firstName[^middleName[^namePrefix[^nameSuffix]]]]"; each component might be empty. If this function fails the result variables are cleared automatically. If the format is valid but does not comply with the above described scheme ("=" and "^") the full person name is returned in the 'lastName' variable.
dicomName | string value in DICOM PN format to be split into components | |
lastName | reference to string variable where the "last name" is stored | |
firstName | reference to string variable where the "first name" is stored | |
middleName | reference to string variable where the "middle name" is stored | |
namePrefix | reference to string variable where the "name prefix" is stored | |
nameSuffix | reference to string variable where the "name suffix" is stored | |
componentGroup | index of the component group (0..2) to be used, see above |
static OFCondition DcmPersonName::getFormattedNameFromString | ( | const OFString & | dicomName, | |
OFString & | formattedName, | |||
const unsigned int | componentGroup = 0 | |||
) | [static] |
get specified DICOM person name as a formatted/readable name.
The specified 'dicomName' is expected to be in DICOM PN format as described above. The output format is "[namePrefix][ firstName][ middleName][ lastName][, nameSuffix]"; the delimiters (" " and ", ") are only inserted if required. If this function fails the result variable 'formattedName' is cleared automatically.
dicomName | string value in DICOM PN format to be converted to readable format | |
formattedName | reference to string variable where the result is stored | |
componentGroup | index of the component group (0..2) to be used, see above |
static OFCondition DcmPersonName::getFormattedNameFromComponents | ( | const OFString & | lastName, | |
const OFString & | firstName, | |||
const OFString & | middleName, | |||
const OFString & | namePrefix, | |||
const OFString & | nameSuffix, | |||
OFString & | formattedName | |||
) | [static] |
get formatted/readable name from specified name components.
The output format is "[namePrefix][ firstName][ middleName][ lastName][, nameSuffix]"; the delimiters (" " and ", ") are only inserted if required. If this function fails the result variable 'formattedName' is cleared automatically.
lastName | reference to string variable where the "last name" is stored | |
firstName | reference to string variable where the "first name" is stored | |
middleName | reference to string variable where the "middle name" is stored | |
namePrefix | reference to string variable where the "name prefix" is stored | |
nameSuffix | reference to string variable where the "name suffix" is stored | |
formattedName | reference to string variable where the result is stored |
static OFCondition DcmPersonName::getStringFromNameComponents | ( | const OFString & | lastName, | |
const OFString & | firstName, | |||
const OFString & | middleName, | |||
const OFString & | namePrefix, | |||
const OFString & | nameSuffix, | |||
OFString & | dicomName | |||
) | [static] |
get DICOM Person Name (PN) from specified name components.
The output format is "[lastName[^firstName[^middleName[^namePrefix[^nameSuffix]]]]]". Component groups are not (yet) supported. If this function fails the result variable 'dicomName' is cleared automatically.
lastName | reference to string variable where the "last name" is stored | |
firstName | reference to string variable where the "first name" is stored | |
middleName | reference to string variable where the "middle name" is stored | |
namePrefix | reference to string variable where the "name prefix" is stored | |
nameSuffix | reference to string variable where the "name suffix" is stored | |
dicomName | reference to string variable where the result is stored |