flux sdk  v01.02.02-3-g292b3a7
Embedded C++ SDK
Loading...
Searching...
No Matches
flxIFileSystem Class Referenceabstract

#include <flxFS.h>

Inheritance diagram for flxIFileSystem:
flxDescriptor _flxFSSDMMCard flxFSSDMMCard

Public Types

enum  flxFileOpenMode_t { kFileWrite = 1 , kFileRead , kFileAppend }
 

Public Member Functions

virtual flxFSFile open (const char *name, flxFileOpenMode_t mode, bool create=false)=0
 
virtual bool exists (const char *name)=0
 
virtual bool remove (const char *name)=0
 
virtual bool rename (const char *nameFrom, const char *nameTo)=0
 
virtual bool mkdir (const char *path)=0
 
virtual bool rmdir (const char *path)=0
 
virtual uint64_t size (void)=0
 
virtual const char * type (void)=0
 
virtual bool enabled (void)=0
 
virtual FS fileSystem (void)=0
 
- Public Member Functions inherited from flxDescriptor
 flxDescriptor ()
 
void setName (const char *new_name)
 Set the Name object - storing the pointer to the provided string No allocation is performed. If the previous name was allocated, it is freed. More...
 
void setName (const char *new_name, const char *new_desc)
 Set the Name object and the Description for the object. Both strings are constants. More...
 
void setName (char *new_name)
 Set the Name object, but makes a copy of the input string since the input is not const. If the previous name was allocated, it is freed. More...
 
const char * name ()
 Return a const char pointer to the name of the object. More...
 
std::string name_ (void)
 Returns a std::string of the name of the object. More...
 
void setDescription (const char *new_desc)
 Set the Description object - the input value is constant and not copied. If the previous description was allocated, it is freed. More...
 
void setDescription (char *new_desc)
 Set the Description object - the input value is not constant and is copied. If the previous description was allocated, it is freed. More...
 
const char * description ()
 Return the constant C string pointer to the description of the object. More...
 
std::string description_ (void)
 Return the description of the object as a std::string. More...
 
void setTitle (const char *title)
 Set the Title object - the title is optional and is used mostly for UX or organizational purposes. The input value is constant and not copied. If the previous title was allocated, it is freed. More...
 
void setTitleAlloc (char *new_title)
 Set the Title of the object , but make an explict copy of the provided string. More...
 
const char * title (void)
 Return the C constant string pointer to the title of the object. More...
 

Additional Inherited Members

- Protected Attributes inherited from flxDescriptor
const char * _name
 
bool _nameAlloc
 
const char * _desc
 
bool _descAlloc
 
const char * _title
 
bool _titleAlloc
 

Member Enumeration Documentation

◆ flxFileOpenMode_t

Enumerator
kFileWrite 
kFileRead 
kFileAppend 

Member Function Documentation

◆ enabled()

virtual bool flxIFileSystem::enabled ( void  )
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ exists()

virtual bool flxIFileSystem::exists ( const char *  name)
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ fileSystem()

virtual FS flxIFileSystem::fileSystem ( void  )
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ mkdir()

virtual bool flxIFileSystem::mkdir ( const char *  path)
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ open()

virtual flxFSFile flxIFileSystem::open ( const char *  name,
flxFileOpenMode_t  mode,
bool  create = false 
)
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ remove()

virtual bool flxIFileSystem::remove ( const char *  name)
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ rename()

virtual bool flxIFileSystem::rename ( const char *  nameFrom,
const char *  nameTo 
)
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ rmdir()

virtual bool flxIFileSystem::rmdir ( const char *  path)
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ size()

virtual uint64_t flxIFileSystem::size ( void  )
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.

◆ type()

virtual const char * flxIFileSystem::type ( void  )
pure virtual

Implemented in _flxFSSDMMCard, and flxFSSDMMCard.


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