LibSgfcPlusPlus::ISgfcPropertyValue Class Reference

The ISgfcPropertyValue interface provides access to one of the values of a property of an SGF node. More...

#include <ISgfcPropertyValue.h>

Inheritance diagram for LibSgfcPlusPlus::ISgfcPropertyValue:

Public Member Functions
	ISgfcPropertyValue ()
	Initializes a newly constructed ISgfcPropertyValue object.
virtual	~ISgfcPropertyValue ()
	Destroys and cleans up the ISgfcPropertyValue object.
virtual bool	IsComposedValue () const =0
	Returns true if the ISgfcPropertyValue object holds a "composed" value, i.e. a value that consists of a composite of two single values. Returns false if the ISgfcPropertyValue holds only a single value.
virtual const ISgfcSinglePropertyValue *	ToSingleValue () const
	Returns nullptr if IsComposedValue() returns true. Returns an ISgfcSinglePropertyValue object if IsComposedValue() returns false. The caller is not the owner of the ISgfcSinglePropertyValue object.
virtual const ISgfcComposedPropertyValue *	ToComposedValue () const
	Returns an ISgfcComposedPropertyValue object if IsComposedValue() returns true. Returns nullptr if IsComposedValue() returns false. The caller is not the owner of the ISgfcComposedPropertyValue object.

Detailed Description

The ISgfcPropertyValue interface provides access to one of the values of a property of an SGF node.

ISgfcPropertyValue is immutable, i.e. once the ISgfcPropertyValue object is constructed it cannot be changed.

Member Function Documentation

IsComposedValue()

virtual bool LibSgfcPlusPlus::ISgfcPropertyValue::IsComposedValue ( ) const

pure virtual

Returns true if the ISgfcPropertyValue object holds a "composed" value, i.e. a value that consists of a composite of two single values. Returns false if the ISgfcPropertyValue holds only a single value.

Implemented in LibSgfcPlusPlus::SgfcComposedPropertyValue, and LibSgfcPlusPlus::SgfcSinglePropertyValue.

ToComposedValue()

const ISgfcComposedPropertyValue * LibSgfcPlusPlus::ISgfcPropertyValue::ToComposedValue ( ) const

virtual

Returns an ISgfcComposedPropertyValue object if IsComposedValue() returns true. Returns nullptr if IsComposedValue() returns false. The caller is not the owner of the ISgfcComposedPropertyValue object.

Reimplemented in LibSgfcPlusPlus::SgfcComposedPropertyValue.

ToSingleValue()

const ISgfcSinglePropertyValue * LibSgfcPlusPlus::ISgfcPropertyValue::ToSingleValue ( ) const

virtual

Returns nullptr if IsComposedValue() returns true. Returns an ISgfcSinglePropertyValue object if IsComposedValue() returns false. The caller is not the owner of the ISgfcSinglePropertyValue object.

Reimplemented in LibSgfcPlusPlus::SgfcSinglePropertyValue.

---

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

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