Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidy nested namespaces #396

Merged
merged 4 commits into from
Jan 5, 2024
Merged

Tidy nested namespaces #396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
177c775
Tidy nested namespaces
mjcarroll Jan 4, 2024
a02c156
Split Client and Server Config files
mjcarroll Jan 4, 2024
097ce9e
Split out more types
mjcarroll Jan 4, 2024
8a56903
Address reviewer feedback
mjcarroll Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
220 changes: 77 additions & 143 deletions include/gz/fuel_tools/ClientConfig.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
#include <gz/common/URI.hh>

#include "gz/fuel_tools/Export.hh"
#include "gz/fuel_tools/ServerConfig.hh"

#ifdef _WIN32
// Disable warning C4251 which is triggered by
Expand All @@ -33,153 +34,86 @@
#pragma warning(disable: 4251)
#endif

namespace gz
namespace gz::fuel_tools
{
namespace fuel_tools
/// \brief Forward Declaration
class ClientConfigPrivate;

/// \brief High level interface to Gazebo Fuel.
///
class GZ_FUEL_TOOLS_VISIBLE ClientConfig
{
/// \brief forward declaration
class ServerConfigPrivate;

/// \brief Forward Declaration
class ClientConfigPrivate;

/// \brief Describes options needed for a server.
class GZ_FUEL_TOOLS_VISIBLE ServerConfig
{
/// \brief Constructor.
public: ServerConfig();

/// \brief Copy constructor.
/// \param[in] _orig The server config to copy.
public: ServerConfig(const ServerConfig &_orig);

/// \brief Assignment operator overload.
/// \param[in] _orig The server config to copy.
public: ServerConfig &operator=(const ServerConfig &_orig);

/// \brief Destructor.
public: ~ServerConfig();

/// \brief Clear the server config. This will set all values to empty
/// strings, except the version string which will be set to its default
/// value.
public: void Clear();

/// \brief Get the URL to access the server.
/// \return The URL of this server.
public: common::URI Url() const;

/// \brief Set the URL of this server.
/// \param[in] _url URL of this server.
public: void SetUrl(const common::URI &_url);

/// \brief Get the API key to auth with the server.
/// \return The API key.
public: std::string ApiKey() const;

/// \brief Set the API key to auth with the server.
/// \param[in] _key The API key.
public: void SetApiKey(const std::string &_key);

/// \brief Get the protocol version used with this server.
/// \return The version. E.g.: "1.0".
public: std::string Version() const;

/// \brief Set the protocol version used with this server.
/// \param[in] _version The version. E.g.: "1.0".
public: void SetVersion(const std::string &_version);

/// \brief Returns all the server information as a string.
/// \param[in] _prefix Optional prefix for every line of the string.
/// \return Server information string
public: std::string AsString(const std::string &_prefix = "") const;

/// \brief Returns all the available model information as a string using
/// colors for better human parsing.
/// \param[in] _prefix Optional prefix for every line of the string.
/// \return Model information string
public: std::string AsPrettyString(const std::string &_prefix = "") const;

/// \brief PIMPL
private: std::unique_ptr<ServerConfigPrivate> dataPtr;
};

/// \brief High level interface to Gazebo Fuel.
///
class GZ_FUEL_TOOLS_VISIBLE ClientConfig
{
/// \brief Constructor.
public: ClientConfig();

/// \brief Copy constructor.
/// \param[in] _copy ClientConfig to copy.
public: ClientConfig(const ClientConfig &_copy);

/// \brief Assignment operator overload.
/// \param[in] _copy ClientConfig to copy.
public: ClientConfig &operator=(const ClientConfig &_copy);

/// \brief Destructor.
public: ~ClientConfig();

/// \brief Clear the client config. This will set all values to empty
/// strings, except the user agent which will be set to its default
/// value.
public: void Clear();

/// \brief Set the user agent name.
/// \param[in] _agent User agent name.
public: void SetUserAgent(const std::string &_agent);

/// \brief Get the user agent name.
/// \return Name of the user agent.
public: const std::string &UserAgent() const;

/// \brief Load a YAML configuration file.
/// \param[in] _file Config file to load.
/// \return True if the configuration was loaded correctly.
/// \sa ConfigPath
public: bool LoadConfig(const std::string &_file);

/// \brief Get the location of the configuration file.
/// \return Path to the configuration file, which is set via
/// LoadConfig. The default return value is an empty string.
/// \sa LoadConfig
public: std::string ConfigPath() const;

/// \brief List of servers the client will connect to.
/// \return The list of servers.
public: std::vector<ServerConfig> Servers() const;

/// \brief List of servers the client will connect to.
/// \return The list of servers.
public: std::vector<ServerConfig> & MutableServers() const;

/// \brief Add a server to the list.
/// \param[in] _srv The server config.
public: void AddServer(const ServerConfig &_srv);

/// \brief Where are models and stuff stored locally?
/// \return The location where assets are stored locally.
public: std::string CacheLocation() const;

/// \brief Set where models and stuff are saved.
/// \param[in] _path path on disk where models are saved.
public: void SetCacheLocation(const std::string &_path);

/// \brief Returns all the client information as a string.
/// \param[in] _prefix Optional prefix for every line of the string.
/// \return Client information string
public: std::string AsString(const std::string &_prefix = "") const;

/// \brief PIMPL
private: std::unique_ptr<ClientConfigPrivate> dataPtr;
};
}
}
/// \brief Constructor.
public: ClientConfig();

/// \brief Copy constructor.
/// \param[in] _copy ClientConfig to copy.
public: ClientConfig(const ClientConfig &_copy);

/// \brief Assignment operator overload.
/// \param[in] _copy ClientConfig to copy.
public: ClientConfig &operator=(const ClientConfig &_copy);

/// \brief Destructor.
public: ~ClientConfig();

/// \brief Clear the client config. This will set all values to empty
/// strings, except the user agent which will be set to its default
/// value.
public: void Clear();

/// \brief Set the user agent name.
/// \param[in] _agent User agent name.
public: void SetUserAgent(const std::string &_agent);

/// \brief Get the user agent name.
/// \return Name of the user agent.
public: const std::string &UserAgent() const;

/// \brief Load a YAML configuration file.
/// \param[in] _file Config file to load.
/// \return True if the configuration was loaded correctly.
/// \sa ConfigPath
public: bool LoadConfig(const std::string &_file);

/// \brief Get the location of the configuration file.
/// \return Path to the configuration file, which is set via
/// LoadConfig. The default return value is an empty string.
/// \sa LoadConfig
public: std::string ConfigPath() const;

/// \brief List of servers the client will connect to.
/// \return The list of servers.
public: std::vector<ServerConfig> Servers() const;

/// \brief List of servers the client will connect to.
/// \return The list of servers.
public: std::vector<ServerConfig> & MutableServers() const;

/// \brief Add a server to the list.
/// \param[in] _srv The server config.
public: void AddServer(const ServerConfig &_srv);

/// \brief Where are models and stuff stored locally?
/// \return The location where assets are stored locally.
public: std::string CacheLocation() const;

/// \brief Set where models and stuff are saved.
/// \param[in] _path path on disk where models are saved.
public: void SetCacheLocation(const std::string &_path);

/// \brief Returns all the client information as a string.
/// \param[in] _prefix Optional prefix for every line of the string.
/// \return Client information string
public: std::string AsString(const std::string &_prefix = "") const;

/// \brief PIMPL
private: std::unique_ptr<ClientConfigPrivate> dataPtr;
};
} // namespace gz::fuel_tools

#ifdef _MSC_VER
#pragma warning(pop)
#endif

#endif
#endif // GZ_FUEL_TOOLS_CLIENTCONFIG_HH_
Loading