Castor3D 0.16.0
Multiplatform 3D engine
Public Types | Public Member Functions | Public Attributes | List of all members
castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > > Class Template Reference

Specified parser parameter. More...

#include <ParserParameter.hpp>

Inheritance diagram for castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >:
Inheritance graph
[legend]
Collaboration diagram for castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >:
Collaboration graph
[legend]

Public Types

using ValueType = ParserParameterValueType< Type >
 

Public Member Functions

 ParserParameter ()=default
 
 ParserParameter (ValueType rhs)
 Constructor.
 
ParameterType getType () const override
 
StringView getStrType () const override
 
ParserParameterBaseSPtr clone () const override
 
bool parse (LoggerInstance &logger, String &params) override
 Checks the parameter.
 
bool isSet () override
 
- Public Member Functions inherited from castor::ParserParameterBase
CU_API ParserParameterBase ()=default
 Constructor.
 
CU_API ParserParameterBase (ParserParameterBase const &)=default
 
CU_API ParserParameterBase (ParserParameterBase &&) noexcept=default
 
CU_API ParserParameterBaseoperator= (ParserParameterBase const &)=default
 
CU_API ParserParameterBaseoperator= (ParserParameterBase &&) noexcept=default
 
virtual CU_API ~ParserParameterBase () noexcept=default
 
virtual CU_API ParameterType getBaseType () const
 
template<typename T >
T const & get (T &value) const
 Retrieves the parameter value.
 
template<typename T >
get () const
 

Public Attributes

ValueType m_value {}
 
bool m_set {}
 

Detailed Description

template<ParameterType Type>
class castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >

Specified parser parameter.

Member Typedef Documentation

◆ ValueType

template<ParameterType Type>
using castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::ValueType = ParserParameterValueType< Type >

The parameter value type.

Constructor & Destructor Documentation

◆ ParserParameter() [1/2]

template<ParameterType Type>
castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::ParserParameter ( )
default

◆ ParserParameter() [2/2]

template<ParameterType Type>
castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::ParserParameter ( ValueType rhs)
inlineexplicit

Constructor.

Member Function Documentation

◆ clone()

template<ParameterType Type>
ParserParameterBaseSPtr castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::clone ( ) const
inlineoverridevirtual

Returns
A copy of this parameter.

Implements castor::ParserParameterBase.

◆ getStrType()

template<ParameterType Type>
StringView castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::getStrType ( ) const
inlineoverridevirtual

Returns
The parameter string type.

Implements castor::ParserParameterBase.

◆ getType()

template<ParameterType Type>
ParameterType castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::getType ( ) const
inlineoverridevirtual

Returns
The parameter type.

Implements castor::ParserParameterBase.

◆ isSet()

template<ParameterType Type>
bool castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::isSet ( )
inlineoverridevirtual

Returns
false if the parameter is not set.

Implements castor::ParserParameterBase.

◆ parse()

template<ParameterType Type>
bool castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::parse ( LoggerInstance & logger,
String & params )
inlineoverridevirtual

Checks the parameter.

Parameters
[in,out]loggerThe logger instance.
[in,out]paramsThe text containing the parameter value.
Returns
false if any error occured.

Implements castor::ParserParameterBase.

Member Data Documentation

◆ m_set

template<ParameterType Type>
bool castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::m_set {}

The parameter value.

◆ m_value

template<ParameterType Type>
ValueType castor::ParserParameter< Type, std::enable_if_t< !hasBaseParameterTypeV< Type > &&!isArithmeticTypeV< Type > > >::m_value {}

The parameter value.


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