Package com.viam.sdk.core.resource

Class Resource

java.lang.Object

com.viam.sdk.core.resource.Resource

Direct Known Subclasses:

Component, Service

public abstract class Resource
extends Object

The base requirements for a Resource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Resource.Reconfigurable	Defines the requirements for a Resource to be Reconfigurable.
static interface	Resource.Stoppable	Defines the requirements for a Resource to be Stoppable.

Constructor Summary

Constructors

Constructor	Description
Resource(Subtype subtype, Common.ResourceName name)

Method Summary

Modifier and Type	Method	Description
void	close()	Safely shutdown the Resource and prevent further use.
Robot.Status	createStatus()	Create a generic Status for the Resource
com.google.protobuf.Struct	doCommand(Map<String,com.google.protobuf.Value> command)	Send/Receive arbitrary commands to the Resource
Common.ResourceName	getName()	Get the ResourceName of the Resource
Subtype	getSubtype()
protected static Common.ResourceName	named(Subtype subtype, String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Resource

public Resource(Subtype subtype,
 Common.ResourceName name)

Method Details

named

protected static Common.ResourceName named(Subtype subtype,
 String name)

getSubtype

public Subtype getSubtype()

getName

public Common.ResourceName getName()

Get the ResourceName of the Resource

Returns:

Resource's ResourceName

doCommand

public com.google.protobuf.Struct doCommand(Map<String,com.google.protobuf.Value> command)

Send/Receive arbitrary commands to the Resource

Parameters:

command - the command to execute

Returns:

result of the executed command

createStatus

public Robot.Status createStatus()

Create a generic Status for the Resource

Returns:

a Status

close

public void close()

Safely shutdown the Resource and prevent further use. This function must be idempotent.