The ISgfcComposedPropertyValue interface provides access to one of the values of a property of an SGF node. The value is a composite of two ISgfcSinglePropertyValue objects. More...
#include <ISgfcComposedPropertyValue.h>
Public Member Functions | |
| ISgfcComposedPropertyValue () | |
| Initializes a newly constructed ISgfcComposedPropertyValue object. | |
| virtual | ~ISgfcComposedPropertyValue () |
| Destroys and cleans up the ISgfcComposedPropertyValue object. | |
| virtual std::shared_ptr< ISgfcSinglePropertyValue > | GetValue1 () const =0 |
| Returns the first property value. | |
| virtual std::shared_ptr< ISgfcSinglePropertyValue > | GetValue2 () const =0 |
| Returns the second property value. | |
 Public Member Functions inherited from LibSgfcPlusPlus::ISgfcPropertyValue | |
| 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 ISgfcComposedPropertyValue interface provides access to one of the values of a property of an SGF node. The value is a composite of two ISgfcSinglePropertyValue objects.
The class name uses the term "composed" because that is how it appears in the SGF standard.
ISgfcComposedPropertyValue is immutable, i.e. once the ISgfcComposedPropertyValue object is constructed it cannot be changed.
Member Function Documentation
◆ GetValue1()
|
pure virtual |
Returns the first property value.
Implemented in LibSgfcPlusPlus::SgfcComposedPropertyValue.
◆ GetValue2()
|
pure virtual |
Returns the second property value.
Implemented in LibSgfcPlusPlus::SgfcComposedPropertyValue.
The documentation for this class was generated from the following files:
- /Users/patrick/dev/libsgfcplusplus/include/ISgfcComposedPropertyValue.h
- /Users/patrick/dev/libsgfcplusplus/src/interface/public/ISgfcComposedPropertyValue.cpp
