libsgfc++ 2.0.1
A C++ library that uses SGFC to read and write SGF (Smart Game Format) data.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
LibSgfcPlusPlus::SgfcPropertyBasicValueTypeDescriptor Class Reference

The SgfcPropertyBasicValueTypeDescriptor class provides an implementation of the ISgfcPropertyValueTypeDescriptor interface. See the interface header file for documentation. More...

#include <SgfcPropertyBasicValueTypeDescriptor.h>

Inheritance diagram for LibSgfcPlusPlus::SgfcPropertyBasicValueTypeDescriptor:
LibSgfcPlusPlus::ISgfcPropertyValueTypeDescriptor

Public Member Functions

 SgfcPropertyBasicValueTypeDescriptor (SgfcPropertyValueType valueType)
 Initializes a newly constructed SgfcPropertyBasicValueTypeDescriptor object.
 
virtual ~SgfcPropertyBasicValueTypeDescriptor ()
 Destroys and cleans up the SgfcPropertyBasicValueTypeDescriptor object.
 
virtual SgfcPropertyValueTypeDescriptorType GetDescriptorType () const override
 Returns the concrete type of the descriptor object. Depending on the value returned, a caller then knows which one of the convenience casting methods to use.
 
virtual const SgfcPropertyBasicValueTypeDescriptorToBasicValueTypeDescriptor () const override
 Returns an SgfcPropertyBasicValueTypeDescriptor object if GetDescriptorType() returns SgfcPropertyValueTypeDescriptorType::BasicValueType. Returns nullptr otherwise. The caller is not the owner of the returned object.
 
virtual SgfcPropertyValueType GetValueType () const
 Returns the value type defined by the SgfcPropertyBasicValueTypeDescriptor.
 
- Public Member Functions inherited from LibSgfcPlusPlus::ISgfcPropertyValueTypeDescriptor
 ISgfcPropertyValueTypeDescriptor ()
 Initializes a newly constructed ISgfcPropertyValueTypeDescriptor object.
 
virtual ~ISgfcPropertyValueTypeDescriptor ()
 Destroys and cleans up the ISgfcPropertyValueTypeDescriptor object.
 
virtual const SgfcPropertyDualValueTypeDescriptorToDualValueTypeDescriptor () const
 Returns an SgfcPropertyDualValueTypeDescriptor object if GetDescriptorType() returns SgfcPropertyValueTypeDescriptorType::DualValueType. Returns nullptr otherwise. The caller is not the owner of the returned object.
 
virtual const SgfcPropertyElistValueTypeDescriptorToElistValueTypeDescriptor () const
 Returns an SgfcPropertyListValueTypeDescriptor object if GetDescriptorType() returns SgfcPropertyValueTypeDescriptorType::ElistValueType. Returns nullptr otherwise. The caller is not the owner of the returned object.
 
virtual const SgfcPropertyListValueTypeDescriptorToListValueTypeDescriptor () const
 Returns an SgfcPropertyElistValueTypeDescriptor object if GetDescriptorType() returns SgfcPropertyValueTypeDescriptorType::ListValueType. Returns nullptr otherwise. The caller is not the owner of the returned object.
 
virtual const SgfcPropertyComposedValueTypeDescriptorToComposedValueTypeDescriptor () const
 Returns an SgfcPropertyComposedValueTypeDescriptor object if GetDescriptorType() returns SgfcPropertyValueTypeDescriptorType::ComposedValueType. Returns nullptr otherwise. The caller is not the owner of the returned object.
 

Detailed Description

The SgfcPropertyBasicValueTypeDescriptor class provides an implementation of the ISgfcPropertyValueTypeDescriptor interface. See the interface header file for documentation.

SgfcPropertyBasicValueTypeDescriptor defines the basic value type that a single non-composed SGF property value can have. GetValueType() returns that value type.

All ISgfcPropertyValueTypeDescriptor implementations except SgfcPropertyBasicValueTypeDescriptor define complex value types (lists, composed values) or alternate value types. Ultimately every one of these other descriptors can be broken down into one or more SgfcPropertyBasicValueTypeDescriptor objects.

Example: The "CA" property value is a SimpleText. GetValueType() in this case returns SgfcPropertyValueType::SimpleText.

Member Function Documentation

◆ GetDescriptorType()

SgfcPropertyValueTypeDescriptorType LibSgfcPlusPlus::SgfcPropertyBasicValueTypeDescriptor::GetDescriptorType ( ) const
overridevirtual

Returns the concrete type of the descriptor object. Depending on the value returned, a caller then knows which one of the convenience casting methods to use.

Implements LibSgfcPlusPlus::ISgfcPropertyValueTypeDescriptor.

◆ ToBasicValueTypeDescriptor()

const SgfcPropertyBasicValueTypeDescriptor * LibSgfcPlusPlus::SgfcPropertyBasicValueTypeDescriptor::ToBasicValueTypeDescriptor ( ) const
overridevirtual

Returns an SgfcPropertyBasicValueTypeDescriptor object if GetDescriptorType() returns SgfcPropertyValueTypeDescriptorType::BasicValueType. Returns nullptr otherwise. The caller is not the owner of the returned object.

Reimplemented from LibSgfcPlusPlus::ISgfcPropertyValueTypeDescriptor.


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