CbmRoot
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | List of all members
cbm::util::yaml::Property< Class, T > Class Template Reference

#include <CbmYamlProperty.h>

Public Types

using ClassType = Class
 
using ValueType = T
 

Public Member Functions

 Property ()=delete
 
constexpr Property (T Class::*member, std::string_view key, std::string_view description="", std::optional< YAML::EMITTER_MANIP > fmt={}, std::optional< YAML::EMITTER_MANIP > fmtEntries={})
 
 Property (const Property &)=delete
 
Property & operator= (const Property &)=delete
 
 Property (Property &&)=default
 
Property & operator= (Property &&)=default
 
std::string_view Key () const
 
std::string_view Description () const
 
std::optional< YAML::EMITTER_MANIP > Format () const
 
std::optional< YAML::EMITTER_MANIP > FormatEntries () const
 
T & Get (Class &object) const
 
const T & Get (const Class &object) const
 
void Set (Class &object, const T &value) const
 

Private Attributes

T Class::* fMember
 
std::string_view fKey
 
std::string_view fDescription
 
std::optional< YAML::EMITTER_MANIP > fFormat
 
std::optional< YAML::EMITTER_MANIP > fFormatEntries
 

Detailed Description

template<typename Class, typename T>
class cbm::util::yaml::Property< Class, T >

Definition at line 18 of file CbmYamlProperty.h.

Member Typedef Documentation

◆ ClassType

template<typename Class, typename T>
using cbm::util::yaml::Property< Class, T >::ClassType = Class

Definition at line 28 of file CbmYamlProperty.h.

◆ ValueType

template<typename Class, typename T>
using cbm::util::yaml::Property< Class, T >::ValueType = T

Definition at line 29 of file CbmYamlProperty.h.

Constructor & Destructor Documentation

◆ Property() [1/4]

template<typename Class, typename T>
cbm::util::yaml::Property< Class, T >::Property ( )
delete

Referenced by operator=(), operator=(), Property(), and Property().

◆ Property() [2/4]

template<typename Class, typename T>
cbm::util::yaml::Property< Class, T >::Property ( T Class::* member,
std::string_view key,
std::string_view description = "",
std::optional< YAML::EMITTER_MANIP > fmt = {},
std::optional< YAML::EMITTER_MANIP > fmtEntries = {} )
inlineconstexpr

Definition at line 33 of file CbmYamlProperty.h.

◆ Property() [3/4]

template<typename Class, typename T>
cbm::util::yaml::Property< Class, T >::Property ( const Property< Class, T > & )
delete

References Property().

◆ Property() [4/4]

template<typename Class, typename T>
cbm::util::yaml::Property< Class, T >::Property ( Property< Class, T > && )
default

References Property().

Member Function Documentation

◆ Description()

template<typename Class, typename T>
std::string_view cbm::util::yaml::Property< Class, T >::Description ( ) const
inline

Definition at line 50 of file CbmYamlProperty.h.

References fDescription.

◆ Format()

template<typename Class, typename T>
std::optional< YAML::EMITTER_MANIP > cbm::util::yaml::Property< Class, T >::Format ( ) const
inline

Definition at line 51 of file CbmYamlProperty.h.

References fFormat.

◆ FormatEntries()

template<typename Class, typename T>
std::optional< YAML::EMITTER_MANIP > cbm::util::yaml::Property< Class, T >::FormatEntries ( ) const
inline

Definition at line 52 of file CbmYamlProperty.h.

References fFormatEntries.

◆ Get() [1/2]

template<typename Class, typename T>
T & cbm::util::yaml::Property< Class, T >::Get ( Class & object) const
inline

Definition at line 54 of file CbmYamlProperty.h.

References fMember.

◆ Get() [2/2]

template<typename Class, typename T>
const T & cbm::util::yaml::Property< Class, T >::Get ( const Class & object) const
inline

Definition at line 55 of file CbmYamlProperty.h.

References fMember.

◆ Key()

template<typename Class, typename T>
std::string_view cbm::util::yaml::Property< Class, T >::Key ( ) const
inline

Definition at line 49 of file CbmYamlProperty.h.

References fKey.

◆ operator=() [1/2]

template<typename Class, typename T>
Property & cbm::util::yaml::Property< Class, T >::operator= ( const Property< Class, T > & )
delete

References Property().

◆ operator=() [2/2]

template<typename Class, typename T>
Property & cbm::util::yaml::Property< Class, T >::operator= ( Property< Class, T > && )
default

References Property().

◆ Set()

template<typename Class, typename T>
void cbm::util::yaml::Property< Class, T >::Set ( Class & object,
const T & value ) const
inline

Definition at line 57 of file CbmYamlProperty.h.

References fMember.

Member Data Documentation

◆ fDescription

template<typename Class, typename T>
std::string_view cbm::util::yaml::Property< Class, T >::fDescription
private

Definition at line 23 of file CbmYamlProperty.h.

Referenced by Description().

◆ fFormat

template<typename Class, typename T>
std::optional<YAML::EMITTER_MANIP> cbm::util::yaml::Property< Class, T >::fFormat
private

Definition at line 24 of file CbmYamlProperty.h.

Referenced by Format().

◆ fFormatEntries

template<typename Class, typename T>
std::optional<YAML::EMITTER_MANIP> cbm::util::yaml::Property< Class, T >::fFormatEntries
private

Definition at line 25 of file CbmYamlProperty.h.

Referenced by FormatEntries().

◆ fKey

template<typename Class, typename T>
std::string_view cbm::util::yaml::Property< Class, T >::fKey
private

Definition at line 22 of file CbmYamlProperty.h.

Referenced by Key().

◆ fMember

template<typename Class, typename T>
T Class::* cbm::util::yaml::Property< Class, T >::fMember
private

Definition at line 21 of file CbmYamlProperty.h.

Referenced by Get(), Get(), and Set().

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