ImFusion SDK 4.3
ConfigurableSequence< T > Class Template Reference
+ Inheritance diagram for ConfigurableSequence< T >:

Public Member Functions

 ConfigurableSequence (ElementList &parent, DcmTag tag, ElementBase::Type type, int defaultNumberOfElements)
 
 ConfigurableSequence (DcmItem &item, DcmTag tag, ElementBase::Type type, int defaultNumberOfElements)
 
void setDefaultNumberOfElements (int n)
 
void configure (const Properties *p) override
 Configure this object instance by de-serializing the given Properties.
 
void configuration (Properties *p) const override
 Serialize the current object configuration into the given Properties object.
 
void configureDefaults () override
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
 
- Public Member Functions inherited from Sequence< T >
 Sequence (ElementList &parent, DcmTag tag, ElementBase::Type type)
 Creates a new Sequence instance.
 
 Sequence (DcmItem &item, DcmTag tag, ElementBase::Type type)
 
void reload ()
 Reloads the list of items from the parent data set.
 
int count () const
 Returns the number of items in this sequence.
 
T & item (int i)
 Returns the sequence item at the given index.
 
const T & item (int i) const
 
T * insertItem ()
 Appends a new sequence item to the list.
 
void checkErrors (bool ignoreMandatory=false) const override
 Checks the sequence for errors.
 
bool isValid () const override
 Returns true if the element exists and is in a valid range.
 
- Public Member Functions inherited from SequenceBase
 SequenceBase (ElementList &parent, DcmTag tag, ElementBase::Type type)
 
 SequenceBase (DcmItem &item, DcmTag tag, ElementBase::Type type)
 
- Public Member Functions inherited from ElementBase
 ElementBase (ElementList &parent, DcmTag tag, Type type=Conditional, bool searchIntoSubs=false)
 
 ElementBase (DcmItem &item, DcmTag tag, Type type=Conditional, bool searchIntoSubs=false)
 
void setCondition (std::function< bool()> predicate)
 Sets a callback function that determines if a conditional element is mandatory.
 
virtual DcmTag tag () const
 DICOM tag wrapped by this Element.
 
virtual bool isMandatory () const
 Evaluates whether this element is mandatory (based on the specified type and optionally condition).
 
virtual bool exists () const
 Returns true if the elements exists in the dataset.
 
void remove ()
 Removes the element from the dataset.
 
std::string valueString () const
 Returns the value of the element as a string.
 
void setTargetSequence (DcmItem *sequence)
 Sets an optional sequence item where this elements will write its value.
 
- 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
 
- Public Member Functions inherited from Configurable
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
 
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 
 Configurable (const Configurable &rhs)
 
 Configurable (Configurable &&rhs) noexcept
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Additional Inherited Members

- Public Types inherited from ElementBase
enum  Type { Mandatory , Conditional }
 Conditionality of an Element. More...
 
- Public Types inherited from ErrorRecorder
using ErrorCallback = std::function<void(const Error&)>
 Alias for a function to call for each error recorded.
 
- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 
- Protected Attributes inherited from Sequence< T >
std::vector< std::unique_ptr< T > > m_items
 
- Protected Attributes inherited from ElementBase
DcmItem & m_dataset
 DICOM data set/base element to retrieve element data from.
 
DcmItem * m_targetSeq
 Optional sequence to write element data to; only used for setValue().
 
DcmTag m_tag
 DICOM tag the Element refers to.
 
Type m_type
 Conditionality of the Element.
 
bool m_searchIntoSubs
 Flag whether to search into sub sequences or not.
 
std::function< bool()> m_typeCondition
 Optional predicate function to evaluate conditionality.
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Function Documentation

◆ configure()

template<class T>
void configure ( const Properties * p)
inlineoverridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configuration() for the inverse functionality

Reimplemented from Configurable.

◆ configuration()

template<class T>
void configuration ( Properties * p) const
inlineoverridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configure() for the inverse functionality

Reimplemented from Configurable.

◆ configureDefaults()

template<class T>
void configureDefaults ( )
inlineoverridevirtual

Retrieve the properties of this object, replaces values with their defaults and sets it again.

Reimplemented from Configurable.


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