|
libsgfc++ 2.0.1
A C++ library that uses SGFC to read and write SGF (Smart Game Format) data.
|
The SgfcSaveStream class captures the stream of save data that is generated by SGF. More...
#include <SgfcSaveStream.h>
Public Member Functions | |
| SgfcSaveStream () | |
| Initializes a newly constructed SgfcSaveStream object. The object clears all data captured from previous save operations. | |
| virtual | ~SgfcSaveStream () |
| Destroys and cleans up the SgfcSaveStream object. | |
| std::vector< std::shared_ptr< SgfcSgfContent > > | GetSgfContents () const |
| Returns a collection of save data captured so far by the SgfcSaveStream object. The save data objects appear in the collection in the order in which they are generated by SGFC. The collection is empty if SGFC has not generated any save data. | |
The SgfcSaveStream class captures the stream of save data that is generated by SGF.
The capturing process does not depend on a particular instance of SgfcSaveStream. It is based on global/static functions and variables that are hidden behind the facade of SgfcSaveStream. However, an instance of SgfcSaveStream is required to access the captured data.
An actor that wants to perform an SGFC save operation invokes the static function CreateSaveFileHandler(). This returns a structure that the actor can then pass to the SGFC global function SaveSGF() to start the save operation. SaveSGF() will free the memory allocated for the structure, so it is good only for a single save operation.
Before the actor starts the save operation, though, it must construct an SgfcSaveStream object. Upon construction this clears all data captured from previous save operations.
While SaveSGF() runs it invokes various callback functions, pointers to which were stored in the structure created by CreateSaveFileHandler. The callback functions are internals of SgfcSaveStream that handle the capturing process.
After the save operation has finished the actor can access the captured save data by invoking the GetSgfContents() method. When SgfcSaveStream is destroyed the actor no longer has access to the captured data.
Only one SgfcSaveStream can be active at any given time.
An SgfcSaveStream object that is left alive can capture the results of multiple save operations. GetSgfContents() returns all save data that was captured during the entire lifetime of the SgfcSaveStream object.
| LibSgfcPlusPlus::SgfcSaveStream::SgfcSaveStream | ( | ) |
Initializes a newly constructed SgfcSaveStream object. The object clears all data captured from previous save operations.
| std::logic_error | Is thrown if another SgfcSaveStream object already exists. |
1.10.0