MeVisLab Toolbox Reference
ml::PrivateDICOMTagDecoder Class Reference

Class decoding all private DICOM tags it finds decoders for to a PrivateDICOMTagValueFields container. More...

#include <mlPrivateDICOMTagDecoder.h>

Public Member Functions

 PrivateDICOMTagDecoder (PrivateDICOMTagDecoderPluginBase::PrivateCreatorIdMap *privateCreatorMap=nullptr)
 Creates a list of decoders decoder for private DICOM tags by collecting all available registered DICOM tags decoders in the runtime type system. More...
 
virtual ~PrivateDICOMTagDecoder ()
 Destroys the decoder and the list of internally created decoder instances. More...
 
virtual PrivateDICOMTagDecoderPluginBase::DecodeStates decodePrivateTag (const std::string &privateCreator, DCMTree::Const_TagPtr tagPtr, PrivateDICOMTagValueFields &resultFields)
 Function trying to decode the content of a private tag tagPtr to a list of values which are appended to the cleared PrivateDICOMTagValueFields container resultFields. More...
 
PrivateDICOMTagDecoderPluginBase::PrivateCreatorIdMapgetPrivateCreatorMap () const
 Return the pointer to the map of known private creators or NULL. More...
 
void setPrivateCreatorMap (PrivateDICOMTagDecoderPluginBase::PrivateCreatorIdMap *pcm)
 Sets the pointer to the map which stores a set of known private creators, typically from the currently traversed DICOM (sub)tree. More...
 

Protected Attributes

std::list< PrivateDICOMTagDecoderPluginBase * > _decoderList
 List of tag decoder instances who have been found via the runtime type system. More...
 

Detailed Description

Class decoding all private DICOM tags it finds decoders for to a PrivateDICOMTagValueFields container.

Definition at line 32 of file mlPrivateDICOMTagDecoder.h.

Constructor & Destructor Documentation

◆ PrivateDICOMTagDecoder()

ml::PrivateDICOMTagDecoder::PrivateDICOMTagDecoder ( PrivateDICOMTagDecoderPluginBase::PrivateCreatorIdMap privateCreatorMap = nullptr)

Creates a list of decoders decoder for private DICOM tags by collecting all available registered DICOM tags decoders in the runtime type system.

If a private creator map is passed as non NULL object then it will be used to store newly found private creators in decoded private tags.

◆ ~PrivateDICOMTagDecoder()

virtual ml::PrivateDICOMTagDecoder::~PrivateDICOMTagDecoder ( )
virtual

Destroys the decoder and the list of internally created decoder instances.

Member Function Documentation

◆ decodePrivateTag()

virtual PrivateDICOMTagDecoderPluginBase::DecodeStates ml::PrivateDICOMTagDecoder::decodePrivateTag ( const std::string &  privateCreator,
DCMTree::Const_TagPtr  tagPtr,
PrivateDICOMTagValueFields resultFields 
)
virtual

Function trying to decode the content of a private tag tagPtr to a list of values which are appended to the cleared PrivateDICOMTagValueFields container resultFields.

Parameters
privateCreatorA string with the name of the private creator this tags belongs to.
tagPtrThe tag whose value shall be decoded.
resultFieldsThe field container to be filled with extracted information from tagPtr or returned empty if no data could be decoded.
Returns
PrivateDICOMTagDecoderPluginBase::NOT_DECODED if the tag could not be decoded, PrivateDICOMTagDecoderPluginBase::PARTIALLY_DECODED if some of the tag value components were decoded or PrivateDICOMTagDecoderPluginBase::FULLY_DECODED if entire tag value could be decoded.

◆ getPrivateCreatorMap()

PrivateDICOMTagDecoderPluginBase::PrivateCreatorIdMap* ml::PrivateDICOMTagDecoder::getPrivateCreatorMap ( ) const
inline

Return the pointer to the map of known private creators or NULL.

Definition at line 58 of file mlPrivateDICOMTagDecoder.h.

◆ setPrivateCreatorMap()

void ml::PrivateDICOMTagDecoder::setPrivateCreatorMap ( PrivateDICOMTagDecoderPluginBase::PrivateCreatorIdMap pcm)
inline

Sets the pointer to the map which stores a set of known private creators, typically from the currently traversed DICOM (sub)tree.

Definition at line 62 of file mlPrivateDICOMTagDecoder.h.

Member Data Documentation

◆ _decoderList

std::list<PrivateDICOMTagDecoderPluginBase*> ml::PrivateDICOMTagDecoder::_decoderList
protected

List of tag decoder instances who have been found via the runtime type system.

Definition at line 66 of file mlPrivateDICOMTagDecoder.h.


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