The SgfcDocumentReader class provides an implementation of the ISgfcDocumentReader interface. See the interface header file for documentation. More...
#include <SgfcDocumentReader.h>
Public Member Functions | |
| virtual std::shared_ptr< ISgfcArguments > | GetArguments () const override |
| Returns an object with the collection of arguments that ISgfcDocumentReader passes on to SGFC whenever it performs a read operation. | |
| virtual std::shared_ptr< ISgfcDocumentReadResult > | ReadSgfFile (const std::string &sgfFilePath) const override |
| Reads SGF data from a single .sgf file located at the specified path and puts the data through the SGFC parser, using the arguments that GetArguments() currently returns. | |
| virtual std::shared_ptr< ISgfcDocumentReadResult > | ReadSgfContent (const std::string &sgfContent) const override |
| Reads SGF data from the specified string and puts the data through the SGFC parser, using the arguments that GetArguments() currently returns. | |
 Public Member Functions inherited from LibSgfcPlusPlus::ISgfcDocumentReader | |
| ISgfcDocumentReader () | |
| Initializes a newly constructed ISgfcDocumentReader object. | |
| virtual | ~ISgfcDocumentReader () |
| Destroys and cleans up the ISgfcDocumentReader object. | |
Detailed Description
The SgfcDocumentReader class provides an implementation of the ISgfcDocumentReader interface. See the interface header file for documentation.
Member Function Documentation
◆ GetArguments()
|
overridevirtual |
Returns an object with the collection of arguments that ISgfcDocumentReader passes on to SGFC whenever it performs a read operation.
The collection of arguments is initially empty. Add arguments to the collection to change the way how SGFC reads SGF content. The collection retains its state between read operations so that repeated read operations use the same arguments.
Implements LibSgfcPlusPlus::ISgfcDocumentReader.
◆ ReadSgfContent()
|
overridevirtual |
Reads SGF data from the specified string and puts the data through the SGFC parser, using the arguments that GetArguments() currently returns.
Read the class documentation for details about encodings.
- Returns
- An ISgfcDocumentReadResult object that provides the result of the read operation.
Implements LibSgfcPlusPlus::ISgfcDocumentReader.
◆ ReadSgfFile()
|
overridevirtual |
Reads SGF data from a single .sgf file located at the specified path and puts the data through the SGFC parser, using the arguments that GetArguments() currently returns.
Read the class documentation for details about encodings.
- Returns
- An ISgfcDocumentReadResult object that provides the result of the read operation.
Implements LibSgfcPlusPlus::ISgfcDocumentReader.
The documentation for this class was generated from the following files:
- /Users/patrick/dev/libsgfcplusplus/src/sgfc/frontend/SgfcDocumentReader.h
- /Users/patrick/dev/libsgfcplusplus/src/sgfc/frontend/SgfcDocumentReader.cpp
