niryo_libraries.niryo_robot_poses_handlers.file_manager.FileManager

class documentation

class FileManager(object):

Known subclasses: niryo_libraries.niryo_robot_poses_handlers.file_manager.PickleFileManager

Constructor: FileManager(base_dir, extension, protected_names)

View In Hierarchy

Manages the creation, storage and loading of objects that implement the functions from_dict and to_dict.

!!! This class is an abstract class

Raises
NiryoRobotFileException
Method __init__ Undocumented
Method check_exist Undocumented
Method exists Check if a file with a certain name exists
Method get_all_names Get all filenames available in storage
Method get_all_names_w_description Get all filenames available in storage + their descriptions
Method read Read file
Method read_description Undocumented
Method remove Remove file
Class Variable object_type Undocumented
Method _filename_from_name Undocumented
Method _name_from_filename Undocumented
Method _path_from_name Undocumented
Method _write Undocumented
Instance Variable _base_dir Undocumented
Instance Variable _extension Undocumented
Instance Variable _protected_names Undocumented
Instance Variable _suffix Undocumented
def __init__(self, base_dir, extension, protected_names=None):

Undocumented

def check_exist(self, name):

Undocumented

def exists(self, name):

Check if a file with a certain name exists

Parameters
name:strfile name
Returns
boolTrue if file exists, else False
def get_all_names(self):

Get all filenames available in storage

Returns
list[str]list of filenames
Raises
Unknown exceptionNiryoRobotFileException: if any error
def get_all_names_w_description(self):

Get all filenames available in storage + their descriptions

Returns
list[str]list of filenames
def read(self, name):
overridden in niryo_libraries.niryo_robot_poses_handlers.file_manager.PickleFileManager

Read file

Parameters
name:strfile name
Returns
object_typeAn object corresponding to object_type
Raises
Unknown exceptionNiryoRobotFileException: if any error
def read_description(self, name):

Undocumented

def remove(self, name):

Remove file

Parameters
name:strfile name
Returns
None
Raises
Unknown exceptionNiryoRobotFileException: if any error
object_type =

Undocumented

def _filename_from_name(self, name):

Undocumented

def _name_from_filename(self, filename):

Undocumented

def _path_from_name(self, name):

Undocumented

def _write(self, name, object_):
overridden in niryo_libraries.niryo_robot_poses_handlers.file_manager.PickleFileManager

Undocumented

_base_dir =

Undocumented

_extension =

Undocumented

_protected_names =

Undocumented

_suffix =

Undocumented