ParameterResult Class Reference

The return type used in all falible parameters methods. More...

#include <result.hh>

Public Member Functions
IGNITION_TRANSPORT_PARAMETERS_VISIBLE	ParameterResult (ParameterResultType _resultType)
	Construct. More...
IGNITION_TRANSPORT_PARAMETERS_VISIBLE	ParameterResult (ParameterResultType _resultType, const std::string &_paramName)
	Construct. More...
IGNITION_TRANSPORT_PARAMETERS_VISIBLE	ParameterResult (ParameterResultType _resultType, const std::string &_paramName, const std::string &_paramType)
	Construct. More...
IGNITION_TRANSPORT_PARAMETERS_VISIBLE	operator bool () const
	Coercion to bool type. True if ParameterErrorType::Success, else False. More...
const IGNITION_TRANSPORT_PARAMETERS_VISIBLE std::string &	ParamName () const
	Return the related parameter name. More...
const IGNITION_TRANSPORT_PARAMETERS_VISIBLE std::string &	ParamType () const
	Return the related parameter type. More...
IGNITION_TRANSPORT_PARAMETERS_VISIBLE ParameterResultType	ResultType () const
	Return the result type. More...

Detailed Description

The return type used in all falible parameters methods.

Constructor & Destructor Documentation

ParameterResult() [1/3]

IGNITION_TRANSPORT_PARAMETERS_VISIBLE ParameterResult ( ParameterResultType  _resultType )

explicit

Construct.

Parameters

_resultType

Type of result of the operation.

ParameterResult() [2/3]

IGNITION_TRANSPORT_PARAMETERS_VISIBLE ParameterResult	(	ParameterResultType	_resultType,
		const std::string &	_paramName
	)

Construct.

Parameters

_resultType	Type of result of the operation.
_paramName	Name of the related parameter.

ParameterResult() [3/3]

IGNITION_TRANSPORT_PARAMETERS_VISIBLE ParameterResult	(	ParameterResultType	_resultType,
		const std::string &	_paramName,
		const std::string &	_paramType
	)

Construct.

Parameters

_resultType	Type of result of the operation.
_paramName	Name of the related parameter.
_paramType	Type of the related parameter.

Member Function Documentation

operator bool()

IGNITION_TRANSPORT_PARAMETERS_VISIBLE operator bool ( ) const

explicit

Coercion to bool type. True if ParameterErrorType::Success, else False.

ParamName()

const IGNITION_TRANSPORT_PARAMETERS_VISIBLE std::string& ParamName

(

)

const

Return the related parameter name.

ParamType()

const IGNITION_TRANSPORT_PARAMETERS_VISIBLE std::string& ParamType

(

)

const

Return the related parameter type.

ResultType()

IGNITION_TRANSPORT_PARAMETERS_VISIBLE ParameterResultType ResultType

(

)

const

Return the result type.

---

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

• gz/transport/parameters/result.hh