DCMTK Version 3.6.7
OFFIS DICOM Toolkit
Loading...
Searching...
No Matches
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.
 
virtual ~I2DOutputPlug ()
 Destructor.
 
virtual OFString ident ()=0
 Virtual function that returns a short name of the plugin.
 
virtual void supportedSOPClassUIDs (OFList< OFString > &suppSOPs)=0
 Virtual function that returns the Storage SOP class UID, the plugin writes.
 
virtual OFCondition convert (DcmDataset &dataset) const =0
 Outputs SOP class specific information into dataset.
 
virtual OFString isValid (DcmDataset &dataset) const =0
 Do some completeness / validity checks.
 
virtual OFBool supportsMultiframe () const =0
 check if the output format supported by this plugin can write multi-frame images.
 
virtual OFCondition insertMultiFrameAttributes (DcmDataset *targetDataset, size_t numberOfFrames) const =0
 Add multiframe specific attributes.
 
virtual void setValidityChecking (OFBool doChecks, OFBool insertMissingType2=OFTrue, OFBool inventMissingType1=OFTrue)
 Enable/Disable basic validity checks for output dataset.
 

Protected Member Functions

virtual OFString checkType1Attrib (const DcmTagKey &key, DcmDataset *targetDset) const
 Checks whether a given tag exists in a dataset and is non-empty, otherwise returns an error string.
 
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.
 
virtual OFString checkAndInventType1CodeSQ (const DcmTagKey &key, DcmDataset *targetDset, const OFString &codeValue, const OFString &codeMeaning, const OFString &codingSchemeDesignator) const
 Checks whether a given code sequence exists in a dataset and contains an item with the required attributes.
 
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.
 

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.
 
OFBool m_inventMissingType1Attribs
 if enbled, missing type 1 attributes are inserted and filled with a predefined value.
 

Member Function Documentation

◆ checkAndInventType1Attrib()

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

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.

◆ checkAndInventType1CodeSQ()

virtual OFString I2DOutputPlug::checkAndInventType1CodeSQ ( const DcmTagKey key,
DcmDataset targetDset,
const OFString codeValue,
const OFString codeMeaning,
const OFString codingSchemeDesignator 
) const
protectedvirtual

Checks whether a given code sequence exists in a dataset and contains an item with the required attributes.

If not, the sequence is inserted (if enabled) and default values are inserted.

Parameters
key- [in] The code sequence 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.

◆ checkAndInventType2Attrib()

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

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.

◆ checkType1Attrib()

virtual OFString I2DOutputPlug::checkType1Attrib ( const DcmTagKey key,
DcmDataset targetDset 
) const
protectedvirtual

Checks whether a given tag exists in a dataset and is non-empty, otherwise returns an error string.

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.

◆ convert()

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, I2DOutputPlugOphthalmicPhotography, I2DOutputPlugSC, and I2DOutputPlugVLP.

◆ ident()

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, I2DOutputPlugOphthalmicPhotography, I2DOutputPlugSC, and I2DOutputPlugVLP.

◆ insertMultiFrameAttributes()

virtual OFCondition I2DOutputPlug::insertMultiFrameAttributes ( DcmDataset targetDataset,
size_t  numberOfFrames 
) const
pure virtual

Add multiframe specific attributes.

Parameters
datsetpointer to DICOM dataset, must not be NULL
numberOfFramesnumber of frames in this dataset
Returns
EC_Normal if successful, an error code otherwise

Implemented in I2DOutputPlugNewSC, I2DOutputPlugOphthalmicPhotography, I2DOutputPlugSC, and I2DOutputPlugVLP.

◆ isValid()

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, I2DOutputPlugOphthalmicPhotography, I2DOutputPlugSC, and I2DOutputPlugVLP.

◆ setValidityChecking()

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

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

◆ supportedSOPClassUIDs()

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, I2DOutputPlugOphthalmicPhotography, I2DOutputPlugSC, and I2DOutputPlugVLP.

◆ supportsMultiframe()

virtual OFBool I2DOutputPlug::supportsMultiframe ( ) const
pure virtual

check if the output format supported by this plugin can write multi-frame images.

Returns
true if multiframe is supported, false otherwise

Implemented in I2DOutputPlugNewSC, I2DOutputPlugOphthalmicPhotography, I2DOutputPlugSC, and I2DOutputPlugVLP.

Member Data Documentation

◆ m_inventMissingType1Attribs

OFBool I2DOutputPlug::m_inventMissingType1Attribs
protected

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

Default: disabled (OFFalse)

◆ m_inventMissingType2Attribs

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 Mon Apr 15 2024 for DCMTK Version 3.6.7 by Doxygen 1.9.8