ml::DicomMessageCollector Class Reference
Class to collect messages and errors related to a given frame handle. More...
#include <mlDicomMessageCollector.h>
Inheritance diagram for ml::DicomMessageCollector:
Public Member Functions | |
| DicomMessageCollector (const DICOMCachedIOFileHandle &handle=DICOMCachedIOFileHandle("")) | |
| Construction with empty fileHandle and empty messages. | |
| virtual void | setHandle (const DICOMCachedIOFileHandle &handleToSet) |
| Sets the file handle. | |
| virtual const DICOMCachedIOFileHandle & | getHandle () const |
| Get the current a message string. | |
| MessageCollector * | createClone () override |
| Create a duplicate from *this. | |
| virtual DicomMessageCollector * | createDicomMessageCollectorClone () |
| Public Member Functions inherited from ml::MessageCollector | |
| MessageCollector () | |
| Construction with empty messages. | |
| virtual | ~MessageCollector () |
| Virtual destructor. | |
| bool | operator== (const MessageCollector &otherObj) const |
| Returns true on member equality, otherwise false. | |
| virtual bool | hasInfo () const |
| Returns true if the info member is not empty, otherwise false. | |
| virtual void | appendInfo (const std::string &stringToAppend) |
| Append an info string; can be overwritten for replacement of the appendInfo functionality. | |
| virtual void | appendInfo (std::stringstream &streamToAppend) |
| Append an info stream; indirectly uses appendInfo(const std::string &) for appending. | |
| virtual void | setInfos (const std::string &stringToSet) |
| Sets the current info string. | |
| virtual void | setInfos (std::stringstream &streamToSet) |
| Set an info stream. | |
| virtual const std::string & | getInfos () const |
| Get the current info string. | |
| virtual void | postInfos (const std::string &funcName) |
| virtual bool | hasIssue () const |
| Returns true if the issue member is not empty, otherwise false. | |
| virtual void | appendIssue (const std::string &stringToAppend) |
| Append an issue string; can be overwritten for replacement of the appendIssue functionality. | |
| virtual void | appendIssue (std::stringstream &streamToAppend) |
| Append an issue stream; indirectly uses appendIssue(const std::string &) for appending.. | |
| virtual void | setIssues (const std::string &stringToSet) |
| Sets the current issue string. | |
| virtual void | setIssues (std::stringstream &streamToSet) |
| Set an issue stream. | |
| virtual const std::string & | getIssues () const |
| Get the current issue string. | |
| virtual void | postIssues (const std::string &funcName, const std::string &reason) |
| virtual bool | hasError () const |
| Returns true if error messaqe member is not empty, otherwise false. | |
| virtual void | appendError (const std::string &stringToAppend) |
| Append an error string; can be overwritten for replacement of the appendError functionality. | |
| virtual void | appendError (std::stringstream &streamToAppend) |
| Append an error stream; indirectly uses appendError(const std::string &) for appending.. | |
| virtual void | setErrors (const std::string &stringToSet) |
| Sets the current error string. | |
| virtual void | setErrors (std::stringstream &streamToSet) |
| Set an error stream. | |
| virtual const std::string & | getErrors () const |
| Get the current error string. | |
| virtual void | postErrors (const std::string &funcName, const std::string &reason) |
| virtual bool | hasMessages () const |
| Returns true if any message is not empty, otherwise false. | |
| virtual std::string | getAllMessages () const |
| Get the current message + issue + error string. | |
| virtual void | clearMessages () |
| Clears all messages to empty strings, the handle is not changed. | |
| virtual void | postMessages (const std::string &funcName, const std::string &reason) |
| virtual void | convertAllMessagesToErrors () |
| Append all messages to error messages and then clears them. | |
| virtual void | appendMessagesFrom (const MessageCollector &other) |
| Append all corresponding messages from other. | |
| std::string | getFiltered (const std::string &stringToFilter) const |
Protected Member Functions | |
| DicomMessageCollector (const DicomMessageCollector &other)=default | |
| Forbid copy constructor and assignment operator for others since often derived instances are passed; better use createClone(). | |
| DicomMessageCollector & | operator= (const DicomMessageCollector &other)=default |
| Protected Member Functions inherited from ml::MessageCollector | |
| virtual bool | _filterMatches (const std::string &) const |
| MessageCollector (const MessageCollector &)=default | |
| Forbid copy constructor and assignment operator for others since often derived instances are passed; better use createClone(). | |
| MessageCollector & | operator= (const MessageCollector &)=default |
Protected Attributes | |
| DICOMCachedIOFileHandle | _handle |
| If known, this is a handle related to a messages which can be useful to make information more specific. | |
| Protected Attributes inherited from ml::MessageCollector | |
| std::string | _infos |
| Collects any information. | |
| std::string | _issues |
| Collects issue information. | |
| std::string | _errors |
| Collects error information. | |
Detailed Description
Class to collect messages and errors related to a given frame handle.
Definition at line 21 of file mlDicomMessageCollector.h.
Constructor & Destructor Documentation
◆ DicomMessageCollector() [1/2]
| ml::DicomMessageCollector::DicomMessageCollector | ( | const DICOMCachedIOFileHandle & | handle = DICOMCachedIOFileHandle("") | ) |
Construction with empty fileHandle and empty messages.
Referenced by ml::DicomConfigurableMessageFilterBaseRefCounted::createDicomMessageCollectorClone(), createDicomMessageCollectorClone(), DicomMessageCollector(), and operator=().
◆ DicomMessageCollector() [2/2]
|
protecteddefault |
Forbid copy constructor and assignment operator for others since often derived instances are passed; better use createClone().
References DicomMessageCollector().
Member Function Documentation
◆ createClone()
|
overridevirtual |
Create a duplicate from *this.
Reimplemented from ml::MessageCollector.
References ml::MessageCollector::MessageCollector().
◆ createDicomMessageCollectorClone()
|
virtual |
Reimplemented in ml::DicomConfigurableMessageFilterBaseRefCounted.
References DicomMessageCollector().
◆ getHandle()
|
virtual |
Get the current a message string.
◆ operator=()
|
protecteddefault |
References DicomMessageCollector().
◆ setHandle()
|
virtual |
Sets the file handle.
Member Data Documentation
◆ _handle
|
protected |
If known, this is a handle related to a messages which can be useful to make information more specific.
Definition at line 40 of file mlDicomMessageCollector.h.
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/DICOM/MLDICOMCachedIO/Sources/mlDicomMessageCollector.h
