MeVisLab Toolbox Reference
|
Manages the module field interface according to DICOM ContentDate and ContentTime tags. More...
#include <mlDicomContentDateTimeTagInterface.h>
Public Member Functions | |
DicomContentDateTimeTagInterface (Module &modRef, bool allowEmptyStrings=true, bool allowOldFormats=true, const std::string &contentDateFieldName="contentDate", const std::string &contentTimeFieldName="contentTime", const std::string &msgContentDateFieldName="Content Date", const std::string &msgContentTimeFieldName="Content Time", const DCMTree::RawTagId dateTagId=DCMTree_ContentDate, const DCMTree::RawTagId timeTagId=DCMTree_ContentTime) | |
Constructor, setting the reference of the module for which the fields shall be managed. More... | |
void | addFields () override |
Add fields to field container of module. More... | |
void | inheritValues (DCMTree::Const_TreePtr dcmTree) override |
Implements the copy of tag values from the given dcmTree to the fields. More... | |
std::string | applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override |
See DicomModifyFieldAddOnBase::applyModifications() for documentation. More... | |
std::string | checkConsistency () const override |
Checks for invalid parameters; return textual description on error, or empty string on success. More... | |
Public Member Functions inherited from ml::DicomModifyFieldAddOnBase | |
DicomModifyFieldAddOnBase (FieldContainer &fieldContainerRef, size_t numInstances=1, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false) | |
Constructor, setting the reference of the FieldContainer managing the fields, the number of field instances to create and optionally input and output fields to create modification pipelines. More... | |
~DicomModifyFieldAddOnBase () override | |
Destructor resetting connector fields if they exist. More... | |
size_t | getNumInstances () const |
Returns the number of instances to be created by derived fields. More... | |
void | handleFieldActivationChanges () override |
Handle class changes according to Module::activateAttachments. More... | |
FieldAddOnBase::FieldChangeState | handleFieldChanges (Field *field) override |
Handle field notifications according to Module::handleNotification with a return of field change state. More... | |
BaseField * | getOutputModifierListFld () const |
Provide access to output base field if it was created. More... | |
BaseField * | getInputModifierListFld () const |
Provide access to input base connector field if it was created. More... | |
Public Member Functions inherited from ml::DicomModifyList | |
DicomModifyList () | |
Constructor creating an empty list of tag modifiers and setting the optional input plugin with a concatenated DicomModifyList. More... | |
~DicomModifyList () override | |
Destructor also destroying all of its stored Modifiers. More... | |
void | addModifier (DicomModifyBase *modifier, bool atEnd=true) |
Add an object derived from DicomModifyBase which then will be owned (and on destruction deleted) by this. More... | |
void | clear () |
Makes modifier array empty and deletes all of them. More... | |
std::vector< DicomModifyBase * > & | getModifierList () |
Get direct access to internal list to allow callers direct manipulations which, however, must obey the restriction that ownership belongs to *this, i.e. More... | |
const std::vector< DicomModifyBase * > & | getModifierList () const |
Same as getModifierList() only for constant access. More... | |
void | setInputPlugin (DicomModifyList *inputPlugin=nullptr) |
Sets an optional plugin to be called by applyModififcations or resets it to nullptr; the input is called after the objects in _modfiers list. More... | |
DicomModifyList * | getInputPlugin () const |
Returns the optional plugin to be called by applyModififcations. More... | |
Public Member Functions inherited from ml::Base | |
Base () | |
Constructor. More... | |
virtual | ~Base () |
Destructor. More... | |
virtual Base * | deepCopy () const |
Set addStateToTree version number that can be accessed via getAddStateVersion() More... | |
bool | isOfAllowedType (const std::vector< const RuntimeType * > &types) const |
Check if this object's type is equal to or derived from one of the types given in the argument. More... | |
virtual bool | isRefCountedBase () const |
Returns if the instance is derived from RefCountedBase. More... | |
virtual std::string | detailString () const |
Return a string describing this object. More... | |
virtual bool | implementsPersistence (PersistenceInterface) const |
Override this method to declare which persistence interfaces are implemented by your derived class. More... | |
virtual std::string | persistentState () const |
Returns a string describing the object's internal state. More... | |
virtual void | setPersistentState (const std::string &state) |
Restores the object's internal state from a string that had been previously generated using persistentState() . More... | |
virtual void | addStateToTree (TreeNode *) const |
Attaches the object state as children of the given parent node. More... | |
virtual void | readStateFromTree (TreeNode *) |
Reads the object state from the children of the given parent node. More... | |
virtual void | writeTo (AbstractPersistenceOutputStream *) const |
Write the objects state to the data stream object. More... | |
virtual void | readFrom (AbstractPersistenceInputStream *, int) |
Read the objects state from the data stream object. More... | |
Public Member Functions inherited from ml::FieldAddOnBase | |
FieldAddOnBase (FieldContainer &fieldContainerRef) | |
Constructor, setting the reference of the FieldContainer managing the fields. More... | |
virtual | ~FieldAddOnBase () |
Destructor. More... | |
FieldContainer & | getFieldContainer () |
Returns the referenced container. More... | |
const FieldContainer & | getFieldContainer () const |
Returns the referenced container. More... | |
std::vector< Field * > & | getFields () |
Return modification access to the list of managed fields, use at own risk! More... | |
const std::vector< Field * > & | getFields () const |
Return constant access to the list of managed fields! More... | |
virtual FieldChangeState | getMergedFieldChangeState (FieldChangeState state1, FieldChangeState state2) const |
Returns a FieldChangeState which best represents a merge of the two given states. More... | |
virtual bool | hasField (Field *field) const |
Returns true if the passed fieldPtr is in _fieldPointers, otherwise false. More... | |
Public Attributes | |
StringField * | _contentDateFld |
Fields. More... | |
StringField * | _contentTimeFld |
Content of the corresponding DICOM tag definition. More... | |
const bool | _allowEmptyStrings |
If true then empty strings in date/time settings are allowed, otherwise not. More... | |
const bool | _allowOldFormats |
If true then old date specification formats are allowed, otherwise not. More... | |
const std::string | _contentDateFieldName |
The constructor defined name to be used for the _contentDateFld. More... | |
const std::string | _contentTimeFieldName |
The constructor defined name to be used for the _contentTimeFld. More... | |
const std::string | _msgContentDateFieldName |
The constructor defined name to be used for the content date in messages. More... | |
const std::string | _msgContentTimeFieldName |
The constructor defined name to be used for the content time in messages. More... | |
const DCMTree::RawTagId | _contentDateTagId |
The constructor defined tag id to be used for the content date. More... | |
const DCMTree::RawTagId | _contentTimeTagId |
The constructor defined tag id to be used for the content time. More... | |
Additional Inherited Members | |
Public Types inherited from ml::Base | |
enum | PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream } |
This enum describes the different persistence interfaces available. More... | |
Public Types inherited from ml::FieldAddOnBase | |
enum | FieldChangeState { NoChange = 0 , StatusOnlyChange , RecalculationRequired } |
Describes the type of a field changes detected in handleFieldChanges(Field *field). More... | |
Static Public Member Functions inherited from ml::DicomModifyFieldAddOnBase | |
static bool | isIn (const std::string &str, const char *const *values, size_t numValues) |
Static helper function which checks whether str is part of the given list of values which has numValues entries. More... | |
Protected Member Functions inherited from ml::Base | |
virtual char * | getPersistentState () const |
Returns a C string describing the object's internal state. More... | |
virtual void | setPersistentState (const char *) |
Restores the object's internal state from a string that had been previously generated using getPersistentState() . More... | |
virtual void | clearPersistentState (char *) const |
Disposes a string previously allocated by getPersistentState() . More... | |
Protected Member Functions inherited from ml::FieldAddOnBase | |
void | _addFieldPointer (Field *field) |
Helper routine to add a Field pointer to _fieldPointers, empty pointers and pointers added more than once will be handled fatally. More... | |
Manages the module field interface according to DICOM ContentDate and ContentTime tags.
Definition at line 22 of file mlDicomContentDateTimeTagInterface.h.
ml::DicomContentDateTimeTagInterface::DicomContentDateTimeTagInterface | ( | Module & | modRef, |
bool | allowEmptyStrings = true , |
||
bool | allowOldFormats = true , |
||
const std::string & | contentDateFieldName = "contentDate" , |
||
const std::string & | contentTimeFieldName = "contentTime" , |
||
const std::string & | msgContentDateFieldName = "Content Date" , |
||
const std::string & | msgContentTimeFieldName = "Content Time" , |
||
const DCMTree::RawTagId | dateTagId = DCMTree_ContentDate , |
||
const DCMTree::RawTagId | timeTagId = DCMTree_ContentTime |
||
) |
Constructor, setting the reference of the module for which the fields shall be managed.
|
overridevirtual |
Add fields to field container of module.
Reimplemented from ml::DicomModifyFieldAddOnBase.
|
overridevirtual |
See DicomModifyFieldAddOnBase::applyModifications() for documentation.
Reimplemented from ml::DicomModifyFieldAddOnBase.
|
overridevirtual |
Checks for invalid parameters; return textual description on error, or empty string on success.
Reimplemented from ml::DicomModifyFieldAddOnBase.
|
overridevirtual |
Implements the copy of tag values from the given dcmTree to the fields.
Reimplemented from ml::DicomModifyFieldAddOnBase.
const bool ml::DicomContentDateTimeTagInterface::_allowEmptyStrings |
If true then empty strings in date/time settings are allowed, otherwise not.
Definition at line 57 of file mlDicomContentDateTimeTagInterface.h.
const bool ml::DicomContentDateTimeTagInterface::_allowOldFormats |
If true then old date specification formats are allowed, otherwise not.
Definition at line 60 of file mlDicomContentDateTimeTagInterface.h.
const std::string ml::DicomContentDateTimeTagInterface::_contentDateFieldName |
The constructor defined name to be used for the _contentDateFld.
Definition at line 63 of file mlDicomContentDateTimeTagInterface.h.
StringField* ml::DicomContentDateTimeTagInterface::_contentDateFld |
Fields.
Content of the corresponding DICOM tag definition.
Definition at line 51 of file mlDicomContentDateTimeTagInterface.h.
const DCMTree::RawTagId ml::DicomContentDateTimeTagInterface::_contentDateTagId |
The constructor defined tag id to be used for the content date.
Definition at line 75 of file mlDicomContentDateTimeTagInterface.h.
const std::string ml::DicomContentDateTimeTagInterface::_contentTimeFieldName |
The constructor defined name to be used for the _contentTimeFld.
Definition at line 66 of file mlDicomContentDateTimeTagInterface.h.
StringField* ml::DicomContentDateTimeTagInterface::_contentTimeFld |
Content of the corresponding DICOM tag definition.
Definition at line 53 of file mlDicomContentDateTimeTagInterface.h.
const DCMTree::RawTagId ml::DicomContentDateTimeTagInterface::_contentTimeTagId |
The constructor defined tag id to be used for the content time.
Definition at line 78 of file mlDicomContentDateTimeTagInterface.h.
const std::string ml::DicomContentDateTimeTagInterface::_msgContentDateFieldName |
The constructor defined name to be used for the content date in messages.
Definition at line 69 of file mlDicomContentDateTimeTagInterface.h.
const std::string ml::DicomContentDateTimeTagInterface::_msgContentTimeFieldName |
The constructor defined name to be used for the content time in messages.
Definition at line 72 of file mlDicomContentDateTimeTagInterface.h.