ImFusion SDK 4.3
SequenceItem Class Reference

#include <ImFusion/Dicom/DicomSequence.h>

Base class for sequence items. More...

+ Inheritance diagram for SequenceItem:

Detailed Description

Base class for sequence items.

Derived classes define the Elements each item in a sequence consists of.

See also
SequenceBase, Sequence

Public Member Functions

 SequenceItem (DcmItem &item)
 Creates a new sequence that retrieves its elements from item.
 
DcmItem & dataset () override
 Returns the DICOM dataset/item to retrieve the elements from.
 
- Public Member Functions inherited from ElementList
const std::vector< ElementBase * > & elements () const
 List of all elements.
 
- Public Member Functions inherited from ErrorRecorder
virtual void * registerErrorHandler (ErrorCallback handler)
 Registers a new handler callback function.
 
virtual void unregisterErrorHandler (void *handler)
 Removes a previously registered handler again.
 
void * forwardErrors (const ErrorRecorder *otherRecorder)
 Convenient function to forward all errors registered to this recorder to another recorder.
 
virtual void registerError (const Error &error) const
 Sends the given error to all error handler callbacks.
 
void registerError (Error::Code code, Error::Type type, const std::string &details, TagProxy tag=TagProxy()) const
 

Additional Inherited Members

- Public Types inherited from ErrorRecorder
using ErrorCallback = std::function<void(const Error&)>
 Alias for a function to call for each error recorded.
 
- Protected Member Functions inherited from NotCopyable
 NotCopyable (NotCopyable &&) noexcept=default
 
NotCopyableoperator= (NotCopyable &&) noexcept=default
 
 NotCopyable (const NotCopyable &)=delete
 
NotCopyableoperator= (const NotCopyable &)=delete
 
- Protected Attributes inherited from ElementList
std::vector< ElementBase * > m_elements
 List of all elements.
 

Constructor & Destructor Documentation

◆ SequenceItem()

SequenceItem ( DcmItem & item)

Creates a new sequence that retrieves its elements from item.

Derived classes need to provide a ctor of (DcmItem& item, bool createSequence = false) if the sequence is used for writing. The createSequence bool is set to true when exporting a sequence and indicates that the sequence was just created. For sequence items that are only meant to be read, this constructor has to be overridden. This can be used to e.g. create sub-sequences if required.

Member Function Documentation

◆ dataset()

DcmItem & dataset ( )
overridevirtual

Returns the DICOM dataset/item to retrieve the elements from.

Implements ElementList.

Reimplemented in XrayFunctionalGroups::XrayFunctionalGroupMacro, and XrayPositioning::ZiehmImageSpotPositionSequence.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close