Gazebo Transport

API Reference

13.4.0
ParameterResult Class Reference

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

#include <result.hh>

Public Member Functions

GZ_TRANSPORT_PARAMETERS_VISIBLE ParameterResult (ParameterResultType _resultType)
 Construct. More...
 
GZ_TRANSPORT_PARAMETERS_VISIBLE ParameterResult (ParameterResultType _resultType, const std::string &_paramName)
 Construct. More...
 
GZ_TRANSPORT_PARAMETERS_VISIBLE ParameterResult (ParameterResultType _resultType, const std::string &_paramName, const std::string &_paramType)
 Construct. More...
 
GZ_TRANSPORT_PARAMETERS_VISIBLE operator bool () const
 Coercion to bool type. True if ParameterErrorType::Success, else False. More...
 
GZ_TRANSPORT_PARAMETERS_VISIBLE const std::stringParamName () const
 Return the related parameter name. More...
 
GZ_TRANSPORT_PARAMETERS_VISIBLE const std::stringParamType () const
 Return the related parameter type. More...
 
GZ_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]

GZ_TRANSPORT_PARAMETERS_VISIBLE ParameterResult ( ParameterResultType  _resultType)
explicit

Construct.

Parameters
_resultTypeType of result of the operation.

◆ ParameterResult() [2/3]

GZ_TRANSPORT_PARAMETERS_VISIBLE ParameterResult ( ParameterResultType  _resultType,
const std::string _paramName 
)

Construct.

Parameters
_resultTypeType of result of the operation.
_paramNameName of the related parameter.

◆ ParameterResult() [3/3]

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

Construct.

Parameters
_resultTypeType of result of the operation.
_paramNameName of the related parameter.
_paramTypeType of the related parameter.

Member Function Documentation

◆ operator bool()

GZ_TRANSPORT_PARAMETERS_VISIBLE operator bool ( ) const
explicit

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

◆ ParamName()

GZ_TRANSPORT_PARAMETERS_VISIBLE const std::string& ParamName ( ) const

Return the related parameter name.

◆ ParamType()

GZ_TRANSPORT_PARAMETERS_VISIBLE const std::string& ParamType ( ) const

Return the related parameter type.

◆ ResultType()

GZ_TRANSPORT_PARAMETERS_VISIBLE ParameterResultType ResultType ( ) const

Return the result type.


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