This class defines the interface for generic data file access. More...

#include <BdsDataFile.h>

Inheritance diagram for Bds::DataFile:

Public Types
enum	DataOrder { DataOrderUnknown, DataOrderAll, DataOrderSample, DataOrderChannel }

enum	Features { FeatureNone = 0x00, FeatureCanWrite = 0x01, FeatureCanRead = 0x02 }

enum	WriteOptionsList { WriteOptionNone = 0x00, WriteOptionSensorData = 0x01, WriteOptionNoMetadata = 0x02 }

enum	ReadOptionsList { ReadOptionNone = 0x00, ReadOptionValidate = 0x01, ReadOptionFileNameProcess = 0x02, ReadOptionValidateCorruptions = 0x04, ReadOptionReorder = 0x08, ReadOptionDeleteDuplicates = 0x10, ReadOptionInfoExtra = 0x20, ReadOptionIgnoreSamplerate = 0x40, ReadOptionPrintBlocks = 0x80 }

Public Member Functions
	DataFile ()

virtual	~DataFile ()

virtual void	init ()
	Initialise. More...

virtual BError	open (BString fileName, BString mode)
	Open the file for read or write. More...

virtual BError	close ()
	Close the file. More...

virtual BError	setFormat (BString format)
	Set the sub-format. More...

virtual BString	getFileName ()
	Return the file name. More...

virtual DataOrder	getDataOrder ()
	Get the expected order of writing data, by sample or by channel. More...

virtual int	getFeatures ()
	Get bitmask of supported features. More...

virtual BError	setInfo (const DataInfo &dataInfo, const ChannelInfos &channelInfos, WriteOptionsList options=WriteOptionNone)
	Set information on data for write. More...

virtual BError	start (BUInt channel, BUInt segment)
	Start next segment of data. More...

virtual BError	writeData (const DataBlock &data)
	Write a block of data. More...

virtual BError	end ()
	End segment. More...

virtual BError	flush ()
	Flush data to disk. More...

virtual BError	fileNameProcess ()
	Parse the file name for a date/time. More...

virtual BError	getFormat (BString &format)
	Get sub-format. More...

virtual BError	getInfo (DataInfo &dataInfo, DataFileOptions options, BList< DataError > &errors)
	Get info on data. More...

virtual BError	seekBlock (BUInt32 channel, BUInt segment, BTimeStamp time, BUInt32 &blockNumber, BUInt64 &sampleNumber, DataBlock &data)
	Find requested block on given channel given a time. More...

virtual BError	readData (BUInt32 channel, BUInt segment, BUInt32 blockNumber, DataBlock &dataBlock)
	Read a block. More...

virtual BError	getMetaData (ChannelInfos &channelInfos)
	Return all known MetaData in the file. More...

void	dataErrorFixup (const DataInfo &dataInfo, BList< DataError > &errors)
	Fixup data errors, mainly start/end times to be within data. More...

BInt64	timeCompare (BTimeStamp t1, BTimeStamp t2, BUInt diff)
	Compare timestamps with a margin. More...

int	duplicateCheck (const DataBlock &data1, const DataBlock &data2, BUInt channel=0)
	Check if blocks are duplicates. More...

BUInt64	getFilePosition ()

Static Public Member Functions
static DataFormat	getFormats ()
	Get list of supported formats. More...

Protected Attributes
BString	ofileName

BString	omode

BTimeStamp	ofileNameTime

BFile	ofile

BString	oformat

Detailed Description

This class defines the interface for generic data file access.

Member Enumeration Documentation

◆ DataOrder

enum Bds::DataFile::DataOrder

Enumerator
DataOrderUnknown
DataOrderAll
DataOrderSample
DataOrderChannel

◆ Features

enum Bds::DataFile::Features

Enumerator
FeatureNone
FeatureCanWrite
FeatureCanRead

◆ ReadOptionsList

enum Bds::DataFile::ReadOptionsList

Enumerator
ReadOptionNone
ReadOptionValidate
ReadOptionFileNameProcess
ReadOptionValidateCorruptions
ReadOptionReorder
ReadOptionDeleteDuplicates
ReadOptionInfoExtra
ReadOptionIgnoreSamplerate
ReadOptionPrintBlocks

◆ WriteOptionsList

enum Bds::DataFile::WriteOptionsList

Enumerator
WriteOptionNone
WriteOptionSensorData
WriteOptionNoMetadata

Constructor & Destructor Documentation

◆ DataFile()

Bds::DataFile::DataFile ( )

◆ ~DataFile()

Bds::DataFile::~DataFile ( )

virtual

Member Function Documentation

◆ close()

BError Bds::DataFile::close ( )

virtual

Close the file.

Reimplemented in Bds::DataFileBds, and Bds::DataFileIms.

◆ dataErrorFixup()

void Bds::DataFile::dataErrorFixup	(	const DataInfo &	dataInfo,
		BList< DataError > &	errors
	)

Fixup data errors, mainly start/end times to be within data.

◆ duplicateCheck()

int Bds::DataFile::duplicateCheck	(	const DataBlock &	data1,
		const DataBlock &	data2,
		BUInt	channel = `0`
	)

Check if blocks are duplicates.

◆ end()

BError Bds::DataFile::end ( )

virtual

End segment.

Reimplemented in Bds::DataFileLog, Bds::DataFileAscii, and Bds::DataFileIms.

◆ fileNameProcess()

BError Bds::DataFile::fileNameProcess ( )

virtual

Parse the file name for a date/time.

◆ flush()

BError Bds::DataFile::flush ( )

virtual

Flush data to disk.

Reimplemented in Bds::DataFileBds.

◆ getDataOrder()

DataFile::DataOrder Bds::DataFile::getDataOrder ( )

virtual

Get the expected order of writing data, by sample or by channel.

Reimplemented in Bds::DataFileBds, Bds::DataFileCd, Bds::DataFileCss, Bds::DataFileGcf, Bds::DataFileIms, Bds::DataFileAscii, Bds::DataFileLog, Bds::DataFileWra, Bds::DataFileAd22, Bds::DataFileBdrs, Bds::DataFileLac, and Bds::DataFileWraAgso.

◆ getFeatures()

int Bds::DataFile::getFeatures ( )

virtual

Get bitmask of supported features.

Reimplemented in Bds::DataFileCd, Bds::DataFileCss, Bds::DataFileGcf, Bds::DataFileIms, Bds::DataFileAscii, Bds::DataFileLog, Bds::DataFileResponse, Bds::DataFileSac, Bds::DataFileWra, Bds::DataFileAd22, Bds::DataFileBdrs, Bds::DataFileLac, and Bds::DataFileWraAgso.

◆ getFileName()

BString Bds::DataFile::getFileName ( )

virtual

Return the file name.

◆ getFilePosition()

BUInt64 Bds::DataFile::getFilePosition ( )

◆ getFormat()

BError Bds::DataFile::getFormat ( BString & format )

virtual

Get sub-format.

◆ getFormats()

DataFormat Bds::DataFile::getFormats ( )

static

Get list of supported formats.

◆ getInfo()

BError Bds::DataFile::getInfo	(	DataInfo &	dataInfo,
		DataFileOptions	options,
		BList< DataError > &	errors
	)

virtual

Get info on data.

Reimplemented in Bds::DataFileBds, Bds::DataFileCd, Bds::DataFileCss, Bds::DataFileGcf, Bds::DataFileTapeDigitiser, Bds::DataFileLog, Bds::DataFileWra, Bds::DataFileAd22, Bds::DataFileBdrs, Bds::DataFileLac, and Bds::DataFileWraAgso.

◆ getMetaData()

BError Bds::DataFile::getMetaData ( ChannelInfos & channelInfos )

virtual

Return all known MetaData in the file.

Reimplemented in Bds::DataFileIms, and Bds::DataFileResponse.

◆ init()

void Bds::DataFile::init ( )

virtual

Initialise.

◆ open()

BError Bds::DataFile::open	(	BString	fileName,
		BString	mode
	)

virtual

Open the file for read or write.

Reimplemented in Bds::DataFileBds, Bds::DataFileTapeDigitiser, Bds::DataFileAscii, Bds::DataFileBknas, Bds::DataFileIms, and Bds::DataFileLog.

◆ readData()

BError Bds::DataFile::readData	(	BUInt32	channel,
		BUInt	segment,
		BUInt32	blockNumber,
		DataBlock &	dataBlock
	)

virtual

Read a block.

Reimplemented in Bds::DataFileBds, Bds::DataFileCd, Bds::DataFileCss, Bds::DataFileGcf, Bds::DataFileTapeDigitiser, Bds::DataFileLog, Bds::DataFileWra, Bds::DataFileAd22, Bds::DataFileBdrs, Bds::DataFileLac, and Bds::DataFileWraAgso.

◆ seekBlock()

BError Bds::DataFile::seekBlock	(	BUInt32	channel,
		BUInt	segment,
		BTimeStamp	time,
		BUInt32 &	blockNumber,
		BUInt64 &	sampleNumber,
		DataBlock &	data
	)

virtual

Find requested block on given channel given a time.

Reimplemented in Bds::DataFileBds.

◆ setFormat()

BError Bds::DataFile::setFormat ( BString format )

virtual

Set the sub-format.

Reimplemented in Bds::DataFileBds, Bds::DataFileLog, Bds::DataFileAscii, and Bds::DataFileWra.

◆ setInfo()

BError Bds::DataFile::setInfo	(	const DataInfo &	dataInfo,
		const ChannelInfos &	channelInfos,
		WriteOptionsList	options = `WriteOptionNone`
	)

virtual

Set information on data for write.

Reimplemented in Bds::DataFileBds, Bds::DataFileLog, Bds::DataFileResponse, Bds::DataFileAscii, Bds::DataFileIms, Bds::DataFileBknas, and Bds::DataFileSac.

◆ start()

BError Bds::DataFile::start	(	BUInt	channel,
		BUInt	segment
	)

virtual

Start next segment of data.

Reimplemented in Bds::DataFileLog, Bds::DataFileAscii, and Bds::DataFileIms.

◆ timeCompare()

BInt64 Bds::DataFile::timeCompare	(	BTimeStamp	t1,
		BTimeStamp	t2,
		BUInt	diff
	)

Compare timestamps with a margin.

◆ writeData()

BError Bds::DataFile::writeData ( const DataBlock & data )

virtual

Write a block of data.

Reimplemented in Bds::DataFileBds, Bds::DataFileLog, Bds::DataFileAscii, Bds::DataFileIms, and Bds::DataFileBknas.

Member Data Documentation

◆ ofile

BFile Bds::DataFile::ofile

protected

◆ ofileName

BString Bds::DataFile::ofileName

protected

◆ ofileNameTime

BTimeStamp Bds::DataFile::ofileNameTime

protected

◆ oformat

BString Bds::DataFile::oformat

protected

◆ omode

BString Bds::DataFile::omode

protected

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

/src/blacknest/bds/bds/bdsDataLib/BdsDataFile.h
/src/blacknest/bds/bds/bdsDataLib/BdsDataFile.cpp

Account

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ DataOrder

◆ Features

◆ ReadOptionsList

◆ WriteOptionsList

Constructor & Destructor Documentation

◆ DataFile()

◆ ~DataFile()

Member Function Documentation

◆ close()

◆ dataErrorFixup()

◆ duplicateCheck()

◆ end()

◆ fileNameProcess()

◆ flush()

◆ getDataOrder()

◆ getFeatures()

◆ getFileName()

◆ getFilePosition()

◆ getFormat()

◆ getFormats()

◆ getInfo()

◆ getMetaData()

◆ init()

◆ open()

◆ readData()

◆ seekBlock()

◆ setFormat()

◆ setInfo()

◆ start()

◆ timeCompare()

◆ writeData()

Member Data Documentation

◆ ofile

◆ ofileName

◆ ofileNameTime

◆ oformat

◆ omode