Base class for SdFile with Print and C++ streams. More...

#include <SdFat.h>

Inheritance diagram for SdBaseFile:

Public Member Functions
	SdBaseFile ()
	SdBaseFile (const char *path, uint8_t oflag)
	~SdBaseFile ()
bool	getWriteError ()
void	clearWriteError ()
void	getpos (fpos_t *pos)
void	setpos (fpos_t *pos)
bool	close ()
bool	contiguousRange (uint32_t bgnBlock, uint32_t endBlock)
bool	createContiguous (SdBaseFile dirFile, const char path, uint32_t size)
uint32_t	curCluster () const
uint32_t	curPosition () const
bool	dirEntry (dir_t *dir)
bool	exists (const char *name)
int16_t	fgets (char str, int16_t num, char delim=0)
uint32_t	fileSize () const
uint32_t	firstCluster () const
bool	getFilename (char *name)
bool	isDir () const
bool	isFile () const
bool	isOpen () const
bool	isSubDir () const
bool	isRoot () const
void	ls (Print *pr, uint8_t flags=0, uint8_t indent=0)
void	ls (uint8_t flags=0)
bool	mkdir (SdBaseFile dir, const char path, bool pFlag=true)
bool	makeDir (SdBaseFile dir, const char path)
bool	open (SdBaseFile *dirFile, uint16_t index, uint8_t oflag)
bool	open (SdBaseFile dirFile, const char path, uint8_t oflag)
bool	open (const char *path, uint8_t oflag=O_READ)
bool	openNext (SdBaseFile *dirFile, uint8_t oflag)
bool	openRoot (SdVolume *vol)
int	peek ()
bool	printCreateDateTime (Print *pr)
bool	printModifyDateTime (Print *pr)
bool	printName ()
bool	printName (Print *pr)
int16_t	read ()
int16_t	read (void *buf, uint16_t nbyte)
int8_t	readDir (dir_t *dir)
bool	remove ()
void	rewind ()
bool	rename (SdBaseFile dirFile, const char newPath)
bool	rmdir ()
bool	rmDir ()
bool	rmRfStar ()
bool	seekCur (int32_t offset)
bool	seekEnd (int32_t offset=0)
bool	seekSet (uint32_t pos)
bool	sync ()
bool	timestamp (SdBaseFile *file)
bool	timestamp (uint8_t flag, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)
uint8_t	type () const
bool	truncate (uint32_t size)
SdVolume *	volume () const
int16_t	write (const void *buf, uint16_t nbyte)
bool	openParent (SdBaseFile *dir)
bool	addCluster ()
bool	addDirCluster ()
dir_t *	cacheDirEntry (uint8_t action)
int8_t	lsPrintNext (Print *pr, uint8_t flags, uint8_t indent)
bool	mkdir (SdBaseFile *parent, const uint8_t dname[11])
bool	open (SdBaseFile *dirFile, const uint8_t dname[11], uint8_t oflag)
bool	openCachedEntry (uint8_t cacheIndex, uint8_t oflags)
dir_t *	readDirCache ()
bool	contiguousRange (uint32_t &bgnBlock, uint32_t &endBlock)
bool	createContiguous (SdBaseFile &dirFile, const char *path, uint32_t size)
bool	dirEntry (dir_t &dir)
bool	mkdir (SdBaseFile &dir, const char *path)
bool	open (SdBaseFile &dirFile, const char *path, uint8_t oflag)
bool	open (SdBaseFile &dirFile, const char *path)
bool	open (SdBaseFile &dirFile, uint16_t index, uint8_t oflag)
bool	openRoot (SdVolume &vol)
int8_t	readDir (dir_t &dir)
Static Public Member Functions
static SdBaseFile *	cwd ()
static void	dateTimeCallback (void(dateTime)(uint16_t date, uint16_t *time))
static void	dateTimeCallbackCancel ()
static void	dirName (const dir_t &dir, char *name)
static void	printFatDate (uint16_t fatDate)
static void	printFatDate (Print *pr, uint16_t fatDate)
static void	printFatTime (uint16_t fatTime)
static void	printFatTime (Print *pr, uint16_t fatTime)
static bool	remove (SdBaseFile dirFile, const char path)
static bool	make83Name (const char str, uint8_t name, const char **ptr)
static void	printDirName (const dir_t &dir, uint8_t width, bool printSlash)
static void	printDirName (Print *pr, const dir_t &dir, uint8_t width, bool printSlash)
static void	dateTimeCallback (void(*dateTime)(uint16_t &date, uint16_t &time))
static bool	remove (SdBaseFile &dirFile, const char *path)
Data Fields
bool	writeError
uint8_t	flags_
uint8_t	fstate_
uint8_t	type_
uint32_t	curCluster_
uint32_t	curPosition_
uint32_t	dirBlock_
uint8_t	dirIndex_
uint32_t	fileSize_
uint32_t	firstCluster_
SdVolume *	vol_
Static Public Attributes
static SdBaseFile *	cwd_
static void(*	dateTime_ )(uint16_t date, uint16_t time)
static uint8_t const	F_OFLAG = (O_ACCMODE \| O_APPEND \| O_SYNC)
static uint8_t const	F_FILE_DIR_DIRTY = 0X80
Static Private Member Functions
static void	oldToNew (uint16_t date, uint16_t time)
Static Private Attributes
static void(*	oldDateTime_ )(uint16_t &date, uint16_t &time)
Friends
class	SdFat

Detailed Description

Base class for SdFile with Print and C++ streams.

Constructor & Destructor Documentation

SdBaseFile ( ) [inline]

Create an instance.

SdBaseFile	(	const char *	path,
		uint8_t	oflag
	)

~SdBaseFile ( ) [inline]

Member Function Documentation

bool addCluster ( )

bool addDirCluster ( )

dir_t* cacheDirEntry ( uint8_t action )

void clearWriteError ( ) [inline]

Set writeError to zero

Reimplemented in SdFile.

bool close ( )

bool contiguousRange	(	uint32_t *	bgnBlock,
		uint32_t *	endBlock
	)

bool contiguousRange	(	uint32_t &	bgnBlock,
		uint32_t &	endBlock
	)		`[inline]`

Deprecated:: Use: bool contiguousRange(uint32_t* bgnBlock, uint32_t* endBlock);

Parameters:

[out]	bgnBlock	the first block address for the file.
[out]	endBlock	the last block address for the file.

Returns:: true for success or false for failure.

bool createContiguous	(	SdBaseFile *	dirFile,
		const char *	path,
		uint32_t	size
	)

bool createContiguous	(	SdBaseFile &	dirFile,
		const char *	path,
		uint32_t	size
	)		`[inline]`

Deprecated:: Use: bool createContiguous(SdBaseFile* dirFile, const char* path, uint32_t size)

Parameters:

[in]	dirFile	The directory where the file will be created.
[in]	path	A path with a valid DOS 8.3 file name.
[in]	size	The desired file size.

Returns:: true for success or false for failure.

uint32_t curCluster ( ) const [inline]

Returns:: The current cluster number for a file or directory.

uint32_t curPosition ( ) const [inline]

Returns:: The current position for a file or directory.

static SdBaseFile* cwd ( ) [inline, static]

Returns:: Current working directory

static void dateTimeCallback ( void(*)(uint16_t *date, uint16_t *time) dateTime ) [inline, static]

Set the date/time callback function

Parameters:

[in] dateTime The user's call back function. The callback function is of the form:

 void dateTime(uint16_t* date, uint16_t* time) {
   uint16_t year;
   uint8_t month, day, hour, minute, second;

   // User gets date and time from GPS or real-time clock here

   // return date using FAT_DATE macro to format fields
   *date = FAT_DATE(year, month, day);

   // return time using FAT_TIME macro to format fields
   *time = FAT_TIME(hour, minute, second);
 }

Sets the function that is called when a file is created or when a file's directory entry is modified by sync(). All timestamps, access, creation, and modify, are set when a file is created. sync() maintains the last access date and last modify date/time.

See the timestamp() function.

static void dateTimeCallback ( void(*)(uint16_t &date, uint16_t &time) dateTime ) [inline, static]

Deprecated:: Use: static void dateTimeCallback( void (*dateTime)(uint16_t* date, uint16_t* time));

Parameters:

[in] dateTime The user's call back function.

static void dateTimeCallbackCancel ( ) [inline, static]

Cancel the date/time callback function.

bool dirEntry ( dir_t * dir )

bool dirEntry ( dir_t & dir ) [inline]

Deprecated:: Use: bool dirEntry(dir_t* dir);

Parameters:

[out] dir Location for return of the file's directory entry.

Returns:: true for success or false for failure.

static void dirName	(	const dir_t &	dir,
		char *	name
	)		`[static]`

bool exists ( const char * name )

int16_t fgets	(	char *	str,
		int16_t	num,
		char *	delim = `0`
	)

uint32_t fileSize ( ) const [inline]

Returns:: The total number of bytes in a file or directory.

uint32_t firstCluster ( ) const [inline]

Returns:: The first cluster number for a file or directory.

bool getFilename ( char * name )

void getpos ( fpos_t * pos )

get position for streams

Parameters:

[out] pos struct to receive position

bool getWriteError ( ) [inline]

Returns:: value of writeError

Reimplemented in SdFile.

bool isDir ( ) const [inline]

Returns:: True if this is a directory else false.

bool isFile ( ) const [inline]

Returns:: True if this is a normal file else false.

bool isOpen ( ) const [inline]

Returns:: True if this is an open file/directory else false.

bool isRoot ( ) const [inline]

Returns:: True if this is the root directory.

bool isSubDir ( ) const [inline]

Returns:: True if this is a subdirectory else false.

void ls	(	Print *	pr,
		uint8_t	flags = `0`,
		uint8_t	indent = `0`
	)

void ls ( uint8_t flags = 0 )

int8_t lsPrintNext	(	Print *	pr,
		uint8_t	flags,
		uint8_t	indent
	)

static bool make83Name	(	const char *	str,
		uint8_t *	name,
		const char **	ptr
	)		`[static]`

bool makeDir	(	SdBaseFile *	dir,
		const char *	path
	)		`[inline]`

bool mkdir	(	SdBaseFile *	dir,
		const char *	path,
		bool	pFlag = `true`
	)

bool mkdir	(	SdBaseFile *	parent,
		const uint8_t	dname[11]
	)

bool mkdir	(	SdBaseFile &	dir,
		const char *	path
	)		`[inline]`

Deprecated:: Use: bool mkdir(SdBaseFile* dir, const char* path);

Parameters:

[in]	dir	An open SdFat instance for the directory that will contain the new directory.
[in]	path	A path with a valid 8.3 DOS name for the new directory.

Returns:: true for success or false for failure.

static void oldToNew	(	uint16_t *	date,
		uint16_t *	time
	)		`[inline, static, private]`

bool open	(	SdBaseFile *	dirFile,
		uint16_t	index,
		uint8_t	oflag
	)

bool open	(	SdBaseFile *	dirFile,
		const char *	path,
		uint8_t	oflag
	)

bool open	(	const char *	path,
		uint8_t	oflag = `O_READ`
	)

bool open	(	SdBaseFile *	dirFile,
		const uint8_t	dname[11],
		uint8_t	oflag
	)

bool open	(	SdBaseFile &	dirFile,
		const char *	path,
		uint8_t	oflag
	)		`[inline]`

Deprecated:: Use: bool open(SdBaseFile* dirFile, const char* path, uint8_t oflag);

Parameters:

[in]	dirFile	An open SdFat instance for the directory containing the file to be opened.
[in]	path	A path with a valid 8.3 DOS name for the file.
[in]	oflag	Values for oflag are constructed by a bitwise-inclusive OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.

Returns:: true for success or false for failure.

bool open	(	SdBaseFile &	dirFile,
		const char *	path
	)		`[inline]`

Deprecated:: Do not use in new apps

Parameters:

[in]	dirFile	An open SdFat instance for the directory containing the file to be opened.
[in]	path	A path with a valid 8.3 DOS name for a file to be opened.

Returns:: true for success or false for failure.

bool open	(	SdBaseFile &	dirFile,
		uint16_t	index,
		uint8_t	oflag
	)		`[inline]`

Deprecated:: Use: bool open(SdBaseFile* dirFile, uint16_t index, uint8_t oflag);

Parameters:

[in]	dirFile	An open SdFat instance for the directory.
[in]	index	The index of the directory entry for the file to be opened. The value for index is (directory file position)/32.
[in]	oflag	Values for oflag are constructed by a bitwise-inclusive OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.

Returns:: true for success or false for failure.

bool openCachedEntry	(	uint8_t	cacheIndex,
		uint8_t	oflags
	)

bool openNext	(	SdBaseFile *	dirFile,
		uint8_t	oflag
	)

bool openParent ( SdBaseFile * dir )

experimental don't use

bool openRoot ( SdVolume * vol )

bool openRoot ( SdVolume & vol ) [inline]

Deprecated:: Use: bool openRoot(SdVolume* vol);

Parameters:

[in] vol The FAT volume containing the root directory to be opened.

Returns:: true for success or false for failure.

int peek ( )

bool printCreateDateTime ( Print * pr )

static void printDirName	(	const dir_t &	dir,
		uint8_t	width,
		bool	printSlash
	)		`[static]`

static void printDirName	(	Print *	pr,
		const dir_t &	dir,
		uint8_t	width,
		bool	printSlash
	)		`[static]`

static void printFatDate ( uint16_t fatDate ) [static]

static void printFatDate	(	Print *	pr,
		uint16_t	fatDate
	)		`[static]`

static void printFatTime ( uint16_t fatTime ) [static]

static void printFatTime	(	Print *	pr,
		uint16_t	fatTime
	)		`[static]`

bool printModifyDateTime ( Print * pr )

bool printName ( )

bool printName ( Print * pr )

int16_t read ( )

int16_t read	(	void *	buf,
		uint16_t	nbyte
	)

int8_t readDir ( dir_t * dir )

int8_t readDir ( dir_t & dir ) [inline]

Deprecated:: Use: int8_t readDir(dir_t* dir);

Parameters:

[out] dir The dir_t struct that will receive the data.

Returns:: bytes read for success zero for eof or -1 for failure.

dir_t* readDirCache ( )

static bool remove	(	SdBaseFile *	dirFile,
		const char *	path
	)		`[static]`

bool remove ( )

static bool remove	(	SdBaseFile &	dirFile,
		const char *	path
	)		`[inline, static]`

Deprecated:: Use: static uint8_t remove(SdBaseFile* dirFile, const char* path);

Parameters:

[in]	dirFile	The directory that contains the file.
[in]	path	The name of the file to be removed.

Returns:: true for success or false for failure.

bool rename	(	SdBaseFile *	dirFile,
		const char *	newPath
	)

void rewind ( ) [inline]

Set the file's current position to zero.

bool rmdir ( )

bool rmDir ( ) [inline]

bool rmRfStar ( )

bool seekCur ( int32_t offset ) [inline]

Set the files position to current position + pos. See seekSet().

Parameters:

[in] offset The new position in bytes from the current position.

Returns:: true for success or false for failure.

bool seekEnd ( int32_t offset = 0 ) [inline]

Set the files position to end-of-file + offset. See seekSet().

Parameters:

[in] offset The new position in bytes from end-of-file.

Returns:: true for success or false for failure.

bool seekSet ( uint32_t pos )

void setpos ( fpos_t * pos )

set position for streams

Parameters:

[out] pos struct with value for new position

bool sync ( )

bool timestamp ( SdBaseFile * file )

bool timestamp	(	uint8_t	flag,
		uint16_t	year,
		uint8_t	month,
		uint8_t	day,
		uint8_t	hour,
		uint8_t	minute,
		uint8_t	second
	)

bool truncate ( uint32_t size )

uint8_t type ( ) const [inline]

Type of file. You should use isFile() or isDir() instead of type() if possible.

Returns:: The file or directory type.

SdVolume* volume ( ) const [inline]

Returns:: SdVolume that contains this file.

int16_t write	(	const void *	buf,
		uint16_t	nbyte
	)

Reimplemented in SdFile.

Friends And Related Function Documentation

friend class SdFat [friend]

Field Documentation

uint32_t curCluster_

uint32_t curPosition_

SdBaseFile* cwd_ [static]

void(* dateTime_)(uint16_t *date, uint16_t *time) [static]

uint32_t dirBlock_

uint8_t dirIndex_

uint8_t const F_FILE_DIR_DIRTY = 0X80 [static]

uint8_t const F_OFLAG = (O_ACCMODE | O_APPEND | O_SYNC) [static]

uint32_t fileSize_

uint32_t firstCluster_

uint8_t flags_

uint8_t fstate_

void(* oldDateTime_)(uint16_t &date, uint16_t &time) [static, private]

uint8_t type_

SdVolume* vol_

bool writeError

writeError is set to true if an error occurs during a write(). Set writeError to false before calling print() and/or write() and check for true after calls to print() and/or write().

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

Repetier/SdFat.h

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Static Private Member Functions

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation