The ISgfcGameInfo interface ia a collection of meta data that describes one SGF game. For instance, the meta data includes information such as the name of the game, when and where it was played, by whom, etc. More...

#include <ISgfcGameInfo.h>

Inheritance diagram for LibSgfcPlusPlus::ISgfcGameInfo:

Public Member Functions
	ISgfcGameInfo ()
	Initializes a newly constructed ISgfcGameInfo object.

virtual	~ISgfcGameInfo ()
	Destroys and cleans up the ISgfcGameInfo object.

Root properties (read only)
virtual SgfcGameType	GetGameType () const =0
	Returns the game type. The default value is SgfcConstants::DefaultGameType.

virtual SgfcNumber	GetGameTypeAsNumber ()=0
	Returns the game type as an SgfcNumber value. The default value is the SgfcNumber value that corresponds to SgfcConstants::DefaultGameType.

virtual SgfcBoardSize	GetBoardSize () const =0
	Returns the size of the board on which the game was played. The default value is the default board size for SgfcConstants::DefaultGameType.

Game data information
virtual SgfcSimpleText	GetRecorderName () const =0
	Returns the name of the user (or program) who recorded or entered the game data. The default value is SgfcConstants::NoneValueString.

virtual void	SetRecorderName (const SgfcSimpleText &recorderName)=0
	Sets the name of the user (or program) who recorded or entered the game data.

virtual SgfcSimpleText	GetSourceName () const =0
	Returns the name of the source of the game data (e.g. book, journal, etc.). The default value is SgfcConstants::NoneValueString.

virtual void	SetSourceName (const SgfcSimpleText &sourceName)=0
	Sets the name of the source of the game data (e.g. book, journal, etc.).

virtual SgfcSimpleText	GetAnnotationAuthor () const =0
	Returns the name of the person who made the annotations to the game. The default value is SgfcConstants::NoneValueString.

virtual void	SetAnnotationAuthor (const SgfcSimpleText &annotationAuthor)=0
	Sets the name of the person who made the annotations to the game.

virtual SgfcSimpleText	GetCopyrightInformation () const =0
	Returns the copyright information for the game data (including the annotations). The default value is SgfcConstants::NoneValueString.

virtual void	SetCopyrightInformation (const SgfcSimpleText &copyrightInformation)=0
	Sets the copyright information for the game data (including the annotations).

Basic game information
virtual SgfcSimpleText	GetGameName () const =0
	Returns the name of the game (e.g. for easily finding the game again within a collection). The default value is SgfcConstants::NoneValueString.

virtual void	SetGameName (const SgfcSimpleText &gameName)=0
	Sets the name of the game (e.g. for easily finding the game again within a collection).

virtual SgfcText	GetGameInformation () const =0
	Returns information about the game (e.g. background information, a game summary, etc.). The default value is SgfcConstants::NoneValueString.

virtual void	SetGameInformation (const SgfcText &gameInformation)=0
	Sets information about the game (e.g. background information, a game summary, etc.).

virtual std::vector< SgfcDate >	GetGameDates () const =0
	Returns the dates when the game was played, decomposed into years, optional months and optional days. Several non-consecutive dates are possible. The default value is an empty collection of dates.

virtual void	SetGameDates (const std::vector< SgfcDate > &gameDates)=0
	Sets the dates when the game was played, decomposed into years, optional months and optional days. Several non-consecutive dates are possible.

virtual SgfcSimpleText	GetRawGameDates () const =0
	Returns the dates when the game was played. Several non-consecutive dates are possible. The default value is SgfcConstants::NoneValueString.

virtual SgfcSimpleText	GetRulesName () const =0
	Returns the name of the rules used for the game. The default value is SgfcConstants::NoneValueString.

virtual void	SetRulesName (const SgfcSimpleText &rulesName)=0
	Sets the name of the rules used for the game.

virtual SgfcGameResult	GetGameResult () const =0
	Returns the result of the game, decomposed into an outcome and an optional score. The default value is an SgfcGameResult object which has the IsValid property set to false.

virtual void	SetGameResult (SgfcGameResult gameResult)=0
	Sets the result of the game, decomposed into an outcome and an optional score.

virtual SgfcSimpleText	GetRawGameResult () const =0
	Returns the result of the game. The default value is SgfcConstants::NoneValueString.

Extra game information
virtual SgfcReal	GetTimeLimitInSeconds () const =0
	Returns the time limit of the game in seconds. The default value is 0.0.

virtual void	SetTimeLimitInSeconds (SgfcReal timeLimitInSeconds)=0
	Sets the time limit of the game in seconds.

virtual SgfcSimpleText	GetOvertimeInformation () const =0
	Returns the description of the method used for overtime (byo-yomi). The default value is SgfcConstants::NoneValueString.

virtual void	SetOvertimeInformation (const SgfcSimpleText &overtimeInformation)=0
	Sets the description of the method used for overtime (byo-yomi).

virtual SgfcSimpleText	GetOpeningInformation () const =0
	Returns information about the opening played. The default value is SgfcConstants::NoneValueString.

virtual void	SetOpeningInformation (const SgfcSimpleText &openingInformation)=0
	Sets the information about the opening played.

Player information
virtual SgfcSimpleText	GetBlackPlayerName () const =0
	Returns the name of the black player. The default value is an empty string.

virtual void	SetBlackPlayerName (const SgfcSimpleText &blackPlayerName)=0
	Sets the name of the black player.

virtual SgfcSimpleText	GetBlackPlayerRank () const =0
	Returns the rank of the black player. The default value is an empty string.

virtual void	SetBlackPlayerRank (const SgfcSimpleText &blackPlayerRank)=0
	Sets the rank of the black player.

virtual SgfcSimpleText	GetBlackPlayerTeamName () const =0
	Returns the name of the black player's team. The default value is SgfcConstants::NoneValueString.

virtual void	SetBlackPlayerTeamName (const SgfcSimpleText &blackPlayerTeamName)=0
	Sets the name of the black player's team.

virtual SgfcSimpleText	GetWhitePlayerName () const =0
	Returns the name of the white player. The default value is an empty string.

virtual void	SetWhitePlayerName (const SgfcSimpleText &whitePlayerName)=0
	Sets the name of the white player.

virtual SgfcSimpleText	GetWhitePlayerRank () const =0
	Returns the rank of the white player. The default value is an empty string.

virtual void	SetWhitePlayerRank (const SgfcSimpleText &whitePlayerRank)=0
	Sets the rank of the white player.

virtual SgfcSimpleText	GetWhitePlayerTeamName () const =0
	Returns the name of the white player's team. The default value is SgfcConstants::NoneValueString.

virtual void	SetWhitePlayerTeamName (const SgfcSimpleText &whitePlayerTeamName)=0
	Sets the name of the white player's team.

Context in which the game was played
virtual SgfcSimpleText	GetGameLocation () const =0
	Returns the name or description of the location where the game was played. The default value is SgfcConstants::NoneValueString.

virtual void	SetGameLocation (const SgfcSimpleText &gameLocation)=0
	Sets the name or description of the location where the game was played.

virtual SgfcSimpleText	GetEventName () const =0
	Returns the name of the event (e.g. tournament) where the game was played. The default value is SgfcConstants::NoneValueString.

virtual void	SetEventName (const SgfcSimpleText &eventName)=0
	Sets the name of the event (e.g. tournament) where the game was played.

virtual SgfcRoundInformation	GetRoundInformation () const =0
	Returns the information that describes the round in which the game was played, decomposed into round number and type of round. The default value is an SgfcRoundInformation object which has the IsValid property set to false.

virtual void	SetRoundInformation (const SgfcRoundInformation &roundInformation)=0
	Sets the information that describes the round in which the game was played, decomposed into round number and type of round.

virtual SgfcSimpleText	GetRawRoundInformation () const =0
	Returns the information that describes the round in which the game was played. The default value is SgfcConstants::NoneValueString.

virtual const ISgfcGoGameInfo *	ToGoGameInfo () const =0
	Returns an ISgfcGoGameInfo object if the ISgfcGameInfo object was created specifically for SgfcGameType::Go. Returns nullptr otherwise. The caller is not the owner of the returned object.

Detailed Description

The ISgfcGameInfo interface ia a collection of meta data that describes one SGF game. For instance, the meta data includes information such as the name of the game, when and where it was played, by whom, etc.

ISgfcGame or ISgfcNode can be queried to provide an ISgfcGameInfo object. The object is newly created and contains a snapshot of the property values of a few root properties (SgfcPropertyCategory::Root) and all game info properties (SgfcPropertyCategory::GameInfo) found in the root node and the game info node, respectively, at the time the query is made.

Note: It is not possible to distinguish between a property that was not present in the root or game info node, and a property that was present in the root or game info but had the default property value.

Alternatively a new but empty ISgfcGameInfo object can be created via SgfcPlusPlusFactory and then populated with data as the library client sees fit. The empty ISgfcGameInfo object is initialized with default values.

The values that an ISgfcGameInfo object holds can be written to an ISgfcGame or ISgfcNode. The values are converted to properties and property values that are then stored in the root node and the game info node, respectively. Properties and property values that already exist at that time are either overwritten, or removed if the value to be written is the default value.

Note: It is not possible to write a property with its default value.

Root property values are read-only - they must be provided at the time the ISgfcGameInfo object is constructed and cannot be changed later on. The reason is that changing these values in an ISgfcGameInfo object that was captured from a game tree and then later writing the ISgfcGameInfo object data back to the game tree would likely invalidate most if not all of the game tree's data.

Member Function Documentation

◆ GetAnnotationAuthor()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetAnnotationAuthor ( ) const

pure virtual

Returns the name of the person who made the annotations to the game. The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::AN

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetBlackPlayerName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetBlackPlayerName ( ) const

pure virtual

Returns the name of the black player. The default value is an empty string.

See also: SgfcPropertyType::PB

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetBlackPlayerRank()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetBlackPlayerRank ( ) const

pure virtual

Returns the rank of the black player. The default value is an empty string.

See also: SgfcPropertyType::BR

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetBlackPlayerTeamName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetBlackPlayerTeamName ( ) const

pure virtual

Returns the name of the black player's team. The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::BT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetBoardSize()

virtual SgfcBoardSize LibSgfcPlusPlus::ISgfcGameInfo::GetBoardSize ( ) const

pure virtual

Returns the size of the board on which the game was played. The default value is the default board size for SgfcConstants::DefaultGameType.

Returns SgfcConstants::BoardSizeNone or SgfcConstants::BoardSizeInvalid if there is a problem with determining a valid board size from the SZ property. See ISgfcGame::GetBoardSize() for details.

See also: SgfcPropertyType::SZ

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetCopyrightInformation()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetCopyrightInformation ( ) const

pure virtual

Returns the copyright information for the game data (including the annotations). The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::CP

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetEventName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetEventName ( ) const

pure virtual

Returns the name of the event (e.g. tournament) where the game was played. The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::EV

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetGameDates()

virtual std::vector< SgfcDate > LibSgfcPlusPlus::ISgfcGameInfo::GetGameDates ( ) const

pure virtual

Returns the dates when the game was played, decomposed into years, optional months and optional days. Several non-consecutive dates are possible. The default value is an empty collection of dates.

The returned collection is also empty if there is a problem with decomposing the raw property value. See SgfcDate::FromPropertyValue() for details. An indicator that this happened is if GetRawGameDates() returns a value that is not equal to SgfcConstants::NoneValueString.

See also: SgfcPropertyType::DT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetGameInformation()

virtual SgfcText LibSgfcPlusPlus::ISgfcGameInfo::GetGameInformation ( ) const

pure virtual

Returns information about the game (e.g. background information, a game summary, etc.). The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::GC

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetGameLocation()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetGameLocation ( ) const

pure virtual

Returns the name or description of the location where the game was played. The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::PC

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetGameName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetGameName ( ) const

pure virtual

Returns the name of the game (e.g. for easily finding the game again within a collection). The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::GN

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetGameResult()

virtual SgfcGameResult LibSgfcPlusPlus::ISgfcGameInfo::GetGameResult ( ) const

pure virtual

Returns the result of the game, decomposed into an outcome and an optional score. The default value is an SgfcGameResult object which has the IsValid property set to false.

The returned SgfcGameResult also has the IsValid property set to false if there is a problem with decomposing the raw property value. See SgfcGameResult::FromPropertyValue() for details. An indicator that this happened is if GetRawGameResult() returns a value that is not equal to SgfcConstants::NoneValueString.

See also: SgfcPropertyType::RE

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetGameType()

virtual SgfcGameType LibSgfcPlusPlus::ISgfcGameInfo::GetGameType ( ) const

pure virtual

Returns the game type. The default value is SgfcConstants::DefaultGameType.

Returns SgfcGameType::Unknown if the Number value of the GM property is not in the list of valid games defined in the SGF standard.

See also: SgfcPropertyType::GM

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetGameTypeAsNumber()

virtual SgfcNumber LibSgfcPlusPlus::ISgfcGameInfo::GetGameTypeAsNumber ( )

pure virtual

Returns the game type as an SgfcNumber value. The default value is the SgfcNumber value that corresponds to SgfcConstants::DefaultGameType.

This is useful if GetGameType() returns SgfcGameType::Unknown because the Number value of the GM property is not in the list of valid games defined in the SGF standard.

See also: SgfcPropertyType::GM

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetOpeningInformation()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetOpeningInformation ( ) const

pure virtual

Returns information about the opening played. The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::ON

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetOvertimeInformation()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetOvertimeInformation ( ) const

pure virtual

Returns the description of the method used for overtime (byo-yomi). The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::OT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetRawGameDates()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetRawGameDates ( ) const

pure virtual

Returns the dates when the game was played. Several non-consecutive dates are possible. The default value is SgfcConstants::NoneValueString.

This is useful if the raw game dates cannot be decomposed into years, optional months and optional days, as is required by the SGF standard for SgfcPropertyType::DT.

Note: There is no setter for the raw game dates value because the SGF standard requires a certain format in the raw property value, and that can be guaranteed only by forcing the library client to set the game dates via structured SgfcDate values.

See also: SgfcPropertyType::DT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetRawGameResult()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetRawGameResult ( ) const

pure virtual

Returns the result of the game. The default value is SgfcConstants::NoneValueString.

This is useful if the raw game result cannot be decomposed into an outcome and an optional score as is required by the SGF standard for SgfcPropertyType::RE.

Note: There is no setter for the raw game result value because the SGF standard requires a certain format in the raw property value, and that can be guaranteed only by forcing the library client to set the game result via a structured SgfcGameResult value.

See also: SgfcPropertyType::RE

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetRawRoundInformation()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetRawRoundInformation ( ) const

pure virtual

Returns the information that describes the round in which the game was played. The default value is SgfcConstants::NoneValueString.

This is useful if the raw round information cannot be decomposed into round number and type of round as recommended by the SGF standard for SgfcPropertyType::RO.

Note: There is no setter for the raw round information value because the SGF standard requires a certain format in the raw property value, and that can be guaranteed only by forcing the library client to set the round information via a structured SgfcRoundInformation value.

See also: SgfcPropertyType::RO

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetRecorderName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetRecorderName ( ) const

pure virtual

Returns the name of the user (or program) who recorded or entered the game data. The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::US

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetRoundInformation()

virtual SgfcRoundInformation LibSgfcPlusPlus::ISgfcGameInfo::GetRoundInformation ( ) const

pure virtual

Returns the information that describes the round in which the game was played, decomposed into round number and type of round. The default value is an SgfcRoundInformation object which has the IsValid property set to false.

The returned SgfcRoundInformation also has the IsValid property set to false if there is a problem with decomposing the raw property value. See SgfcRoundInformation::FromPropertyValue() for details. An indicator that this happened is if GetRawRoundInformation() returns a value that is not equal to SgfcConstants::NoneValueString.

See also: SgfcPropertyType::RO

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetRulesName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetRulesName ( ) const

pure virtual

Returns the name of the rules used for the game. The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::RU

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetSourceName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetSourceName ( ) const

pure virtual

Returns the name of the source of the game data (e.g. book, journal, etc.). The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::SO

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetTimeLimitInSeconds()

virtual SgfcReal LibSgfcPlusPlus::ISgfcGameInfo::GetTimeLimitInSeconds ( ) const

pure virtual

Returns the time limit of the game in seconds. The default value is 0.0.

See also: SgfcPropertyType::TM

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetWhitePlayerName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetWhitePlayerName ( ) const

pure virtual

Returns the name of the white player. The default value is an empty string.

See also: SgfcPropertyType::PW

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetWhitePlayerRank()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetWhitePlayerRank ( ) const

pure virtual

Returns the rank of the white player. The default value is an empty string.

See also: SgfcPropertyType::WR

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ GetWhitePlayerTeamName()

virtual SgfcSimpleText LibSgfcPlusPlus::ISgfcGameInfo::GetWhitePlayerTeamName ( ) const

pure virtual

Returns the name of the white player's team. The default value is SgfcConstants::NoneValueString.

See also: SgfcPropertyType::WT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetAnnotationAuthor()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetAnnotationAuthor ( const SgfcSimpleText & annotationAuthor )

pure virtual

Sets the name of the person who made the annotations to the game.

See also: SgfcPropertyType::AN

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetBlackPlayerName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetBlackPlayerName ( const SgfcSimpleText & blackPlayerName )

pure virtual

Sets the name of the black player.

See also: SgfcPropertyType::PB

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetBlackPlayerRank()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetBlackPlayerRank ( const SgfcSimpleText & blackPlayerRank )

pure virtual

Sets the rank of the black player.

See also: SgfcPropertyType::BR

Implemented in LibSgfcPlusPlus::SgfcGoGameInfo, and LibSgfcPlusPlus::SgfcGameInfo.

◆ SetBlackPlayerTeamName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetBlackPlayerTeamName ( const SgfcSimpleText & blackPlayerTeamName )

pure virtual

Sets the name of the black player's team.

See also: SgfcPropertyType::BT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetCopyrightInformation()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetCopyrightInformation ( const SgfcSimpleText & copyrightInformation )

pure virtual

Sets the copyright information for the game data (including the annotations).

See also: SgfcPropertyType::CP

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetEventName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetEventName ( const SgfcSimpleText & eventName )

pure virtual

Sets the name of the event (e.g. tournament) where the game was played.

See also: SgfcPropertyType::EV

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetGameDates()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetGameDates ( const std::vector< SgfcDate > & gameDates )

pure virtual

Sets the dates when the game was played, decomposed into years, optional months and optional days. Several non-consecutive dates are possible.

Invoking this setter also changes the information returned by GetRawGameDates().

See also: SgfcPropertyType::DT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetGameInformation()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetGameInformation ( const SgfcText & gameInformation )

pure virtual

Sets information about the game (e.g. background information, a game summary, etc.).

See also: SgfcPropertyType::GC

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetGameLocation()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetGameLocation ( const SgfcSimpleText & gameLocation )

pure virtual

Sets the name or description of the location where the game was played.

See also: SgfcPropertyType::PC

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetGameName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetGameName ( const SgfcSimpleText & gameName )

pure virtual

Sets the name of the game (e.g. for easily finding the game again within a collection).

See also: SgfcPropertyType::GN

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetGameResult()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetGameResult ( SgfcGameResult gameResult )

pure virtual

Sets the result of the game, decomposed into an outcome and an optional score.

Invoking this setter also changes the information returned by GetRawGameResult().

See also: SgfcPropertyType::RE

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetOpeningInformation()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetOpeningInformation ( const SgfcSimpleText & openingInformation )

pure virtual

Sets the information about the opening played.

See also: SgfcPropertyType::ON

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetOvertimeInformation()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetOvertimeInformation ( const SgfcSimpleText & overtimeInformation )

pure virtual

Sets the description of the method used for overtime (byo-yomi).

See also: SgfcPropertyType::OT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetRecorderName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetRecorderName ( const SgfcSimpleText & recorderName )

pure virtual

Sets the name of the user (or program) who recorded or entered the game data.

See also: SgfcPropertyType::US

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetRoundInformation()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetRoundInformation ( const SgfcRoundInformation & roundInformation )

pure virtual

Sets the information that describes the round in which the game was played, decomposed into round number and type of round.

Invoking this setter also changes the information returned by GetRawRoundInformation().

See also: SgfcPropertyType::RO

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetRulesName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetRulesName ( const SgfcSimpleText & rulesName )

pure virtual

Sets the name of the rules used for the game.

See also: SgfcPropertyType::RU

Implemented in LibSgfcPlusPlus::SgfcGoGameInfo, and LibSgfcPlusPlus::SgfcGameInfo.

◆ SetSourceName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetSourceName ( const SgfcSimpleText & sourceName )

pure virtual

Sets the name of the source of the game data (e.g. book, journal, etc.).

See also: SgfcPropertyType::SO

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetTimeLimitInSeconds()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetTimeLimitInSeconds ( SgfcReal timeLimitInSeconds )

pure virtual

Sets the time limit of the game in seconds.

See also: SgfcPropertyType::TM

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetWhitePlayerName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetWhitePlayerName ( const SgfcSimpleText & whitePlayerName )

pure virtual

Sets the name of the white player.

See also: SgfcPropertyType::PW

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ SetWhitePlayerRank()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetWhitePlayerRank ( const SgfcSimpleText & whitePlayerRank )

pure virtual

Sets the rank of the white player.

See also: SgfcPropertyType::WR

Implemented in LibSgfcPlusPlus::SgfcGoGameInfo, and LibSgfcPlusPlus::SgfcGameInfo.

◆ SetWhitePlayerTeamName()

virtual void LibSgfcPlusPlus::ISgfcGameInfo::SetWhitePlayerTeamName ( const SgfcSimpleText & whitePlayerTeamName )

pure virtual

Sets the name of the white player's team.

See also: SgfcPropertyType::WT

Implemented in LibSgfcPlusPlus::SgfcGameInfo.

◆ ToGoGameInfo()

virtual const ISgfcGoGameInfo * LibSgfcPlusPlus::ISgfcGameInfo::ToGoGameInfo ( ) const

pure virtual

Returns an ISgfcGoGameInfo object if the ISgfcGameInfo object was created specifically for SgfcGameType::Go. Returns nullptr otherwise. The caller is not the owner of the returned object.

Implemented in LibSgfcPlusPlus::SgfcGoGameInfo, and LibSgfcPlusPlus::SgfcGameInfo.

The documentation for this class was generated from the following files:

/Users/patrick/dev/libsgfcplusplus/include/ISgfcGameInfo.h
/Users/patrick/dev/libsgfcplusplus/src/interface/public/ISgfcGameInfo.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAnnotationAuthor()

◆ GetBlackPlayerName()

◆ GetBlackPlayerRank()

◆ GetBlackPlayerTeamName()

◆ GetBoardSize()

◆ GetCopyrightInformation()

◆ GetEventName()

◆ GetGameDates()

◆ GetGameInformation()

◆ GetGameLocation()

◆ GetGameName()

◆ GetGameResult()

◆ GetGameType()

◆ GetGameTypeAsNumber()

◆ GetOpeningInformation()

◆ GetOvertimeInformation()

◆ GetRawGameDates()

◆ GetRawGameResult()

◆ GetRawRoundInformation()

◆ GetRecorderName()

◆ GetRoundInformation()

◆ GetRulesName()

◆ GetSourceName()

◆ GetTimeLimitInSeconds()

◆ GetWhitePlayerName()

◆ GetWhitePlayerRank()

◆ GetWhitePlayerTeamName()

◆ SetAnnotationAuthor()

◆ SetBlackPlayerName()

◆ SetBlackPlayerRank()

◆ SetBlackPlayerTeamName()

◆ SetCopyrightInformation()

◆ SetEventName()

◆ SetGameDates()

◆ SetGameInformation()

◆ SetGameLocation()

◆ SetGameName()

◆ SetGameResult()

◆ SetOpeningInformation()

◆ SetOvertimeInformation()

◆ SetRecorderName()

◆ SetRoundInformation()

◆ SetRulesName()

◆ SetSourceName()

◆ SetTimeLimitInSeconds()

◆ SetWhitePlayerName()

◆ SetWhitePlayerRank()

◆ SetWhitePlayerTeamName()

◆ ToGoGameInfo()