a class representing the DICOM value representation 'Person Name' (PN) More...

Inheritance diagram for DcmPersonName:

Public Member Functions
	DcmPersonName (const DcmTag &tag, const Uint32 len=0)
	constructor. More...

	DcmPersonName (const DcmPersonName &old)
	copy constructor More...

virtual	~DcmPersonName ()
	destructor

DcmPersonName &	operator= (const DcmPersonName &obj)
	assignment operator More...

virtual DcmObject *	clone () const
	clone method More...

virtual OFCondition	copyFrom (const DcmObject &rhs)
	Virtual object copying. More...

virtual DcmEVR	ident () const
	get element type identifier More...

virtual OFCondition	checkValue (const OFString &vm="1-n", const OFBool oldFormat=OFFalse)
	check whether stored value conforms to the VR and to the specified VM. More...

virtual OFCondition	getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
	get a copy of a particular string component More...

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

OFCondition	getFormattedName (OFString &formattedName, const unsigned long pos=0, const unsigned int componentGroup=0)
	get current element value as a formatted/readable name. More...

OFCondition	putNameComponents (const OFString &lastName, const OFString &firstName, const OFString &middleName, const OFString &namePrefix, const OFString &nameSuffix)
	put element value from specified name components. More...

OFCondition	writeXML (STD_NAMESPACE ostream &out, const size_t flags=0)
	write object in XML format More...

virtual OFCondition	writeJson (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
	write object in JSON format More...

Public Member Functions inherited from DcmCharString
	DcmCharString (const DcmTag &tag, const Uint32 len)
	constructor. More...

	DcmCharString (const DcmCharString &old)
	copy constructor More...

virtual	~DcmCharString ()
	destructor

DcmCharString &	operator= (const DcmCharString &obj)
	assignment operator More...

virtual OFCondition	verify (const OFBool autocorrect=OFFalse)
	check the currently stored string value. More...

virtual OFBool	containsExtendedCharacters (const OFBool checkAllStrings=OFFalse)
	check if this element contains non-ASCII characters. More...

virtual OFBool	isAffectedBySpecificCharacterSet () const
	check if this element is affected by SpecificCharacterSet More...

virtual OFCondition	convertCharacterSet (DcmSpecificCharacterSet &converter)
	convert this element value from the currently selected source character set to the currently selected destination character set More...

virtual OFBool	matches (const OFString &key, const OFString &candidate, const OFBool enableWildCardMatching=OFTrue) const
	perform attribute matching on a single pair of string values. More...

virtual OFBool	isUniversalMatch (const OFBool normalize=OFTrue, const OFBool enableWildCardMatching=OFTrue)
	Determine if this element is universal matching. More...

virtual OFBool	matches (const DcmElement &candidate, const OFBool enableWildCardMatching=OFTrue) const
	perform attribute matching. More...

virtual OFBool	matches (const OFString &key, const OFString &candidate, const OFBool enableWildCardMatching=OFTrue) const
	perform attribute matching on a single pair of string values. More...

Public Member Functions inherited from DcmByteString
	DcmByteString (const DcmTag &tag)
	constructor. More...

	DcmByteString (const DcmByteString &old)
	copy constructor More...

virtual	~DcmByteString ()
	destructor

DcmByteString &	operator= (const DcmByteString &obj)
	assignment operator More...

virtual int	compare (const DcmElement &rhs) const
	comparison operator that compares the normalized value of this object with a given object of the same type. More...

virtual OFCondition	clear ()
	clear the currently stored value More...

virtual unsigned long	getVM ()
	get value multiplicity More...

virtual unsigned long	getNumberOfValues ()
	get number of values stored in this element. More...

Uint32	getRealLength ()
	get length of the stored value. More...

virtual Uint32	getLength (const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=EET_UndefinedLength)
	get DICOM length of the stored value. More...

virtual void	print (STD_NAMESPACE ostream &out, const size_t flags=0, const int level=0, const char pixelFileName=NULL, size_t pixelCounter=NULL)
	print element to a stream. More...

virtual OFCondition	write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
	write data element to a stream More...

virtual OFCondition	writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
	write data element to a stream as required for the creation of digital signatures More...

virtual OFCondition	getOFStringArray (OFString &stringVal, OFBool normalize=OFTrue)
	get entire element value as a character string. More...

virtual OFCondition	getString (char *&stringVal)
	get a pointer to the current string value. More...

virtual OFCondition	getString (char *&stringVal, Uint32 &stringLen)
	get a pointer to the current string value. More...

virtual OFCondition	putString (const char *stringVal)
	set element value from the given character string. More...

virtual OFCondition	putOFStringAtPos (const OFString &stringVal, const unsigned long pos=0)
	set element value at specific VM position in the given character string. More...

virtual OFCondition	putString (const char *stringVal, const Uint32 stringLen)
	set element value from the given character string. More...

virtual OFBool	isEmpty (const OFBool normalize=OFTrue)
	check if this object is empty More...

virtual OFBool	matches (const DcmElement &candidate, const OFBool enableWildCardMatching=OFTrue) const
	perform attribute matching. More...

Public Member Functions inherited from DcmElement
	DcmElement (const DcmTag &tag, const Uint32 len=0)
	constructor. More...

	DcmElement (const DcmElement &old)
	copy constructor More...

virtual	~DcmElement ()
	destructor

DcmElement &	operator= (const DcmElement &obj)
	assignment operator More...

virtual Uint32	calcElementLength (const E_TransferSyntax xfer, const E_EncodingType enctype)
	calculate the length of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences. More...

virtual OFBool	isLeaf () const
	check if this element is a leaf node in a dataset tree. More...

OFBool	valueLoaded () const
	check if value of this element is loaded into main memory More...

virtual void	transferInit ()
	initialize the transfer state of this object. More...

virtual OFBool	canWriteXfer (const E_TransferSyntax newXfer, const E_TransferSyntax oldXfer)
	check if this DICOM object can be encoded in the given transfer syntax. More...

virtual OFCondition	read (DcmInputStream &inStream, const E_TransferSyntax ixfer, const E_GrpLenEncoding glenc=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength)
	This function reads the data value of an attribute which is captured in the input stream and captures this information in this. More...

virtual OFCondition	loadAllDataIntoMemory ()
	this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory. More...

virtual OFCondition	getUint8 (Uint8 &val, const unsigned long pos=0)
	retrieve a single value of type Uint8. More...

virtual OFCondition	getSint16 (Sint16 &val, const unsigned long pos=0)
	retrieve a single value of type Sint16. More...

virtual OFCondition	getUint16 (Uint16 &val, const unsigned long pos=0)
	retrieve a single value of type Uint16. More...

virtual OFCondition	getSint32 (Sint32 &val, const unsigned long pos=0)
	retrieve a single value of type Sint32. More...

virtual OFCondition	getUint32 (Uint32 &val, const unsigned long pos=0)
	retrieve a single value of type Uint32. More...

virtual OFCondition	getFloat32 (Float32 &val, const unsigned long pos=0)
	retrieve a single value of type Float32. More...

virtual OFCondition	getSint64 (Sint64 &val, const unsigned long pos=0)
	retrieve a single value of type Sint64. More...

virtual OFCondition	getUint64 (Uint64 &val, const unsigned long pos=0)
	retrieve a single value of type Uint64. More...

virtual OFCondition	getFloat64 (Float64 &val, const unsigned long pos=0)
	retrieve a single value of type Float64. More...

virtual OFCondition	getTagVal (DcmTagKey &val, const unsigned long pos=0)
	retrieve a single value of type DcmTagKey. More...

virtual OFCondition	getUint8Array (Uint8 *&val)
	get a pointer to the element value of the current element as type string. More...

virtual OFCondition	getSint16Array (Sint16 *&val)
	get a pointer to the element value of the current element as type Sint16. More...

virtual OFCondition	getUint16Array (Uint16 *&val)
	get a pointer to the element value of the current element as type Uint16. More...

virtual OFCondition	getSint32Array (Sint32 *&val)
	get a pointer to the element value of the current element as type Sint32. More...

virtual OFCondition	getUint32Array (Uint32 *&val)
	get a pointer to the element value of the current element as type Uint32. More...

virtual OFCondition	getFloat32Array (Float32 *&val)
	get a pointer to the element value of the current element as type Float32. More...

virtual OFCondition	getSint64Array (Sint64 *&val)
	get a pointer to the element value of the current element as type Sint64. More...

virtual OFCondition	getUint64Array (Uint64 *&val)
	get a pointer to the element value of the current element as type Uint64. More...

virtual OFCondition	getFloat64Array (Float64 *&val)
	get a pointer to the element value of the current element as type Float64. More...

OFCondition	detachValueField (OFBool copy=OFFalse)
	detach the value field from the DICOM element (i.e., this object). More...

virtual OFCondition	putOFStringArray (const OFString &val)
	replace the element value by a copy of the given string (which is possibly multi-valued). More...

virtual OFCondition	putSint16 (const Sint16 val, const unsigned long pos=0)
	insert into the element value a copy of the given Sint16 value. More...

virtual OFCondition	putUint16 (const Uint16 val, const unsigned long pos=0)
	insert into the element value a copy of the given Uint16 value. More...

virtual OFCondition	putSint32 (const Sint32 val, const unsigned long pos=0)
	insert into the element value a copy of the given Sint32 value. More...

virtual OFCondition	putUint32 (const Uint32 val, const unsigned long pos=0)
	insert into the element value a copy of the given Uint32 value. More...

virtual OFCondition	putFloat32 (const Float32 val, const unsigned long pos=0)
	insert into the element value a copy of the given Float32 value. More...

virtual OFCondition	putFloat64 (const Float64 val, const unsigned long pos=0)
	insert into the element value a copy of the given Float64 value. More...

virtual OFCondition	putTagVal (const DcmTagKey &attrTag, const unsigned long pos=0)
	insert into the element value a copy of the given DcmTagKey value. More...

virtual OFCondition	putUint8Array (const Uint8 *vals, const unsigned long num)
	replace the element value by a copy of the given Uint8 array (which is possibly multi-valued). More...

virtual OFCondition	putSint16Array (const Sint16 *vals, const unsigned long num)
	replace the element value by a copy of the given Sint16 array (which is possibly multi-valued). More...

virtual OFCondition	putUint16Array (const Uint16 *vals, const unsigned long num)
	replace the element value by a copy of the given Uint16 array (which is possibly multi-valued). More...

virtual OFCondition	putSint32Array (const Sint32 *vals, const unsigned long num)
	replace the element value by a copy of the given Sint32 array (which is possibly multi-valued). More...

virtual OFCondition	putUint32Array (const Uint32 *vals, const unsigned long num)
	replace the element value by a copy of the given Uint32 array (which is possibly multi-valued). More...

virtual OFCondition	putFloat32Array (const Float32 *vals, const unsigned long num)
	replace the element value by a copy of the given Float32 array (which is possibly multi-valued). More...

virtual OFCondition	putFloat64Array (const Float64 *vals, const unsigned long num)
	replace the element value by a copy of the given Float64 array (which is possibly multi-valued). More...

virtual OFCondition	getPartialValue (void targetBuffer, const Uint32 offset, Uint32 numBytes, DcmFileCache cache=NULL, E_ByteOrder byteOrder=gLocalByteOrder)
	Copy numBytes bytes of data from the attribute value in byteOrder byte order to targetBuffer, starting at byte offset offset of the attribute value. More...

virtual OFCondition	createUint8Array (const Uint32 numBytes, Uint8 *&bytes)
	create an empty Uint8 array of given number of bytes and set it. More...

virtual OFCondition	createUint16Array (const Uint32 numWords, Uint16 *&words)
	create an empty Uint16 array of given number of words and set it. More...

virtual OFCondition	createValueFromTempFile (DcmInputStreamFactory *factory, const Uint32 length, const E_ByteOrder byteOrder)
	replace the attribute value with the content of the given temporary file. More...

virtual void	compact ()
	remove the attribute value from memory if the attribute value can be loaded from file when needed again. More...

virtual OFCondition	getUncompressedFrameSize (DcmItem *dataset, Uint32 &frameSize) const
	compute uncompressed frame size of a single frame of this image. More...

virtual OFCondition	getUncompressedFrame (DcmItem dataset, Uint32 frameNo, Uint32 &startFragment, void buffer, Uint32 bufSize, OFString &decompressedColorModel, DcmFileCache *cache=NULL)
	access single frame without decompressing or loading a complete multi-frame object. More...

virtual OFCondition	getDecompressedColorModel (DcmItem *dataset, OFString &decompressedColorModel)
	determine color model of the decompressed image More...

virtual OFBool	combinationMatches (const DcmElement &keySecond, const DcmElement &candidateFirst, const DcmElement &candidateSecond) const
	perform combined attribute matching. More...

const DcmInputStreamFactory *	getInputStream () const
	returns a pointer to the input stream, if available, NULL otherwise. More...

Public Member Functions inherited from DcmObject
	DcmObject (const DcmTag &tag, const Uint32 len=0)
	constructor. More...

	DcmObject (const DcmObject &obj)
	copy constructor More...

virtual	~DcmObject ()
	destructor

DcmObject &	operator= (const DcmObject &obj)
	copy assignment operator More...

DcmEVR	getVR () const
	return the value representation assigned to this object. More...

OFBool	isaString () const
	check if this element is a string type, based on the VR. More...

virtual OFBool	isNested () const
	check if this element is nested in a sequence of items, i.e. not a top-level or stand-alone element More...

E_TransferState	transferState () const
	return the current transfer (read/write) state of this object. More...

virtual void	transferEnd (void)
	finalize the transfer state of this object. More...

DcmItem *	getRootItem ()
	get root dataset/item (top-level) that contains this object. More...

virtual DcmItem *	getParentItem ()
	get parent item of this object. More...

DcmObject *	getParent ()
	get parent of this object. More...

const DcmObject *	getParent () const
	get parent of this object. More...

void	setParent (DcmObject *parent)
	set parent of this object. More...

Uint16	getGTag () const
	return the group number of the attribute tag for this object More...

Uint16	getETag () const
	return the element number of the attribute tag for this object More...

const DcmTag &	getTag () const
	return const reference to the attribute tag for this object More...

void	setGTag (Uint16 gtag)
	assign group tag (but not element tag) of the attribute tag for this object. More...

virtual OFCondition	setVR (DcmEVR vr)
	assign a new Value Representation (VR) to this object. More...

virtual OFBool	isSignable () const
	returns true if the current object may be included in a digital signature More...

virtual OFBool	containsUnknownVR () const
	returns true if the object contains an element with Unknown VR at any nesting level More...

virtual DcmObject *	nextInContainer (const DcmObject *obj)
	this method is only used in container classes derived from this class, that is, DcmItem and DcmSequenceOfItems. More...

virtual OFCondition	nextObject (DcmStack &stack, const OFBool intoSub)
	this method enables a stack based, depth-first traversal of a complete hierarchical DICOM dataset (that is, classes derived from DcmItem or DcmSequenceOfItems). More...

virtual OFCondition	search (const DcmTagKey &xtag, DcmStack &resultStack, E_SearchMode mode=ESM_fromHere, OFBool searchIntoSub=OFTrue)
	a complex, stack-based, hierarchical search method. More...

Uint32	getLengthField () const
	return the current value of the Length field (which is different from the functionality of the public getLength() method). More...

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

static OFCondition	getComponentGroup (const OFString &allCmpGroups, const unsigned int groupNo, OFString &cmpGroup)
	get single component group from specified DICOM person name. More...

static OFCondition	getFormattedNameFromString (const OFString &dicomName, OFString &formattedName, const unsigned int componentGroup=0)
	get specified DICOM person name as a formatted/readable name. More...

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

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

static OFCondition	checkStringValue (const OFString &value, const OFString &vm="1-n", const OFString &charset="")
	check whether given string value conforms to the VR "PN" (Person Name) and to the specified VM. More...

Static Public Member Functions inherited from DcmElement
static int	scanValue (const OFString &value, const OFString &vr, const size_t pos=0, const size_t num=OFString_npos)
	scan string value for conformance with given value representation (VR) More...

static int	scanValue (const OFString &vr, const char *const value, const size_t size)
	scan string value for conformance with given value representation (VR) More...

static unsigned long	determineVM (const char *str, const size_t len)
	determine the number of values stored in a string, i.e. the value multiplicity (VM) More...

static size_t	getValueFromString (const char *str, const size_t pos, const size_t len, OFString &val)
	get the first value stored in the given string. More...

static OFCondition	checkVM (const unsigned long vmNum, const OFString &vmStr)
	check for correct value multiplicity (VM) More...

Static Private Attributes
static const char *const	componentGroupNames [3]
	an array containing the component group names, for XML and JSON output.

Additional Inherited Members
Protected Types inherited from DcmByteString
enum	E_StringMode { DCM_MachineString , DCM_DicomString , DCM_UnknownString }
	internal type used to specify the current string representation More...

Protected Member Functions inherited from DcmCharString
OFCondition	getSpecificCharacterSet (OFString &charset)
	get value of the SpecificCharacterSet element of the surrounding dataset/item More...

virtual const OFString &	getDelimiterChars () const
	get delimiter characters specifying when to switch back to the default character set (in case code extension techniques like ISO 2022 are used). More...

Protected Member Functions inherited from DcmByteString
	DcmByteString (const DcmTag &tag, const Uint32 len)
	constructor. More...

virtual Uint8 *	newValueField ()
	create a new value field (string buffer) of the previously defined size (member variable 'Length'). More...

virtual void	postLoadValue ()
	method is called after the element value has been loaded. More...

E_StringMode	getStringMode () const
	get current representation of the string value More...

virtual OFCondition	makeMachineByteString (const Uint32 length=0)
	convert currently stored string value to internal representation. More...

OFCondition	makeDicomByteString ()
	convert currently stored string value to DICOM representation. More...

OFCondition	getStringValue (OFString &stringVal)
	get a copy of the current string value. More...

Uint32	getMaxLength () const
	get the maximum number of characters for each string component More...

char	getPaddingChar () const
	get the end-of-string padding character More...

void	setPaddingChar (char c)
	set the end-of-string padding character More...

void	setMaxLength (Uint32 val)
	set the maximum number of characters for each string component More...

void	setNonSignificantChars (const OFString &characters)
	set non-significant characters used to determine whether the value is empty More...

Protected Member Functions inherited from DcmElement
void *	getValue (const E_ByteOrder newByteOrder=gLocalByteOrder)
	This function returns this element's value. More...

OFCondition	changeValue (const void *value, const Uint32 position, const Uint32 num)
	insert into the element value a copy of the given raw value. More...

OFCondition	putValue (const void *value, const Uint32 length)
	replace the element value by a copy of the given raw data block More...

OFCondition	createEmptyValue (const Uint32 length)
	create a new, empty value field of given size. More...

OFCondition	loadValue (DcmInputStream *inStream=NULL)
	This function reads the data value of an attribute and stores the information which was read in this. More...

void	swapValueField (size_t valueWidth)
	swaps the content of the value field (if loaded) from big-endian to little-endian or back More...

virtual void	writeXMLStartTag (STD_NAMESPACE ostream &out, const size_t flags, const char *attrText=NULL)
	write element start tag in XML format More...

virtual void	writeXMLEndTag (STD_NAMESPACE ostream &out, const size_t flags)
	write element end tag in XML format More...

virtual void	writeJsonOpener (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
	write element start tag in JSON format More...

virtual void	writeJsonCloser (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
	write element end tag in JSON format More...

E_ByteOrder	getByteOrder () const
	return the current byte order of the value field More...

void	setByteOrder (E_ByteOrder val)
	set the current byte order of the value field More...

Protected Member Functions inherited from DcmObject
void	printNestingLevel (STD_NAMESPACE ostream &out, const size_t flags, const int level)
	print line indentation, e.g. a couple of spaces for each nesting level. More...

void	printInfoLineStart (STD_NAMESPACE ostream &out, const size_t flags, const int level, DcmTag *tag=NULL)
	print beginning of the info line. More...

void	printInfoLineEnd (STD_NAMESPACE ostream &out, const size_t flags, const unsigned long printedLength=0xffffffff, DcmTag *tag=NULL)
	print end of the info line. More...

virtual void	printInfoLine (STD_NAMESPACE ostream &out, const size_t flags, const int level=0, const char info=NULL, DcmTag tag=NULL, const OFBool isInfo=OFTrue)
	print given text with element information. More...

virtual OFCondition	writeTagAndLength (DcmOutputStream &outStream, const E_TransferSyntax oxfer, Uint32 &writtenBytes) const
	write tag, VR and length field to the given output stream More...

virtual Uint32	getTagAndLengthSize (const E_TransferSyntax oxfer) const
	return the number of bytes needed to serialize the tag, VR and length information of the current object using the given transfer syntax. More...

const char *	getTagName ()
	return the DICOM attribute tag name for this object. More...

void	setTagVR (DcmEVR vr)
	set the VR for this attribute More...

E_TransferState	getTransferState () const
	return the current transfer state of this object during serialization/deserialization More...

void	setTransferState (E_TransferState newState)
	set the current transfer state of this object during serialization/deserialization More...

Uint32	getTransferredBytes () const
	return the number of transferred bytes for this object during serialization/deserialization More...

void	setTransferredBytes (Uint32 val)
	set the number of transferred bytes for this object during serialization/deserialization More...

void	incTransferredBytes (Uint32 val)
	add to the number of transferred bytes for this object during serialization/deserialization More...

void	setLengthField (Uint32 val)
	set the current value of the Length field More...

Static Protected Member Functions inherited from DcmByteString
static OFBool	containsExtendedCharacters (const char *stringVal, const size_t stringLen)
	check if a given character string contains non-ASCII characters. More...

static OFCondition	checkStringValue (const OFString &value, const OFString &vm, const OFString &vr, const int vrID, const size_t maxLen=0, const OFString &charset="")
	check whether given string value conforms to a certain VR and VM. More...

Static Protected Member Functions inherited from DcmObject
static OFCondition	writeTag (DcmOutputStream &outStream, const DcmTag &tag, const E_TransferSyntax oxfer)
	static helper function that writes a given attribute tag to a binary output stream using the byte order indicated by the transfer syntax. More...

Protected Attributes inherited from DcmObject
OFCondition	errorFlag
	error flag for this object.

Detailed Description

a class representing the DICOM value representation 'Person Name' (PN)

Constructor & Destructor Documentation

◆ DcmPersonName() [1/2]

DcmPersonName::DcmPersonName	(	const DcmTag &	tag,
		const Uint32	len = `0`
	)

constructor.

Create new element from given tag and length.

Parameters

tag	DICOM tag for the new element
len	value length for the new element

◆ DcmPersonName() [2/2]

DcmPersonName::DcmPersonName ( const DcmPersonName & old )

copy constructor

Parameters

old	element to be copied

Member Function Documentation

◆ checkStringValue()

static OFCondition DcmPersonName::checkStringValue	(	const OFString &	value,
		const OFString &	vm = `"1-n"`,
		const OFString &	charset = `""`
	)

static

check whether given string value conforms to the VR "PN" (Person Name) and to the specified VM.

Parameters

value	string value to be checked (possibly multi-valued)
vm	value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.)
charset	character set (according to the value of the SpecificCharacterSet element) to be used for checking the string value. The default is ASCII (7-bit). Currently, the VR checker only supports ASCII (ISO_IR 6) and Latin-1 (ISO_IR 100). All other values disable the check of the value representation, e.g. "UNKNOWN".

Returns: status of the check, EC_Normal if value is correct, an error code otherwise

◆ checkValue()

virtual OFCondition DcmPersonName::checkValue	(	const OFString &	vm = `"1-n"`,
		const OFBool	oldFormat = `OFFalse`
	)

virtual

check whether stored value conforms to the VR and to the specified VM.

Currently, the VR checker only supports ASCII (ISO_IR 6) and Latin-1 (ISO_IR 100). All other specific character sets disable the check of the value representation.

Parameters

vm	value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.)
oldFormat	parameter not used for this VR (only for DA, TM)

Returns: status of the check, EC_Normal if value is correct, an error code otherwise

Reimplemented from DcmElement.

◆ clone()

virtual DcmObject* DcmPersonName::clone ( ) const

inlinevirtual

clone method

Returns: deep copy of this object

Reimplemented from DcmCharString.

◆ copyFrom()

virtual OFCondition DcmPersonName::copyFrom ( const DcmObject & rhs )

virtual

Virtual object copying.

This method can be used for DcmObject and derived classes to get a deep copy of an object. Internally the assignment operator is called if the given DcmObject parameter is of the same type as "this" object instance. If not, an error is returned. This function permits copying an object by value in a virtual way which therefore is different to just calling the assignment operator of DcmElement which could result in slicing the object.

Parameters

rhs	- [in] The instance to copy from. Has to be of the same class type as "this" object

Returns: EC_Normal if copying was successful, error otherwise

Reimplemented from DcmCharString.

◆ getComponentGroup()

static OFCondition DcmPersonName::getComponentGroup	(	const OFString &	allCmpGroups,
		const unsigned int	groupNo,
		OFString &	cmpGroup
	)

static

get single component group 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 an alphabetic representation, CG1 an ideographic representation, and CG2 a phonetic representation of the name. Each component group might be empty. The returned component group will contain component delimiters ("^") as they are stored within the very component group, i.e. superfluous component delimiters are not removed.

Parameters

allCmpGroups	string value in DICOM PN format to component group from
groupNo	index of the component group (0..2) to be extracted
cmpGroup	reference to string variable where selected component group shall be stored

Returns: EC_Normal upon success, an error code otherwise. Especially, if a component group exists (always for group 0, for group 1 and 2 depending on whether corresponding "=" is present) and is empty, EC_Normal is returned.

◆ getFormattedName()

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.

Parameters

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

Returns: EC_Normal upon success, an error code otherwise

◆ getFormattedNameFromComponents()

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.

Parameters

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

Returns: always returns EC_Normal

◆ getFormattedNameFromString()

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.

Parameters

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

Returns: EC_Normal upon success, an error code otherwise

◆ getNameComponents()

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 an alphabetic 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 group and 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.

Parameters

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

Returns: EC_Normal upon success, an error code otherwise

◆ getNameComponentsFromString()

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 an alphabetic 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 group and 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.

Parameters

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

Returns: EC_Normal upon success, an error code otherwise

◆ getOFString()

virtual OFCondition DcmPersonName::getOFString	(	OFString &	stringVal,
		const unsigned long	pos,
		OFBool	normalize = `OFTrue`
	)

virtual

get a copy of a particular string component

Parameters

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

Returns: status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmByteString.

◆ getStringFromNameComponents()

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.

Parameters

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

Returns: always returns EC_Normal

◆ ident()

virtual DcmEVR DcmPersonName::ident ( ) const

virtual

get element type identifier

Returns: type identifier of this class (EVR_PN)

Reimplemented from DcmByteString.

◆ operator=()

DcmPersonName& DcmPersonName::operator= ( const DcmPersonName & obj )

assignment operator

Parameters

obj	element to be assigned/copied

Returns: reference to this object

◆ putNameComponents()

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.

Parameters

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

Returns: EC_Normal upon success, an error code otherwise

◆ writeJson()

virtual OFCondition DcmPersonName::writeJson	(	STD_NAMESPACE ostream &	out,
		DcmJsonFormat &	format
	)

virtual

write object in JSON format

Parameters

out	output stream to which the JSON document is written
format	used to format and customize the output

Returns: status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmCharString.

◆ writeXML()

OFCondition DcmPersonName::writeXML	(	STD_NAMESPACE ostream &	out,
		const size_t	flags = `0`
	)

virtual

write object in XML format

Parameters

out	output stream to which the XML document is written
flags	optional flag used to customize the output (see DCMTypes::XF_xxx)

Returns: status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

The documentation for this class was generated from the following file:

dcmdata/include/dcmtk/dcmdata/dcvrpn.h

Public Member Functions

Static Public Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DcmPersonName() [1/2]

◆ DcmPersonName() [2/2]

Member Function Documentation

◆ checkStringValue()

◆ checkValue()

◆ clone()

◆ copyFrom()

◆ getComponentGroup()

◆ getFormattedName()

◆ getFormattedNameFromComponents()

◆ getFormattedNameFromString()

◆ getNameComponents()

◆ getNameComponentsFromString()

◆ getOFString()

◆ getStringFromNameComponents()

◆ ident()

◆ operator=()

◆ putNameComponents()

◆ writeJson()

◆ writeXML()