The SgfcColorPropertyValue class provides an implementation of the ISgfcColorPropertyValue interface. See the interface header file for documentation. More...
#include <SgfcColorPropertyValue.h>
Inheritance diagram for LibSgfcPlusPlus::SgfcColorPropertyValue:
Public Member Functions | |
| SgfcColorPropertyValue (const std::string &rawValue, SgfcColor colorValue) | |
| Initializes a newly constructed SgfcColorPropertyValue object. The object holds the Color value colorValue and the corresponding raw string value rawValue. | |
| virtual | ~SgfcColorPropertyValue () |
| Destroys and cleans up the SgfcColorPropertyValue object. | |
| virtual SgfcColor | GetColorValue () const override |
| Returns the property value interpreted as an SgfcColor value. | |
| virtual const ISgfcColorPropertyValue * | ToColorValue () const override |
| Returns an ISgfcColorPropertyValue object if GetValueType() returns SgfcPropertyValueType::Color. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
 Public Member Functions inherited from LibSgfcPlusPlus::SgfcSinglePropertyValue | |
| SgfcSinglePropertyValue (const std::string &rawValue) | |
| Initializes a newly constructed SgfcSinglePropertyValue object that has the raw property string value rawValue. The value type is SgfcPropertyValueType::Unknown, HasTypedValue() returns false and GetTypeConversionErrorMessage() returns an empty string. | |
| SgfcSinglePropertyValue (const std::string &rawValue, SgfcPropertyValueType valueType) | |
| Initializes a newly constructed SgfcSinglePropertyValue object that has the raw property string value rawValue and the value type valueType. HasTypedValue() returns true and GetTypeConversionErrorMessage() returns an empty string. | |
| SgfcSinglePropertyValue (const std::string &rawValue, SgfcPropertyValueType valueType, const std::string &typeConversionErrorMessage) | |
| Initializes a newly constructed SgfcSinglePropertyValue object that has the raw property string value rawValue and the value type valueType. HasTypedValue() returns false and GetTypeConversionErrorMessage() returns typeConversionErrorMessage. | |
| virtual | ~SgfcSinglePropertyValue () |
| Destroys and cleans up the SgfcSinglePropertyValue object. | |
| virtual bool | IsComposedValue () const override |
| 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 override |
| 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 SgfcPropertyValueType | GetValueType () const override |
| Returns the concrete type of the property value object. Depending on the value returned, a caller then knows which one of the convenience casting methods to use. | |
| virtual bool | HasTypedValue () const override |
| Returns true if the raw string value returned by GetRawValue() is available as a typed value. Otherwise returns false. | |
| virtual std::string | GetTypeConversionErrorMessage () const override |
| Returns an error message that describes why the raw string value returned by GetRawValue() could not be converted to the typed value returned by GetValueType(). | |
| virtual std::string | GetRawValue () const override |
| Returns the property value as a raw string, i.e. as close as possible as it appears in the original SGF content. | |
| virtual const ISgfcNumberPropertyValue * | ToNumberValue () const override |
| Returns an ISgfcNumberPropertyValue object if GetValueType() returns SgfcPropertyValueType::Number. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
| virtual const ISgfcRealPropertyValue * | ToRealValue () const override |
| Returns an ISgfcRealPropertyValue object if GetValueType() returns SgfcPropertyValueType::Real. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
| virtual const ISgfcDoublePropertyValue * | ToDoubleValue () const override |
| Returns an ISgfcDoublePropertyValue object if GetValueType() returns SgfcPropertyValueType::Double. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
| virtual const ISgfcSimpleTextPropertyValue * | ToSimpleTextValue () const override |
| Returns an ISgfcSimpleTextPropertyValue object if GetValueType() returns SgfcPropertyValueType::SimpleText. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
| virtual const ISgfcTextPropertyValue * | ToTextValue () const override |
| Returns an ISgfcTextPropertyValue object if GetValueType() returns SgfcPropertyValueType::Text. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
| virtual const ISgfcPointPropertyValue * | ToPointValue () const override |
| Returns an ISgfcPointPropertyValue object if GetValueType() returns SgfcPropertyValueType::Point. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
| virtual const ISgfcMovePropertyValue * | ToMoveValue () const override |
| Returns an ISgfcMovePropertyValue object if GetValueType() returns SgfcPropertyValueType::Move. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
| virtual const ISgfcStonePropertyValue * | ToStoneValue () const override |
| Returns an ISgfcStonePropertyValue object if GetValueType() returns SgfcPropertyValueType::Stone. Returns nullptr otherwise. The caller is not the owner of the returned object. | |
| Public Member Functions inherited from LibSgfcPlusPlus::ISgfcSinglePropertyValue | |
| ISgfcSinglePropertyValue () | |
| Initializes a newly constructed ISgfcSinglePropertyValue object. | |
| virtual | ~ISgfcSinglePropertyValue () |
| Destroys and cleans up the ISgfcSinglePropertyValue object. | |
| Public Member Functions inherited from LibSgfcPlusPlus::ISgfcPropertyValue | |
| ISgfcPropertyValue () | |
| Initializes a newly constructed ISgfcPropertyValue object. | |
| virtual | ~ISgfcPropertyValue () |
| Destroys and cleans up the ISgfcPropertyValue 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. | |
| Public Member Functions inherited from LibSgfcPlusPlus::ISgfcColorPropertyValue | |
| ISgfcColorPropertyValue () | |
| Initializes a newly constructed ISgfcColorPropertyValue object. | |
| virtual | ~ISgfcColorPropertyValue () |
| Destroys and cleans up the ISgfcColorPropertyValue object. | |
Detailed Description
The SgfcColorPropertyValue class provides an implementation of the ISgfcColorPropertyValue interface. See the interface header file for documentation.
Member Function Documentation
◆ GetColorValue()
|
overridevirtual |
Returns the property value interpreted as an SgfcColor value.
Implements LibSgfcPlusPlus::ISgfcColorPropertyValue.
◆ ToColorValue()
|
overridevirtual |
Returns an ISgfcColorPropertyValue object if GetValueType() returns SgfcPropertyValueType::Color. Returns nullptr otherwise. The caller is not the owner of the returned object.
Reimplemented from LibSgfcPlusPlus::SgfcSinglePropertyValue.
The documentation for this class was generated from the following files:
- /Users/patrick/dev/libsgfcplusplus/src/document/typedpropertyvalue/SgfcColorPropertyValue.h
- /Users/patrick/dev/libsgfcplusplus/src/document/typedpropertyvalue/SgfcColorPropertyValue.cpp
