a class representing the DICOM value representation 'Unsigned Short' (US) More...

Inheritance diagram for DcmUnsignedShort:

Public Member Functions
	DcmUnsignedShort (const DcmTag &tag, const Uint32 len=0)
	constructor.
	DcmUnsignedShort (const DcmUnsignedShort &old)
	copy constructor
virtual	~DcmUnsignedShort ()
	destructor
DcmUnsignedShort &	operator= (const DcmUnsignedShort &obj)
	assignment operator
virtual DcmObject *	clone () const
	clone method
virtual OFCondition	copyFrom (const DcmObject &rhs)
	Virtual object copying.
virtual DcmEVR	ident () const
	get element type identifier
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
virtual unsigned long	getVM ()
	get value multiplicity
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.
virtual OFCondition	getUint16 (Uint16 &uintVal, const unsigned long pos=0)
	get particular integer value
virtual OFCondition	getUint16Array (Uint16 *&uintVals)
	get reference to stored integer data.
virtual OFCondition	getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
	get particular value as a character string
virtual OFCondition	putUint16 (const Uint16 uintVal, const unsigned long pos=0)
	set particular element value to given integer
virtual OFCondition	putUint16Array (const Uint16 *uintVals, const unsigned long numUints)
	set element value to given integer array data
virtual OFCondition	putString (const char *stringVal)
	set element value from the given character string.
virtual OFCondition	putString (const char *stringVal, const Uint32 stringLen)
	set element value from the given character string.
virtual OFCondition	verify (const OFBool autocorrect=OFFalse)
	check the currently stored element value

Detailed Description

a class representing the DICOM value representation 'Unsigned Short' (US)

Constructor & Destructor Documentation

DcmUnsignedShort::DcmUnsignedShort	(	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

DcmUnsignedShort::DcmUnsignedShort ( const DcmUnsignedShort & old )

copy constructor

Parameters:

old	element to be copied

Member Function Documentation

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

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

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, PN)

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

Reimplemented from DcmElement.

virtual DcmObject* DcmUnsignedShort::clone ( ) const [inline, virtual]

clone method

Returns:: deep copy of this object

Implements DcmObject.

virtual OFCondition DcmUnsignedShort::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 DcmElement.

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

get particular value as a character string

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	not used

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

Reimplemented from DcmElement.

virtual OFCondition DcmUnsignedShort::getUint16	(	Uint16 &	uintVal,
		const unsigned long	pos = `0`
	)		`[virtual]`

get particular integer value

Parameters:

uintVal	reference to result variable (cleared in case of error)
pos	index of the value to be retrieved (0..vm-1)

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

Reimplemented from DcmElement.

virtual OFCondition DcmUnsignedShort::getUint16Array ( Uint16 *& uintVals ) [virtual]

get reference to stored integer data.

The number of entries can be determined by "getVM()".

Parameters:

uintVals reference to result variable

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

Reimplemented from DcmElement.

virtual unsigned long DcmUnsignedShort::getVM ( ) [virtual]

get value multiplicity

Returns:: number of currently stored values

Implements DcmObject.

virtual DcmEVR DcmUnsignedShort::ident ( ) const [virtual]

get element type identifier

Returns:: type identifier of this class (EVR_US)

Implements DcmObject.

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

assignment operator

Parameters:

obj	element to be assigned/copied

Returns:: reference to this object

virtual void DcmUnsignedShort::print	(	STD_NAMESPACE ostream &	out,
		const size_t	flags = `0`,
		const int	level = `0`,
		const char *	pixelFileName = `NULL`,
		size_t *	pixelCounter = `NULL`
	)		`[virtual]`

print element to a stream.

The output format of the value is a backslash separated sequence of numbers.

Parameters:

out	output stream
flags	optional flag used to customize the output (see DCMTypes::PF_xxx)
level	current level of nested items. Used for indentation.
pixelFileName	not used
pixelCounter	not used

Implements DcmObject.

virtual OFCondition DcmUnsignedShort::putString ( const char * stringVal ) [virtual]

set element value from the given character string.

The input string is expected to be a backslash separated sequence of numeric characters, e.g. "1\22\333\4444\55555".

Parameters:

stringVal input character string

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

Reimplemented from DcmElement.

virtual OFCondition DcmUnsignedShort::putString	(	const char *	stringVal,
		const Uint32	stringLen
	)		`[virtual]`

set element value from the given character string.

The input string is expected to be a backslash separated sequence of numeric characters, e.g. "1\22\333\4444\55555". The length of the string has to be specified explicitly. The string can, therefore, also contain more than one NULL byte.

Parameters:

stringVal	input character string
stringLen	length of the string (number of characters without the trailing NULL byte)

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

Reimplemented from DcmElement.

virtual OFCondition DcmUnsignedShort::putUint16	(	const Uint16	uintVal,
		const unsigned long	pos = `0`
	)		`[virtual]`

set particular element value to given integer

Parameters:

uintVal	unsigned integer value to be set
pos	index of the value to be set (0 = first position)

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

Reimplemented from DcmElement.

virtual OFCondition DcmUnsignedShort::putUint16Array	(	const Uint16 *	uintVals,
		const unsigned long	numUints
	)		`[virtual]`

set element value to given integer array data

Parameters:

uintVals	unsigned integer data to be set
numUints	number of integer values to be set

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

Reimplemented from DcmElement.

virtual OFCondition DcmUnsignedShort::verify ( const OFBool autocorrect = OFFalse ) [virtual]

check the currently stored element value

Parameters:

autocorrect correct value length if OFTrue

Returns:: status, EC_Normal if value length is correct, an error code otherwise

Implements DcmObject.

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

dcmdata/include/dcmtk/dcmdata/dcvrus.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation