DcmSignedShort Class Reference

a class representing the DICOM value representation 'Signed Short' (SS) More...

Inheritance diagram for DcmSignedShort:

DcmElement DcmObject List of all members.

Public Member Functions

 DcmSignedShort (const DcmTag &tag, const Uint32 len=0)
 constructor.
 DcmSignedShort (const DcmSignedShort &old)
 copy constructor
virtual ~DcmSignedShort ()
 destructor
DcmSignedShort & operator= (const DcmSignedShort &obj)
 assignment operator
virtual DcmObject * clone () const
 clone method
virtual DcmEVR ident () const
 get element type identifier
virtual unsigned long getVM ()
 get value multiplicity.
virtual void print (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 getSint16 (Sint16 &sintVal, const unsigned long pos=0)
 get particular integer value
virtual OFCondition getSint16Array (Sint16 *&sintVals)
 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 putSint16 (const Sint16 sintVal, const unsigned long pos=0)
 set particular element value to given integer
virtual OFCondition putSint16Array (const Sint16 *sintVals, const unsigned long numSints)
 set element value to given integer array data
virtual OFCondition putString (const char *stringVal)
 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 'Signed Short' (SS)

Definition at line 45 of file dcvrss.h.

Constructor & Destructor Documentation

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

Referenced by clone().

DcmSignedShort::DcmSignedShort ( const DcmSignedShort &  old  ) 

copy constructor

Parameters:
old element to be copied

Member Function Documentation

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

assignment operator

Parameters:
obj element to be assigned/copied
Returns:
reference to this object

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

clone method

Returns:
deep copy of this object

Implements DcmObject.

Definition at line 77 of file dcvrss.h.

References DcmSignedShort().

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

get element type identifier

Returns:
type identifier of this class (EVR_SS)

Implements DcmObject.

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

get value multiplicity.

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

Returns:
number of currently stored values

Implements DcmObject.

virtual void DcmSignedShort::print ( 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 DcmSignedShort::getSint16 ( Sint16 &  sintVal,
const unsigned long  pos = 0 
) [virtual]

get particular integer value

Parameters:
sintVal 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 DcmSignedShort::getSint16Array ( Sint16 *&  sintVals  )  [virtual]

get reference to stored integer data

Parameters:
sintVals reference to result variable
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmSignedShort::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 DcmSignedShort::putSint16 ( const Sint16  sintVal,
const unsigned long  pos = 0 
) [virtual]

set particular element value to given integer

Parameters:
sintVal signed 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 DcmSignedShort::putSint16Array ( const Sint16 *  sintVals,
const unsigned long  numSints 
) [virtual]

set element value to given integer array data

Parameters:
sintVals signed integer data to be set
numSints number of integer values to be set
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmSignedShort::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. "-333\-22\-1\0\1\22\333".

Parameters:
stringVal input character string
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmSignedShort::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:

Generated on 23 Jul 2007 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.5.2