viam::sdk::Stoppable Class Reference

Inheritance diagram for viam::sdk::Stoppable:

Public Member Functions
virtual void	stop (const ProtoStruct &extra)=0
	Stops a resource from running.
void	stop ()
	Stops a resource from running.

Static Public Member Functions
static void	stop_if_stoppable (const std::shared_ptr< Resource > &resource, const ProtoStruct &extra)
	Stops a Resource if it is Stoppable.
static void	stop_if_stoppable (const std::shared_ptr< Resource > &resource)
	Stops a Resource if it is Stoppable.

Member Function Documentation

stop()

virtual void viam::sdk::Stoppable::stop ( const ProtoStruct & extra )

pure virtual

Stops a resource from running.

Parameters

extra

Extra arguments to pass to the resource's stop method.

Implemented in MyBase, viam::sdk::impl::ArmClient, viam::sdk::impl::BaseClient, viam::sdk::impl::GantryClient, viam::sdk::impl::GripperClient, viam::sdk::impl::MotorClient, and viam::sdk::impl::ServoClient.

stop_if_stoppable() [1/2]

static void viam::sdk::Stoppable::stop_if_stoppable ( const std::shared_ptr< Resource > & resource )

inlinestatic

Stops a Resource if it is Stoppable.

Parameters

resource

The Resource to stop.

stop_if_stoppable() [2/2]

static void viam::sdk::Stoppable::stop_if_stoppable ( const std::shared_ptr< Resource > & resource, const ProtoStruct & extra )

static

Stops a Resource if it is Stoppable.

Parameters

resource	The Resource to stop.
extra	Extra arguments to pass to the resource's stop method.

---

The documentation for this class was generated from the following file:

• src/viam/sdk/resource/stoppable.hpp