LibSgfcPlusPlus::ISgfcArgument Class Reference

The ISgfcArgument interface represents a single argument to be passed on to SGFC when it reads or writes SGF content. Depending on the argument type, the argument also has either an integer type or an SgfcPropertyType parameter. More...

#include <ISgfcArgument.h>

Inheritance diagram for LibSgfcPlusPlus::ISgfcArgument:

Public Member Functions
	ISgfcArgument ()
	Initializes a newly constructed ISgfcArgument object.
virtual	~ISgfcArgument ()
	Destroys and cleans up the ISgfcArgument object.
virtual SgfcArgumentType	GetArgumentType () const =0
	Returns the argument type.
virtual bool	HasIntegerTypeParameter () const =0
	Returns true if the argument has an integer type parameter.
virtual int	GetIntegerTypeParameter () const =0
	Returns the argument's integer type parameter value. The return value is undefined if HasIntegerTypeParameter() returns false.
virtual bool	HasStringTypeParameter () const =0
	Returns true if the argument has a string type parameter.
virtual std::string	GetStringTypeParameter () const =0
	Returns the argument's string type parameter value. The return value is undefined if HasStringTypeParameter() returns false.
virtual bool	HasPropertyTypeParameter () const =0
	Returns true if the argument has an SgfcPropertyType parameter.
virtual SgfcPropertyType	GetPropertyTypeParameter () const =0
	Returns the argument's SgfcPropertyType parameter value. The return value is undefined if HasPropertyTypeParameter() returns false.
virtual bool	HasMessageIDParameter () const =0
	Returns true if the argument has an SgfcMessageID parameter.
virtual SgfcMessageID	GetMessageIDParameter () const =0
	Returns the argument's SgfcMessageID parameter value. The return value is undefined if HasMessageIDParameter() returns false.
virtual std::string	ToString () const =0
	Returns the argument as a string, exactly as it would be specified on the SGFC command line. Examples: -n, -b1, -yMA.

Detailed Description

The ISgfcArgument interface represents a single argument to be passed on to SGFC when it reads or writes SGF content. Depending on the argument type, the argument also has either an integer type or an SgfcPropertyType parameter.

Member Function Documentation

GetArgumentType()

virtual SgfcArgumentType LibSgfcPlusPlus::ISgfcArgument::GetArgumentType ( ) const

pure virtual

Returns the argument type.

Implemented in LibSgfcPlusPlus::SgfcArgument.

GetIntegerTypeParameter()

virtual int LibSgfcPlusPlus::ISgfcArgument::GetIntegerTypeParameter ( ) const

pure virtual

Returns the argument's integer type parameter value. The return value is undefined if HasIntegerTypeParameter() returns false.

Implemented in LibSgfcPlusPlus::SgfcArgument.

GetMessageIDParameter()

virtual SgfcMessageID LibSgfcPlusPlus::ISgfcArgument::GetMessageIDParameter ( ) const

pure virtual

Returns the argument's SgfcMessageID parameter value. The return value is undefined if HasMessageIDParameter() returns false.

Implemented in LibSgfcPlusPlus::SgfcArgument.

GetPropertyTypeParameter()

virtual SgfcPropertyType LibSgfcPlusPlus::ISgfcArgument::GetPropertyTypeParameter ( ) const

pure virtual

Returns the argument's SgfcPropertyType parameter value. The return value is undefined if HasPropertyTypeParameter() returns false.

Implemented in LibSgfcPlusPlus::SgfcArgument.

GetStringTypeParameter()

virtual std::string LibSgfcPlusPlus::ISgfcArgument::GetStringTypeParameter ( ) const

pure virtual

Returns the argument's string type parameter value. The return value is undefined if HasStringTypeParameter() returns false.

Implemented in LibSgfcPlusPlus::SgfcArgument.

HasIntegerTypeParameter()

virtual bool LibSgfcPlusPlus::ISgfcArgument::HasIntegerTypeParameter ( ) const

pure virtual

Returns true if the argument has an integer type parameter.

Implemented in LibSgfcPlusPlus::SgfcArgument.

HasMessageIDParameter()

virtual bool LibSgfcPlusPlus::ISgfcArgument::HasMessageIDParameter ( ) const

pure virtual

Returns true if the argument has an SgfcMessageID parameter.

Implemented in LibSgfcPlusPlus::SgfcArgument.

HasPropertyTypeParameter()

virtual bool LibSgfcPlusPlus::ISgfcArgument::HasPropertyTypeParameter ( ) const

pure virtual

Returns true if the argument has an SgfcPropertyType parameter.

Implemented in LibSgfcPlusPlus::SgfcArgument.

HasStringTypeParameter()

virtual bool LibSgfcPlusPlus::ISgfcArgument::HasStringTypeParameter ( ) const

pure virtual

Returns true if the argument has a string type parameter.

Implemented in LibSgfcPlusPlus::SgfcArgument.

ToString()

virtual std::string LibSgfcPlusPlus::ISgfcArgument::ToString ( ) const

pure virtual

Returns the argument as a string, exactly as it would be specified on the SGFC command line. Examples: -n, -b1, -yMA.

Implemented in LibSgfcPlusPlus::SgfcArgument.

---

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

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