The ISgfcGoGameInfo interface is a specialization of ISgfcGameInfo that contains additional game information that is specific for the game of Go (e.g. komi). More...

#include <ISgfcGoGameInfo.h>

Inheritance diagram for LibSgfcPlusPlus::ISgfcGoGameInfo:

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

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

virtual SgfcNumber	GetNumberOfHandicapStones () const =0
	Returns the number of handicap stones. The default value is SgfcConstants::HandicapStonesNone.

virtual void	SetNumberOfHandicapStones (SgfcNumber numberOfHandicapStones)=0
	Sets the number of handicap stones.

virtual SgfcReal	GetKomi () const =0
	Returns the komi. The default value is SgfcConstants::KomiNone.

virtual void	SetKomi (SgfcReal komi)=0
	Sets the komi.

virtual SgfcGoRuleset	GetGoRuleset () const =0
	Returns the Go ruleset used for the game. The default value is an SgfcGoRuleset object which has the IsValid property set to false.

virtual void	SetGoRuleset (SgfcGoRuleset goRuleset)=0
	Sets the Go ruleset used for the game.

virtual SgfcGoPlayerRank	GetGoBlackPlayerRank () const =0
	Returns the rank of the black player. The default value is an SgfcGoPlayerRank object which has the IsValid property set to false.

virtual void	SetGoBlackPlayerRank (SgfcGoPlayerRank goBlackPlayerRank)=0
	Sets the rank of the black player.

virtual SgfcGoPlayerRank	GetGoWhitePlayerRank () const =0
	Returns the rank of the white player. The default value is an SgfcGoPlayerRank object which has the IsValid property set to false.

virtual void	SetGoWhitePlayerRank (SgfcGoPlayerRank goWhitePlayerRank)=0
	Sets the rank of the white player.

Public Member Functions inherited from LibSgfcPlusPlus::ISgfcGameInfo
	ISgfcGameInfo ()
	Initializes a newly constructed ISgfcGameInfo object.

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

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.

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).

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.

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.

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.

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 ISgfcGoGameInfo interface is a specialization of ISgfcGameInfo that contains additional game information that is specific for the game of Go (e.g. komi).

Member Function Documentation

◆ GetGoBlackPlayerRank()

virtual SgfcGoPlayerRank LibSgfcPlusPlus::ISgfcGoGameInfo::GetGoBlackPlayerRank ( ) const

pure virtual

Returns the rank of the black player. The default value is an SgfcGoPlayerRank object which has the IsValid property set to false.

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

Invoking the base class method SetBlackPlayerRank() also changes the information returned by this method.

See also: SgfcPropertyType::BR

Implemented in LibSgfcPlusPlus::SgfcGoGameInfo.

◆ GetGoRuleset()

virtual SgfcGoRuleset LibSgfcPlusPlus::ISgfcGoGameInfo::GetGoRuleset ( ) const

pure virtual

Returns the Go ruleset used for the game. The default value is an SgfcGoRuleset object which has the IsValid property set to false.

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

Invoking the base class method SetRulesName() also changes the information returned by this method.

See also: SgfcPropertyType::RU

Implemented in LibSgfcPlusPlus::SgfcGoGameInfo.

◆ GetGoWhitePlayerRank()

virtual SgfcGoPlayerRank LibSgfcPlusPlus::ISgfcGoGameInfo::GetGoWhitePlayerRank ( ) const

pure virtual

Returns the rank of the white player. The default value is an SgfcGoPlayerRank object which has the IsValid property set to false.

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

Invoking the base class method SetWhitePlayerRank() also changes the information returned by this method.