DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Static Public Member Functions | List of all members
DVPSHelper Class Reference

this class contains a collection of static helper methods. More...

Static Public Member Functions

static OFCondition loadFileFormat (const char *filename, DcmFileFormat *&fileformat)
 helper function which loads a DICOM file and returns a pointer to a DcmFileFormat object if loading succeeds. More...
 
static OFCondition saveFileFormat (const char *filename, DcmFileFormat *fileformat, OFBool explicitVR)
 helper function which saves a DICOM object to file. More...
 
static OFCondition putStringValue (DcmItem *item, DcmTagKey tag, const char *value=NULL)
 helper function that inserts a new element into a DICOM dataset. More...
 
static OFCondition putUint16Value (DcmItem *item, DcmTagKey tag, Uint16 value)
 helper function that inserts a new element into a DICOM dataset. More...
 
static void cleanChildren ()
 helper function that cleans up pending processes under Unix. More...
 
static void currentDate (OFString &str)
 helper function that writes the current date in DICOM format (YYYYMMDD) More...
 
static void currentTime (OFString &str)
 helper function that writes the current time in DICOM format (HHMMSS) More...
 
static void setDefault (OFCondition &result, DcmElement &a_name, const char *a_value)
 assigns the given value to the given DICOM element if it is empty and the status is OK, returns new status. More...
 
static OFBool haveReferencedUIDItem (DcmSequenceOfItems &seq, const char *uid)
 static helper method that checks whether the given sequence contains an item with a ReferencedSOPClassUID element that matches the given UID string. More...
 
static OFCondition addReferencedUIDItem (DcmSequenceOfItems &seq, const char *uid)
 static helper method that adds an item to the given sequence. More...
 

Detailed Description

this class contains a collection of static helper methods.

Member Function Documentation

static OFCondition DVPSHelper::addReferencedUIDItem ( DcmSequenceOfItems seq,
const char *  uid 
)
static

static helper method that adds an item to the given sequence.

The item contains a ReferencedSOPClassUID element with the given UID string as value.

Parameters
seqsequence to be added to, should be a PrintManagementCapabilitiesSequence.
uidUID string, must not be NULL
Returns
EC_Normal if successful, an error code otherwise.
static void DVPSHelper::cleanChildren ( )
static

helper function that cleans up pending processes under Unix.

No function if used on Windows.

static void DVPSHelper::currentDate ( OFString str)
static

helper function that writes the current date in DICOM format (YYYYMMDD)

Parameters
strcurrent date is written to this string
static void DVPSHelper::currentTime ( OFString str)
static

helper function that writes the current time in DICOM format (HHMMSS)

Parameters
strcurrent time is written to this string
static OFBool DVPSHelper::haveReferencedUIDItem ( DcmSequenceOfItems seq,
const char *  uid 
)
static

static helper method that checks whether the given sequence contains an item with a ReferencedSOPClassUID element that matches the given UID string.

Parameters
seqsequence to be searched, should be a PrintManagementCapabilitiesSequence.
uidUID string
Returns
OFTrue if found, OFFalse otherwise. Returns OFFalse if uid is NULL.
static OFCondition DVPSHelper::loadFileFormat ( const char *  filename,
DcmFileFormat *&  fileformat 
)
static

helper function which loads a DICOM file and returns a pointer to a DcmFileFormat object if loading succeeds.

Parameters
filenamename of DICOM file to be loaded
fileformatpointer to DcmFileFormat object passed back here
Returns
EC_Normal upon success, an error code otherwise.
static OFCondition DVPSHelper::putStringValue ( DcmItem item,
DcmTagKey  tag,
const char *  value = NULL 
)
static

helper function that inserts a new element into a DICOM dataset.

A new DICOM element of the type determined by the tag is created. The string value (if any) is assigned and the element is inserted into the dataset. Only tags corresponding to string VRs may be passed.

Parameters
itemthe dataset into which the new element is inserted
tagthe tag key of the new DICOM element, must have string VR.
valuethe value to be inserted. If omitted, an empty element is created.
Returns
EC_Normal upon success, an error code otherwise.
static OFCondition DVPSHelper::putUint16Value ( DcmItem item,
DcmTagKey  tag,
Uint16  value 
)
static

helper function that inserts a new element into a DICOM dataset.

A new DICOM element of type "US" is created, the value is assigned and the element is inserted into the dataset.

Parameters
itemthe dataset into which the new element is inserted
tagthe tag key of the new DICOM element, must have "US" VR.
valuethe value to be inserted.
Returns
EC_Normal upon success, an error code otherwise.
static OFCondition DVPSHelper::saveFileFormat ( const char *  filename,
DcmFileFormat fileformat,
OFBool  explicitVR 
)
static

helper function which saves a DICOM object to file.

Parameters
filenamename of DICOM file to be created
fileformatDICOM object to be saved
explicitVRselects the transfer syntax to be written. True selects Explicit VR Little Endian, False selects Implicit VR Little Endian.
Returns
EC_Normal upon success, an error code otherwise.
static void DVPSHelper::setDefault ( OFCondition result,
DcmElement a_name,
const char *  a_value 
)
static

assigns the given value to the given DICOM element if it is empty and the status is OK, returns new status.

Parameters
resultstatus in/out
a_nameDICOM element to be set
a_valuenew value, must not be NULL.

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


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8