gz/fuel_tools/FuelClient.hh
High level interface to ignition fuel.
Definition: gz/fuel_tools/ClientConfig.hh:109
class for iterating through models
Definition: gz/fuel_tools/ModelIter.hh:43
Result UploadModel(const std::string &_pathToModelDir, const ModelIdentifier &_id, const std::vector< std::string > &_headers, bool _private=false)
Upload a directory as a new model.
STL class.
High level interface to ignition fuel.
Definition: gz/fuel_tools/FuelClient.hh:53
STL class.
ClientConfig & Config()
Get a mutable reference to the client configuration.
Result PatchModel(const ModelIdentifier &_model, const std::vector< std::string > &_headers)
Update a model using a PATCH request.
Defines how to identify a model.
Definition: gz/fuel_tools/ModelIdentifier.hh:45
std::vector< ModelResult > DownloadModels(const std::vector< ModelIdentifier > &_ids, size_t _jobs=2)
Download a list of models from ignition fuel.
ModelIter Models(const ServerConfig &_server)
Returns an iterator that can return names of models.
Class describing a result of an operation.
Definition: gz/fuel_tools/Result.hh:89
Result DeleteModel(const ModelIdentifier &_id)
Remove a model from ignition fuel.
class for iterating through worlds
Definition: gz/fuel_tools/WorldIter.hh:42
Result CachedWorld(const common::URI &_worldUrl, std::string &_path)
Check if a world is already present in the local cache.
bool ParseCollectionUrl(const common::URI &_url, CollectionIdentifier &_id)
Parse Collection identifer from URL.
bool ParseModelUrl(const common::URI &_modelUrl, ModelIdentifier &_id)
Parse model identifier from model URL or unique name.
Result DownloadWorld(WorldIdentifier &_id)
Download a world from Ignition Fuel. This will override an existing local copy of the world.
Result DownloadModel(const ModelIdentifier &_id)
Download a model from ignition fuel. This will override an existing local copy of the model.
Describes options needed for a server.
Definition: gz/fuel_tools/ClientConfig.hh:47
bool ParseModelFileUrl(const common::URI &_modelFileUrl, ModelIdentifier &_id, std::string &_filePath)
Parse model file identifier from model file URL.
Result ModelDependencies(const ModelIdentifier &_id, std::vector< ModelIdentifier > &_dependencies)
Retrieve the list of dependencies for a model.
bool ParseWorldUrl(const common::URI &_worldUrl, WorldIdentifier &_id)
Parse world identifier from world URL or unique name.
Result DeleteUrl(const gz::common::URI &_uri, const std::vector< std::string > &_headers)
Remove a resource, such as a model or world, from Ignition Fuel.
Result ModelDetails(const ModelIdentifier &_id, ModelIdentifier &_model) const
Fetch the details of a model.
A helper class for making REST requests.
Definition: gz/fuel_tools/RestClient.hh:80
Result CachedModel(const common::URI &_modelUrl, std::string &_path)
Check if a model is already present in the local cache.
Defines how to identify a world.
Definition: gz/fuel_tools/WorldIdentifier.hh:42
void PopulateLicenses(const ServerConfig &_server)
This function requests the available licenses from the Fuel server and stores this information locall...
bool ParseWorldFileUrl(const common::URI &_worldFileUrl, WorldIdentifier &_id, std::string &_filePath)
Parse world file identifier from world file URL.
Result CachedModelFile(const common::URI &_fileUrl, std::string &_path)
Check if a file belonging to a model is already present in the local cache.
Defines how to identify a collection.
Definition: gz/fuel_tools/CollectionIdentifier.hh:42
Result CachedWorldFile(const common::URI &_fileUrl, std::string &_path)
Check if a file belonging to a world is already present in the local cache.
Result DownloadWorlds(const std::vector< WorldIdentifier > &_ids, size_t _jobs=2)
Download a list of mworlds from ignition fuel.
WorldIter Worlds(const ServerConfig &_server) const
Returns an iterator that can return information of worlds.
Result WorldDetails(const WorldIdentifier &_id, WorldIdentifier &_world) const
Fetch the details of a world.
Class for managing stuff in the local cache.
Definition: gz/fuel_tools/LocalCache.hh:46