Public Member Functions | Public Attributes | Private Attributes | List of all members
sr_grasp.GraspStash Class Reference
Inheritance diagram for sr_grasp.GraspStash:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self)
 
def as_yaml (self)
 
def get_all (self)
 
def get_grasp (self, grasp_index)
 
def get_grasp_array (self)
 
def get_grasp_at (self, idx)
 
def load_all (self)
 
def load_yaml (self, data)
 
def load_yaml_file (self, fname)
 
def put_grasp (self, grasp)
 
def save_yaml_file (self, fname="")
 
def size (self)
 

Public Attributes

 grasps_file
 

Private Attributes

 _store
 

Detailed Description

Interface to the list of grasps stored in the system. Clients should all
use this library so that it can deal with the detail of the undelying
storage.

Definition at line 106 of file __init__.py.

Constructor & Destructor Documentation

def sr_grasp.GraspStash.__init__ (   self)

Definition at line 113 of file __init__.py.

Member Function Documentation

def sr_grasp.GraspStash.as_yaml (   self)

Definition at line 155 of file __init__.py.

def sr_grasp.GraspStash.get_all (   self)
Return list of all grasps.

Definition at line 121 of file __init__.py.

def sr_grasp.GraspStash.get_grasp (   self,
  grasp_index 
)
Return a single grasp from the stash from it's id field.

Definition at line 130 of file __init__.py.

def sr_grasp.GraspStash.get_grasp_array (   self)

Definition at line 125 of file __init__.py.

def sr_grasp.GraspStash.get_grasp_at (   self,
  idx 
)
Return the Grasp at the given index.

Definition at line 134 of file __init__.py.

def sr_grasp.GraspStash.load_all (   self)
Load all configured sources of grasps into the stash.

Definition at line 151 of file __init__.py.

def sr_grasp.GraspStash.load_yaml (   self,
  data 
)
Load a set of grasps from a YAML object. Throws exceptions on errors.

Definition at line 170 of file __init__.py.

def sr_grasp.GraspStash.load_yaml_file (   self,
  fname 
)
Load a set of grasps from a YAML file.

Definition at line 158 of file __init__.py.

def sr_grasp.GraspStash.put_grasp (   self,
  grasp 
)
Stash the given grasp, using it's id field, which must be set.

Definition at line 142 of file __init__.py.

def sr_grasp.GraspStash.save_yaml_file (   self,
  fname = "" 
)

Definition at line 176 of file __init__.py.

def sr_grasp.GraspStash.size (   self)
Return the number of grasps.

Definition at line 138 of file __init__.py.

Member Data Documentation

sr_grasp.GraspStash._store
private

Definition at line 115 of file __init__.py.

sr_grasp.GraspStash.grasps_file

Definition at line 117 of file __init__.py.


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


sr_grasp
Author(s): Mark Pitchless
autogenerated on Wed Oct 14 2020 04:05:13