Radio data file helper This class implements utilities used to read or write radio data to/from file The String contains object name used for debug. More...

#include <yateradio.h>

Inheritance diagram for RadioDataFile:

Public Member Functions
	RadioDataFile (const char *name, bool dropOnError=true)

virtual	~RadioDataFile ()

const RadioDataDesc &	desc () const

bool	valid () const

bool	sameEndian () const

bool	open (const char fileName, const RadioDataDesc data, DebugEnabler dbg=0, int error=0)

bool	write (uint64_t ts, const void buf, uint32_t len, DebugEnabler dbg=0, int *error=0)

bool	read (uint64_t &ts, DataBlock &buffer, DebugEnabler dbg=0, int error=0)

void	terminate (DebugEnabler *dbg=0)

Public Member Functions inherited from String
	String ()

	String (const char *value, int len=-1)

	String (char value, unsigned int repeat=1)

	String (int32_t value)

	String (uint32_t value)

	String (int64_t value)

	String (uint64_t value)

	String (bool value)

	String (double value)

	String (const String &value)

	String (const String *value)

virtual	~String ()

virtual void *	getObject (const String &name) const

const char *	c_str () const

const char *	safe () const

const char *	safe (const char *defStr) const

unsigned int	length () const

bool	null () const

int	lenUtf8 (uint32_t maxChar=0x10ffff, bool overlong=false) const

int	fixUtf8 (const char *replace=0, uint32_t maxChar=0x10ffff, bool overlong=false)

unsigned int	encodeFlags (const TokenDict *tokens) const

uint64_t	encodeFlags (const TokenDict64 *tokens) const

const String &	decodeFlags (unsigned int flags, const TokenDict *tokens, bool unknownflag=true)

const String &	decodeFlags (uint64_t flags, const TokenDict64 *tokens, bool unknownflag=true)

bool	checkBOM () const

bool	stripBOM ()

unsigned int	hash () const

void	clear ()

char	at (int index) const

String	substr (int offs, int len=-1) const

String &	trimBlanks ()

String &	trimSpaces ()

virtual const String &	toString () const

int	toInteger (int defvalue=0, int base=0, int minvalue=INT_MIN, int maxvalue=INT_MAX, bool clamp=true) const

int	toInteger (const TokenDict *tokens, int defvalue=0, int base=0) const

long int	toLong (long int defvalue=0, int base=0, long int minvalue=LONG_MIN, long int maxvalue=LONG_MAX, bool clamp=true) const

int64_t	toInt64 (int64_t defvalue=0, int base=0, int64_t minvalue=LLONG_MIN, int64_t maxvalue=LLONG_MAX, bool clamp=true) const

uint64_t	toUInt64 (uint64_t defvalue=0, int base=0, uint64_t minvalue=0, uint64_t maxvalue=ULLONG_MAX, bool clamp=true) const

double	toDouble (double defvalue=0.0) const

bool	toBoolean (bool defvalue=false) const

bool	isBoolean () const

String &	toUpper ()

String &	toLower ()

char	operator[] (signed int index) const

char	operator[] (unsigned int index) const

	operator const char * () const

String &	assign (const char *value, int len=-1)

String &	assign (char value, unsigned int repeat=1)

String &	hexify (void *data, unsigned int len, char sep=0, bool upCase=false)

String &	operator= (const String &value)

String &	operator= (const String *value)

String &	operator= (const char *value)

String &	operator= (char value)

String &	operator= (int32_t value)

String &	operator= (uint32_t value)

String &	operator= (int64_t value)

String &	operator= (uint64_t value)

String &	operator= (bool value)

String &	operator= (double value)

String &	operator+= (const char *value)

String &	operator+= (char value)

String &	operator+= (int32_t value)

String &	operator+= (uint32_t value)

String &	operator+= (int64_t value)

String &	operator+= (uint64_t value)

String &	operator+= (bool value)

String &	operator+= (double value)

bool	operator== (const char *value) const

bool	operator!= (const char *value) const

bool	operator== (const String &value) const

bool	operator!= (const String &value) const

bool	operator&= (const char *value) const

bool	operator\|= (const char *value) const

String &	operator<< (const char *value)

String &	operator<< (char value)

String &	operator<< (int32_t value)

String &	operator<< (uint32_t value)

String &	operator<< (int64_t value)

String &	operator<< (uint64_t value)

String &	operator<< (bool value)

String &	operator<< (double value)

String &	operator>> (const char *skip)

String &	operator>> (char &store)

String &	operator>> (UChar &store)

String &	operator>> (int &store)

String &	operator>> (unsigned int &store)

String &	operator>> (bool &store)

String &	append (const char *value, int len)

String &	append (const char value, const char separator=0, bool force=false)

String &	append (const ObjList list, const char separator=0, bool force=false)

String &	append (const ObjList &list, const char *separator=0, bool force=false)

String &	append (double value, unsigned int decimals=3)

String &	printf (const char *format,...)

String &	printf (unsigned int length, const char *format,...)

String &	appendFixed (unsigned int fixedLength, const char *str, unsigned int len=-1, char fill=' ', int align=Left)

String &	appendFixed (unsigned int fixedLength, const String &str, char fill=' ', int align=Left)

int	find (char what, unsigned int offs=0) const

int	find (const char *what, unsigned int offs=0) const

int	rfind (char what) const

int	rfind (const char *what) const

bool	startsWith (const char *what, bool wordBreak=false, bool caseInsensitive=false) const

bool	endsWith (const char *what, bool wordBreak=false, bool caseInsensitive=false) const

bool	startSkip (const char *what, bool wordBreak=true, bool caseInsensitive=false)

String &	extractTo (const char *sep, String &store)

String &	extractTo (const char *sep, bool &store)

String &	extractTo (const char *sep, int &store, int base=0)

String &	extractTo (const char sep, int &store, const TokenDict tokens, int base=0)

String &	extractTo (const char *sep, double &store)

virtual bool	matches (const String &value) const

bool	matches (const Regexp &rexp)

int	matchOffset (int index=0) const

int	matchLength (int index=0) const

String	matchString (int index=0) const

String	replaceMatches (const String &templ) const

int	matchCount () const

ObjList *	split (char separator, bool emptyOK=true) const

ObjList *	split (const Regexp &reg, bool emptyOK=true) const

String	msgEscape (char extraEsc=0) const

String	msgUnescape (int *errptr=0, char extraEsc=0) const

String	sqlEscape (char extraEsc=0) const

String	uriEscape (char extraEsc=0, const char *noEsc=0) const

String	uriUnescape (int *errptr=0) const

Public Member Functions inherited from GenObject
	GenObject ()

virtual	~GenObject ()

virtual bool	alive () const

virtual void	destruct ()

virtual const String &	traceId () const

NamedCounter *	getObjCounter () const

NamedCounter *	setObjCounter (NamedCounter *counter)

Static Public Member Functions
static bool	fixEndian (DataBlock &buf, unsigned int bytes)

Static Public Member Functions inherited from String
static const String &	empty ()

static const char *	boolText (bool value)

static int	lenUtf8 (const char *value, uint32_t maxChar=0x10ffff, bool overlong=false)

static bool	checkBOM (const char *str)

static bool	stripBOM (const char *&str)

static bool	stripBOM (char *&str)

static unsigned int	hash (const char *value, unsigned int h=0)

static String	msgEscape (const char *str, char extraEsc=0)

static String	msgUnescape (const char str, int errptr=0, char extraEsc=0)

static String	sqlEscape (const char *str, char extraEsc=0)

static String	uriEscape (const char str, char extraEsc=0, const char noEsc=0)

static String	uriEscape (const char str, const char extraEsc, const char *noEsc=0)

static String	uriUnescape (const char str, int errptr=0)

static const String *	atom (const String &str, const char val)

Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)

static bool	getObjCounting ()

static void	setObjCounting (bool enable)

static NamedCounter *	getObjCounter (const String &name, bool create=true)

static ObjList &	getObjCounters ()

Protected Member Functions
bool	ioError (bool send, DebugEnabler dbg, int error, const char *extra)

Protected Member Functions inherited from String
virtual void	changed ()

Protected Attributes
bool	m_littleEndian

bool	m_dropOnError

uint32_t	m_chunkSize

RadioDataDesc	m_header

File	m_file

DataBlock	m_writeBuf

Additional Inherited Members
Public Types inherited from String
enum	Align { Left = 0 , Center , Right }

Detailed Description

Radio data file helper This class implements utilities used to read or write radio data to/from file The String contains object name used for debug.

Constructor & Destructor Documentation

◆ RadioDataFile()

RadioDataFile	(	const char *	name,
		bool	dropOnError = true )

Constructor

Parameters

name	Name used for debug
dropOnError	Terminate on file/data error

◆ ~RadioDataFile()

virtual ~RadioDataFile ( )

virtual

Destructor

Member Function Documentation

◆ desc()

const RadioDataDesc & desc ( ) const

inline

Retrieve data description

Returns: Data description object

◆ fixEndian()

static bool fixEndian	(	DataBlock &	buf,
		unsigned int	bytes )

static

Convert endiannes

Parameters

buf	The buffer to convert
bytes	Element length in bytes

Returns: True on success, false if not supported

◆ open()

bool open	(	const char *	fileName,
		const RadioDataDesc *	data,
		DebugEnabler *	dbg = 0,
		int *	error = 0 )

Open a file for read/write. Terminate current data dump if any. Write or read the file header

Parameters

fileName	File to open
data	Data description. Pass a NULL pointer for read or valid data for write
dbg	Optional DebugEnabler pointer (show debug on failure)
error	Optional destination for file operation error code

Returns: True on success, false on failure (read: error set to 0 means invalid file size, write: error set to 0 means invalid header)

◆ read()

bool read	(	uint64_t &	ts,
		DataBlock &	buffer,
		DebugEnabler *	dbg = 0,
		int *	error = 0 )

Read a record from file The method don't check the record length, this must be done by the upper layer

Parameters

ts	Record timestamp
buffer	Destination buffer. It will be resized to read data length
dbg	Optional DebugEnabler pointer (show debug on failure)
error	Optional destination for file operation error code

Returns: True on success (empty buffer means file EOF), false on failure (error set to 0 means invalid record size)

◆ sameEndian()

bool sameEndian ( ) const

inline

Check if machine endiannes is the same as file endiannes

Returns: True if they are the same

◆ terminate()

void terminate ( DebugEnabler * dbg = 0 )

Terminate data dump, close file

Parameters

dbg	Optional DebugEnabler pointer (show terminate message)

◆ valid()

bool valid ( ) const

inline

Check if enabled

Returns: True if enabled, false otherwise

◆ write()

bool write	(	uint64_t	ts,
		const void *	buf,
		uint32_t	len,
		DebugEnabler *	dbg = 0,
		int *	error = 0 )

Write a record to file

Parameters

ts	Record timestamp
buf	Buffer to write
len	Buffer length in bytes
dbg	Optional DebugEnabler pointer (show debug on failure)
error	Optional destination for file operation error code

Returns: True on success, false on failure (error set to 0 means invalid length)

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

yateradio.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RadioDataFile()

◆ ~RadioDataFile()

Member Function Documentation

◆ desc()

◆ fixEndian()

◆ open()

◆ read()

◆ sameEndian()

◆ terminate()

◆ valid()

◆ write()