Stroika::Foundation::Common::ReadOnlyProperty< T > Class Template Reference

#include <Property.h>

Inheritance diagram for Stroika::Foundation::Common::ReadOnlyProperty< T >:

Public Member Functions
	ReadOnlyProperty ()=delete
nonvirtual T	Get () const
nonvirtual	operator const T () const
nonvirtual const T	operator() () const

Detailed Description

template<typename T>
class Stroika::Foundation::Common::ReadOnlyProperty< T >

Implement C#-like syntax for read-only properties (syntactically like data members but backed by a getter function)

Note

Typically not used - use Property

ANYHOW - see @Property for design overview

We allow T to be of REFERENCE type for ReadOnlyProperties. Not sure its a good idea to be returning a const T& from a property, but it works/is allowed (for now).

Note - unlike with functions - you cannot overload properties, making one return const T& and one return T&

Note

Thread-Safety SAME AS T/GETTER - all methods have exactly the thread safety of the underlying GETTER

Definition at line 128 of file Property.h.

Constructor & Destructor Documentation

ReadOnlyProperty()

template<typename T >

Stroika::Foundation::Common::ReadOnlyProperty< T >::ReadOnlyProperty ( )

delete

ReadOnlyProperty are NOT movable, nor copy constructible: the data doesn't logically exist in the property itself, but in its relationship to some parent object; if it were copied, it might be copied TO some place that didn't have an appropriate enclosing object.

Member Function Documentation

Get()

template<typename T >
requires (not IPropertyMutatable<T>)

T Stroika::Foundation::Common::ReadOnlyProperty< T >::Get

(

)

const

Returns the value of the given property T (by calling the underlying 'getter' for the property. This is a non-const method if PropertyCommon::kIsMutableType<T>, and otherwise a const method.

Definition at line 24 of file Property.inl.

operator const T()

template<typename T >
requires (not IPropertyMutatable<T>)

Stroika::Foundation::Common::ReadOnlyProperty< T >::operator const T

(

)

const

A ReadOnlyProperty can be automatically converted to its underlying base type. Due to how conversion operators work, this won't always be helpful (like with overloading or multiple levels of conversions, for example with optional<int> compare with int property). But when it works (80% of the time) - its helpful.

When it doesn't work, simply throw in '()' - to use the 'operator()' call, or call Get() if you prefer that syntax.

This is a non-const method if PropertyCommon::kIsMutableType<T>, and otherwise a const method.

Definition at line 36 of file Property.inl.

operator()()

template<typename T >
requires (not IPropertyMutatable<T>)

const T Stroika::Foundation::Common::ReadOnlyProperty< T >::operator()

(

)

const

This works 100% of the time. Just use the function syntax, and you get back a copy of the desired underlying type.

Example Usage

namespace PredefinedInternetMediaType {  const inline Common::VirtualConstant<InternetMediaType> kPNG...
 
bool checkIsImage1 = PredefinedInternetMediaType::kPNG().IsA (InternetMediaTypes::Wildcards::kImage);

This is a non-const method if PropertyCommon::kIsMutableType<T>, and otherwise a const method.

Definition at line 48 of file Property.inl.

---

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

• Property.h
• Property.inl