The ISgfcDocumentWriteResult interface provides access to the result of a write operation performed by ISgfcDocumentWriter. More...
#include <ISgfcDocumentWriteResult.h>
Public Member Functions | |
| ISgfcDocumentWriteResult () | |
| Initializes a newly constructed ISgfcDocumentWriteResult object. | |
| virtual | ~ISgfcDocumentWriteResult () |
| Destroys and cleans up the ISgfcDocumentWriteResult object. | |
| virtual SgfcExitCode | GetExitCode () const =0 |
| Returns an SgfcExitCode value that best fits the result of the write operation. The numeric value of the SgfcExitCode corresponds to one of the exit codes of SGFC. | |
| virtual std::vector< std::shared_ptr< ISgfcMessage > > | GetParseResult () const =0 |
| Returns a collection of ISgfcMessage objects which together form the parse result of the write operation. The messages appear in the order in which they were generated by SGFC. The collection is empty if write operation did not generate any messages. | |
| virtual void | DebugPrintToConsole () const =0 |
| Prints the content of the ISgfcDocumentWriteResult to stdout for debugging purposes. | |
Detailed Description
The ISgfcDocumentWriteResult interface provides access to the result of a write operation performed by ISgfcDocumentWriter.
ISgfcDocumentWriteResult is immutable, i.e. once the ISgfcDocumentWriteResult object is constructed it cannot be changed.
Member Function Documentation
◆ DebugPrintToConsole()
|
pure virtual |
Prints the content of the ISgfcDocumentWriteResult to stdout for debugging purposes.
Implemented in LibSgfcPlusPlus::SgfcDocumentWriteResult.
◆ GetExitCode()
|
pure virtual |
Returns an SgfcExitCode value that best fits the result of the write operation. The numeric value of the SgfcExitCode corresponds to one of the exit codes of SGFC.
Implemented in LibSgfcPlusPlus::SgfcDocumentWriteResult.
◆ GetParseResult()
|
pure virtual |
Returns a collection of ISgfcMessage objects which together form the parse result of the write operation. The messages appear in the order in which they were generated by SGFC. The collection is empty if write operation did not generate any messages.
Implemented in LibSgfcPlusPlus::SgfcDocumentWriteResult.
The documentation for this class was generated from the following files:
- /Users/patrick/dev/libsgfcplusplus/include/ISgfcDocumentWriteResult.h
- /Users/patrick/dev/libsgfcplusplus/src/interface/public/ISgfcDocumentWriteResult.cpp
