Gazebo Transport

API Reference

12.2.1
gz::transport::parameters Namespace Reference

Classes

class  ParameterResult
 The return type used in all falible parameters methods. More...
 
class  ParametersClient
 Allow to get, set, declare or list parameters. More...
 
class  ParametersInterface
 Common interface, implemented by ParametersRegistry (local updates) and by ParametersClients (remote requests). More...
 
class  ParametersRegistry
 Provides a parameter registry. Parameters can be declared, get or set in the registry. It also provides services, so the parameters can be get, set or listed from other processes. More...
 

Enumerations

enum  ParameterResultType {
  Success, AlreadyDeclared, InvalidType, NotDeclared,
  ClientTimeout, Unexpected
}
 Possible result types of the different parameters operations. More...
 

Functions

GZ_TRANSPORT_PARAMETERS_VISIBLE std::ostreamoperator<< (std::ostream &, const ParameterResult &)
 Stream operator, for debug output. More...
 

Enumeration Type Documentation

◆ ParameterResultType

enum ParameterResultType
strong

Possible result types of the different parameters operations.

Enumerator
Success 
AlreadyDeclared 
InvalidType 
NotDeclared 
ClientTimeout 
Unexpected 

Function Documentation

◆ operator<<()

GZ_TRANSPORT_PARAMETERS_VISIBLE std::ostream& gz::transport::parameters::operator<< ( std::ostream ,
const ParameterResult  
)

Stream operator, for debug output.