Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1234]
▼Ngz | |
▼Ntransport | |
CAdvertiseMessageOptions | A class for customizing the publication options for a topic advertised. E.g.: Set the rate of messages per second published |
CAdvertiseOptions | A class for customizing the publication options for a topic or service advertised. E.g.: Set the scope of a topic/service |
CAdvertiseServiceOptions | A class for customizing the publication options for a service advertised |
CClock | A Clock interface for time tracking |
CFullyQualifiedTopic | Type for fully qualified topics |
CHandlerStorage | Class to store and manage service call handlers |
CIRepHandler | Interface class used to manage a replier handler |
CIReqHandler | Interface class used to manage a request handler |
CISubscriptionHandler | Interface class used to manage generic protobuf messages |
CMessageInfo | A class that provides information about the message received |
CMessagePublisher | This class stores all the information about a message publisher |
CNetworkClock | A Clock interface implementation that uses gz::msgs::Clock messages distributed across the network |
▼CNode | A class that allows a client to communicate with other peers. There are two main communication modes: pub/sub messages and service calls |
CPublisher | A class that is used to store information about an advertised publisher. An instance of this class is returned from Node::Advertise, and should be used in subsequent Node::Publisher::Publish calls |
CSubscriber | A class that is used to store information about an subscriber. An instance of this class is returned from Node::CreateSubscribe. When the object is destroyed, the corresponding subscription handler is removed from the node |
CNodeOptions | A class for customizing the behavior of the Node. E.g.: Set a custom namespace or a partition name |
▼CNodeShared | Private data for the Node class. This class should not be directly used. You should use the Node class |
CHandlerInfo | HandlerInfo contains information about callback handlers which is useful for local publishers and message receivers. You should only retrieve a HandlerInfo by calling CheckHandlerInfo(const std::string &_topic) const |
CHandlerWrapper | This struct wraps up the two different types of subscription handlers: normal (deserialized) and raw (serialized). This wrapper keeps the two sets of subscription handlers coordinated while allowing them to act independently when necessary |
CSubscriberInfo | This struct provides information about the Subscribers of a Publisher. It should only be retrieved using CheckSubscriberInfo(const std::string&, const std::string&) const. The relevant subscriber info is a superset of the relevant HandlerInfo so we extend that struct |
CPublisher | This class stores all the information about a publisher. It stores the topic name that publishes, addresses, UUIDs, scope, etc |
CRawSubscriptionHandler | |
CRepHandler | With the service response |
CReqHandler | It creates a reply handler for the specific protobuf messages used. 'Req' is a protobuf message type containing the input parameters of the service request. 'Rep' is a protobuf message type that will be filled with the service response |
CReqHandler< google::protobuf::Message, google::protobuf::Message > | |
CServicePublisher | This class stores all the information about a service publisher |
CStatistics | Computes the rolling average, min, max, and standard deviation for a set of samples |
CSubscribeOptions | A class to provide different options for a subscription |
CSubscriptionHandler | It creates a subscription handler for a specific protobuf message. 'T' is the Protobuf message type that will be used for this particular handler |
CSubscriptionHandler< ProtoMsg > | Specialized template when the user prefers a callbacks that accepts a generic google::protobuf::message instead of a specific type |
CSubscriptionHandlerBase | SubscriptionHandlerBase contains functions and data which are common to all SubscriptionHandler types |
CTopicStatistics | Encapsulates statistics for a single topic. The set of statistics include: |
CTopicStorage | Store address information about topics and provide convenient methods for adding new topics, removing them, etc |
CTopicUtils | This class provides different utilities related with topics |
CUuid | A portable class for representing a Universally Unique Identifier |
CWallClock | A Clock implementation that leverages host OS time APIs |
▼Nlog | |
CAllTopics | Query for all the topics |
CBatch | Holds the result of a query for messages |
CDescriptor | Meta-information about what a log contains. This may be useful for determining QueryOptions or for generating a high-level overview of a Log's contents |
CLog | Interface to a log file |
CMessage | Represents a message in a bag file |
CMsgIter | Implements iterator for reading messages |
CPlayback | Initiates playback of Gazebo Transport topics This class makes it easy to play topics from a log file |
CPlaybackHandle | Handles the playback of Gazebo Transport topics. This class allows you to manage a log playback once it has started. You must hang onto the PlaybackHandle or else the playback will end early |
CQualifiedTime | Since time is continuous, it may be difficult to know the exact time stamp of a desired message. The QualifiedTime class provides a way to tailor how a time stamp is interpreted by the message query |
CQualifiedTimeRange | Pair of qualified times that represent a range. This is used to specify a desired time range to the BasicQueryOptions class |
CQueryOptions | The QueryOptions interface is used by Log::QueryMessages() to determine which messages are retrieved from the log file |
CRecorder | Records Gazebo Transport topics This class makes it easy to record topics to a log file. Responsibilities: topic name matching, time received tracking, multiple thread safety, subscribing to topics |
CSqlParameter | A class which contains a SQL statement parameter. SqlParameter can be useful for keeping SQL queries sanitized and avoid SQL injection. With C++17, it may be desirable to replace this class with std::variant |
CSqlStatement | A statement for a SQL query. These are generated by the QueryOptions class to control how messages get queried from the log |
CTimeRangeOption | Base class which manages the time range settings for the native QueryOptions classes |
CTopicList | Specify a list of topics to query |
CTopicPattern | Specify a pattern of topics to query |
▼Nparameters | |
CParameterResult | The return type used in all falible parameters methods |
CParametersClient | Allow to get, set, declare or list parameters |
CParametersInterface | Common interface, implemented by ParametersRegistry (local updates) and by ParametersClients (remote requests) |
CParametersRegistry | 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 |
CReqHandler< google::protobuf::Message > | Template specialization for google::protobuf::Message. This is only used by some gz command line tools |
CSubscribeOpts |