DCMTK  Version 3.6.7
OFFIS DICOM Toolkit
Public Member Functions | List of all members
I2DOutputPlugSC Class Reference
+ Inheritance diagram for I2DOutputPlugSC:

Public Member Functions

 I2DOutputPlugSC ()
 Constructor, initializes member variables with standard values.
 
virtual ~I2DOutputPlugSC ()
 Virtual Destructor, clean up memory.
 
virtual OFString ident ()
 Virtual function that returns a short name of the plugin. More...
 
virtual void supportedSOPClassUIDs (OFList< OFString > &suppSOPs)
 Overwrites function from base class. More...
 
virtual OFCondition convert (DcmDataset &dataset) const
 Outputs SOP class specific information into dataset. More...
 
virtual OFString isValid (DcmDataset &dataset) const
 Do some completeness / validity checks. More...
 
virtual OFBool supportsMultiframe () const
 check if the output format supported by this plugin can write multi-frame images. More...
 
virtual OFCondition insertMultiFrameAttributes (DcmDataset *targetDataset, size_t numberOfFrames) const
 Add multiframe specific attributes. More...
 
- Public Member Functions inherited from I2DOutputPlug
 I2DOutputPlug ()
 Constructor, initializes member variables.
 
virtual ~I2DOutputPlug ()
 Destructor.
 
virtual void setValidityChecking (OFBool doChecks, OFBool insertMissingType2=OFTrue, OFBool inventMissingType1=OFTrue)
 Enable/Disable basic validity checks for output dataset. More...
 

Additional Inherited Members

- Protected Member Functions inherited from I2DOutputPlug
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. More...
 
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 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. 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 inherited from I2DOutputPlug
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...
 

Member Function Documentation

◆ convert()

virtual OFCondition I2DOutputPlugSC::convert ( DcmDataset dataset) const
virtual

Outputs SOP class specific information into dataset.

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

Implements I2DOutputPlug.

◆ ident()

virtual OFString I2DOutputPlugSC::ident ( )
virtual

Virtual function that returns a short name of the plugin.

Returns
The name of the plugin

Implements I2DOutputPlug.

◆ insertMultiFrameAttributes()

virtual OFCondition I2DOutputPlugSC::insertMultiFrameAttributes ( DcmDataset targetDataset,
size_t  numberOfFrames 
) const
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

Implements I2DOutputPlug.

◆ isValid()

virtual OFString I2DOutputPlugSC::isValid ( DcmDataset dataset) const
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

Implements I2DOutputPlug.

◆ supportedSOPClassUIDs()

virtual void I2DOutputPlugSC::supportedSOPClassUIDs ( OFList< OFString > &  suppSOPs)
virtual

Overwrites function from base class.

Returns the Storage SOP class written by this plugin

Parameters
suppSOPs- [out] List of UIDS representing SOP classes supported by this plugin
Returns
none

Implements I2DOutputPlug.

◆ supportsMultiframe()

virtual OFBool I2DOutputPlugSC::supportsMultiframe ( ) const
virtual

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

Returns
true if multiframe is supported, false otherwise

Implements I2DOutputPlug.


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


Generated on Mon Jun 6 2022 for DCMTK Version 3.6.7 by Doxygen 1.9.1