C++ guide and API reference#

Include isaacsim/ovsim/clients/grpc/GrpcSession.hpp and link isaacsim::ovsim-clients-grpc.

GrpcSession exposes the OV SIM authoring, simulation, and data interfaces through one session object. Construct it with a configuration map containing a non-empty endpoint channel target, such as 127.0.0.1:50051.

The client supports these remote operations:

  • importStageFromString and closeStage to create and delete a hosted simulation.

  • initialize to wait for the hosted simulation to become ready.

  • step for drift-free manual 60 Hz stepping.

  • read for latest-value reads using the protocol value codec.

  • write for immediate CPU float32 or float64 position arrays.

Other authoring and automatic-playback methods currently throw std::logic_error. Explicit or historical timestamps are not supported. Consult each method’s Doxygen contract for its validation and transport errors.

using isaacsim::ovsim::clients::grpc::GrpcSession;

GrpcSession client({ { "endpoint", "127.0.0.1:50051" } });
client.importStageFromString(usdContent);
client.initialize();
client.step();

The declarations and Doxygen comments in the public header are the authoritative C++ reference.

API reference#

Fully qualified namespace: isaacsim::ovsim::clients::grpc

namespace grpc#

Classes Summary#

GrpcSession

Minimal remote OV SIM client session using insecure gRPC.

Typedefs Summary#