castor::ParserParameter< ParameterType::eCheckedText > Class Reference

ParserParameter specialisation for ParameterType::eCheckedText. More...

#include <ParserParameter.hpp>

Inheritance diagram for castor::ParserParameter< ParameterType::eCheckedText >:

Collaboration diagram for castor::ParserParameter< ParameterType::eCheckedText >:

Public Member Functions
	ParserParameter (UInt32StrMap const &values, StringView name=ParserParameterStringType< ParameterType::eCheckedText >)
	Constructor.
	ParserParameter (uint32_t value, UInt32StrMap const &values, StringView name=ParserParameterStringType< ParameterType::eCheckedText >)
	Constructor.
ParameterType	getType () const override
ParameterType	getBaseType () const override
StringView	getStrType () const override
ParserParameterBaseSPtr	clone () const override
bool	parse (LoggerInstance &logger, String &params) override
	Checks the parameter.

Public Attributes
StringView	m_name
UInt32StrMap const	m_values

Detailed Description

ParserParameter specialisation for ParameterType::eCheckedText.

Constructor & Destructor Documentation

ParserParameter() [1/2]

castor::ParserParameter< ParameterType::eCheckedText >::ParserParameter ( UInt32StrMap const & values, StringView name = ParserParameterStringType< ParameterType::eCheckedText > )

explicit

Constructor.

Parameters

[in]	values	The values used to validate the parsed value.
[in]	name	The parameter type name.

ParserParameter() [2/2]

castor::ParserParameter< ParameterType::eCheckedText >::ParserParameter ( uint32_t value, UInt32StrMap const & values, StringView name = ParserParameterStringType< ParameterType::eCheckedText > )

inlineexplicit

Constructor.

Member Function Documentation

clone()

ParserParameterBaseSPtr castor::ParserParameter< ParameterType::eCheckedText >::clone ( ) const

override

Returns

A copy of this parameter.

getBaseType()

ParameterType castor::ParserParameter< ParameterType::eCheckedText >::getBaseType ( ) const

override

Returns

The parameter base type (like ParameterType::eText for ParameterType::eName).

getStrType()

StringView castor::ParserParameter< ParameterType::eCheckedText >::getStrType ( ) const

override

Returns

The parameter string type.

getType()

ParameterType castor::ParserParameter< ParameterType::eCheckedText >::getType ( ) const

override

Returns

The parameter type.

parse()

bool castor::ParserParameter< ParameterType::eCheckedText >::parse ( LoggerInstance & logger, String & params )

override

Checks the parameter.

Parameters

[in,out]	logger	The logger instance.
[in,out]	params	The text containing the parameter value.

Returns

false if any error occured.

Member Data Documentation

m_name

StringView castor::ParserParameter< ParameterType::eCheckedText >::m_name

m_values

UInt32StrMap const castor::ParserParameter< ParameterType::eCheckedText >::m_values

---

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

• CastorUtils/FileParser/ParserParameter.hpp