C++ guide and API reference#
Link against isaacsim::ovsim-api.
#include <isaacsim/ovsim/api/Factory.hpp>
Namespace: isaacsim::ovsim::api
Client factory#
// name is "in-process" / "local", or "grpc".
types::Implementation client = makeClient("in-process");
// gRPC clients accept an optional configuration map (e.g. connection target).
types::Implementation remote = makeClient("grpc", { { "endpoint", "127.0.0.1:50051" } });
Implementation#
#include <isaacsim/ovsim/api/Types.hpp>
types::Implementation bundles the control (authoring + simulation) and data
interfaces returned by isaacsim::ovsim::api::makeClient(). Each member is a struct of std::function
fields with the same signatures as the free functions in isaacsim::foundation::ovsim and
isaacsim::physics::ovsim.
types::Implementation client = makeClient("in-process");
bool created = client.control.authoring.createStage();
OutputValueType values = client.data.read(paths, "attributeName");
API reference#
Fully qualified namespace: isaacsim::ovsim::api
-
namespace api#
Functions Summary#
- types::Implementation makeClient(const std::string &name, const std::optional< std::unordered_map< std::string, std::string > > &configuration=std::nullopt)
Create an OV SIM client implementation.