NDEVR
API Documentation
FileFactoryWarning

Allows the software to display a warning to the end user about a problem encountered during an IOFactory read/write operation. More...

Collaboration diagram for FileFactoryWarning:
[legend]

Public Member Functions

 FileFactoryWarning (const TranslatedString &title, const File &file, uint04 line_number=Constant< uint04 >::Invalid)
 Constructs a warning referencing a specific file and optional line number.
 FileFactoryWarning (const TranslatedString &title, const TranslatedString &message)
 Constructs a warning with a title and descriptive message.

Public Attributes

TranslatedString message
 The descriptive message body of the warning.
TranslatedString title
 The title or heading of the warning.

Detailed Description

Allows the software to display a warning to the end user about a problem encountered during an IOFactory read/write operation.


Definition at line 52 of file IOFactory.h.

Constructor & Destructor Documentation

◆ FileFactoryWarning() [1/2]

FileFactoryWarning::FileFactoryWarning ( const TranslatedString & title,
const TranslatedString & message )

Constructs a warning with a title and descriptive message.


Parameters
[in]titleThe title or heading of the warning.
[in]messageThe descriptive message body of the warning.

References message, and title.

◆ FileFactoryWarning() [2/2]

FileFactoryWarning::FileFactoryWarning ( const TranslatedString & title,
const File & file,
uint04 line_number = Constantuint04 >::Invalid )

Constructs a warning referencing a specific file and optional line number.


Parameters
[in]titleThe title or heading of the warning.
[in]fileThe file associated with the warning.
[in]line_numberThe line number in the file where the problem was encountered. Defaults to Constant<uint04>::Invalid if not specified.

References title.


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