_flxFSSDMMCard Class Reference

#include <flxFSSDMMCard.h>

Inheritance diagram for _flxFSSDMMCard:

Public Member Functions
	_flxFSSDMMCard (_flxFSSDMMCard const &)=delete
void	operator= (_flxFSSDMMCard const &)=delete
bool	initialize ()
bool	initialize (uint8_t pinCS)
bool	initialize (uint8_t pinCS, uint8_t pinPower)
void	setPower (bool powerOn)
bool	power (void)
void	setPowerPin (uint8_t pin)
void	setCSPin (uint8_t pin)
flxFSFile	open (const char *name, flxFileOpenMode_t mode, bool create=false)
bool	exists (const char *name)
bool	remove (const char *name)
bool	rename (const char *nameFrom, const char *nameTo)
bool	mkdir (const char *path)
bool	rmdir (const char *path)
uint64_t	size (void)
uint64_t	total (void)
const char *	type (void)
uint64_t	used (void)
bool	enabled (void)
FS	fileSystem (void)
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...

Static Public Member Functions
static _flxFSSDMMCard &	get (void)

Additional Inherited Members
Public Types inherited from flxIFileSystem
enum	flxFileOpenMode_t { kFileWrite = 1 , kFileRead , kFileAppend }
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Constructor & Destructor Documentation

_flxFSSDMMCard()

_flxFSSDMMCard::_flxFSSDMMCard ( _flxFSSDMMCard const &  )

delete

Member Function Documentation

enabled()

bool _flxFSSDMMCard::enabled ( void  )

inlinevirtual

Implements flxIFileSystem.

exists()

bool _flxFSSDMMCard::exists ( const char *  name )

virtual

Implements flxIFileSystem.

fileSystem()

FS _flxFSSDMMCard::fileSystem ( void  )

virtual

Implements flxIFileSystem.

get()

static _flxFSSDMMCard & _flxFSSDMMCard::get ( void  )

inlinestatic

initialize() [1/3]

bool _flxFSSDMMCard::initialize

(

)

initialize() [2/3]

bool _flxFSSDMMCard::initialize

(

uint8_t

pinCS

)

initialize() [3/3]

bool _flxFSSDMMCard::initialize	(	uint8_t	pinCS,
		uint8_t	pinPower
	)

mkdir()

bool _flxFSSDMMCard::mkdir ( const char *  path )

virtual

Implements flxIFileSystem.

open()

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

virtual

Implements flxIFileSystem.

operator=()

void _flxFSSDMMCard::operator= ( _flxFSSDMMCard const &  )

delete

power()

bool _flxFSSDMMCard::power ( void  )

inline

remove()

bool _flxFSSDMMCard::remove ( const char *  name )

virtual

Implements flxIFileSystem.

rename()

bool _flxFSSDMMCard::rename ( const char *  nameFrom, const char *  nameTo  )

virtual

Implements flxIFileSystem.

rmdir()

bool _flxFSSDMMCard::rmdir ( const char *  path )

virtual

Implements flxIFileSystem.

setCSPin()

void _flxFSSDMMCard::setCSPin ( uint8_t  pin )

inline

setPower()

void _flxFSSDMMCard::setPower

(

bool

powerOn

)

setPowerPin()

void _flxFSSDMMCard::setPowerPin ( uint8_t  pin )

inline

size()

uint64_t _flxFSSDMMCard::size ( void  )

virtual

Implements flxIFileSystem.

total()

uint64_t _flxFSSDMMCard::total

(

void

)

type()

const char * _flxFSSDMMCard::type ( void  )

virtual

Implements flxIFileSystem.

used()

uint64_t _flxFSSDMMCard::used

(

void

)

---

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

• src/core/flux_sdcard/flxFSSDMMCard.h
• src/core/flux_sdcard/flxFSSDMMCard.cpp