DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
I2DOutputPlug Class Referenceabstract
+ Inheritance diagram for I2DOutputPlug:

Public Member Functions

 I2DOutputPlug ()
 Constructor, initializes member variables. More...
 
virtual OFString ident ()=0
 Virtual function that returns a short name of the plugin. More...
 
virtual void supportedSOPClassUIDs (OFList< OFString > &suppSOPs)=0
 Virtual function that returns the Storage SOP class UID, the plugin writes. More...
 
virtual OFCondition convert (DcmDataset &dataset) const =0
 Outputs SOP class specific information into dataset. More...
 
virtual OFString isValid (DcmDataset &dataset) const =0
 Do some completeness / validity checks. More...
 
virtual ~I2DOutputPlug ()
 Destructor. More...
 
virtual void setValidityChecking (OFBool doChecks, OFBool insertMissingType2=OFTrue, OFBool inventMissingType1=OFTrue)
 Enable/Disable basic validity checks for output dataset. More...
 

Protected Member Functions

virtual OFString checkAndInventType1Attrib (const DcmTagKey &key, DcmDataset *targetDset, const OFString &defaultValue="") const
 Checks whether a given tag exists in a dataset and provides a non-empty value. More...
 
virtual OFString checkAndInventType2Attrib (const DcmTagKey &key, DcmDataset *targetDset, const OFString &defaultValue="") const
 Checks whether a given tag exists in a dataset (can be empty) If not, the tag is inserted (if enabled) with empty value. More...
 

Protected Attributes

OFBool m_doAttribChecking
 if enabled, some simple attribute checking is performed default: enabled (OFTrue)
 
OFBool m_inventMissingType2Attribs
 if enabled, missing type 2 attributes in the dataset are added automatically. More...
 
OFBool m_inventMissingType1Attribs
 if enbled, missing type 1 attributes are inserted and filled with a predefined value. More...
 

Constructor & Destructor Documentation

I2DOutputPlug::I2DOutputPlug ( )
inline

Constructor, initializes member variables.

Returns
none
virtual I2DOutputPlug::~I2DOutputPlug ( )
inlinevirtual

Destructor.

Returns
none

Member Function Documentation

virtual OFString I2DOutputPlug::checkAndInventType1Attrib ( const DcmTagKey key,
DcmDataset targetDset,
const OFString defaultValue = "" 
) const
inlineprotectedvirtual

Checks whether a given tag exists in a dataset and provides a non-empty value.

If not, the tag is inserted (if enabled) and a default value is inserted.

Parameters
key- [in] The tag to be checked/inserted
targetDset- [in/out] The dataset to search (and insert) in
defaultValue- [in] The default value to set
Returns
Error string, which is empty if no error occurs.

References OFCondition::bad(), DcmItem::findAndGetElement(), DcmElement::getLength(), DcmTag::getTagName(), OFCondition::good(), DcmItem::insert(), DcmItem::newDicomElement(), DcmElement::putString(), and DcmItem::tagExists().

virtual OFString I2DOutputPlug::checkAndInventType2Attrib ( const DcmTagKey key,
DcmDataset targetDset,
const OFString defaultValue = "" 
) const
inlineprotectedvirtual

Checks whether a given tag exists in a dataset (can be empty) If not, the tag is inserted (if enabled) with empty value.

Parameters
key- [in] The tag to be checked/inserted
targetDset- [in/out] The dataset to search (and insert) in
Returns
Error string, which is empty if no error occurs.

References DcmTag::getTagName(), OFCondition::good(), DcmItem::insert(), DcmItem::newDicomElement(), DcmElement::putString(), and DcmItem::tagExists().

virtual OFCondition I2DOutputPlug::convert ( DcmDataset dataset) const
pure virtual

Outputs SOP class specific information into dataset.

Parameters
dataset- [in/out] Dataset to write to
Returns
EC_Normal if successful, error otherwise

Implemented in I2DOutputPlugNewSC, I2DOutputPlugSC, and I2DOutputPlugVLP.

virtual OFString I2DOutputPlug::ident ( )
pure virtual

Virtual function that returns a short name of the plugin.

Returns
The name of the plugin

Implemented in I2DOutputPlugNewSC, I2DOutputPlugSC, and I2DOutputPlugVLP.

virtual OFString I2DOutputPlug::isValid ( DcmDataset dataset) const
pure virtual

Do some completeness / validity checks.

Should be called when dataset is completed and is about to be saved.

Parameters
dataset- [in] The dataset to check
Returns
Error string if error occurs, empty string otherwise

Implemented in I2DOutputPlugNewSC, I2DOutputPlugSC, and I2DOutputPlugVLP.

virtual void I2DOutputPlug::setValidityChecking ( OFBool  doChecks,
OFBool  insertMissingType2 = OFTrue,
OFBool  inventMissingType1 = OFTrue 
)
inlinevirtual

Enable/Disable basic validity checks for output dataset.

Parameters
doChecks- [in] OFTrue enables checking, OFFalse turns it off.
insertMissingType2- [in] If true (default), missing type 2 attributes are inserted automatically
inventMissingType1- [in] If true (default), missing type 1 attributes are inserted automatically with a predefined value (if possible). An existing empty type 1 attribute is assigned a value, too.
Returns
none
virtual void I2DOutputPlug::supportedSOPClassUIDs ( OFList< OFString > &  suppSOPs)
pure virtual

Virtual function that returns the Storage SOP class UID, the plugin writes.

Parameters
suppSOPs- [out] List containing supported output SOP classes
Returns
String containing the Storage SOP class UID

Implemented in I2DOutputPlugNewSC, I2DOutputPlugSC, and I2DOutputPlugVLP.

Member Data Documentation

OFBool I2DOutputPlug::m_inventMissingType1Attribs
protected

if enbled, missing type 1 attributes are inserted and filled with a predefined value.

Default: disabled (OFFalse)

OFBool I2DOutputPlug::m_inventMissingType2Attribs
protected

if enabled, missing type 2 attributes in the dataset are added automatically.

default: enabled (OFTrue)


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