Bds::DataFileCss Class Reference

Data file convertor for CSS format files. More...

#include <BdsDataFileCss.h>

Inheritance diagram for Bds::DataFileCss:

Public Member Functions
	DataFileCss ()
int	getFeatures ()
	Get bitmask of supported features.
DataOrder	getDataOrder ()
	Get the expected order of writing data, by sample or by channel.
BError	getInfo (DataInfo &dataInfo, DataFileOptions options, BList< DataError > &errors)
	Get info on data.
BError	readData (BUInt32 channel, BUInt segment, BUInt32 blockNumber, DataBlock &data)
	Read a block.
Public Member Functions inherited from Bds::DataFile
	DataFile ()
virtual	~DataFile ()
virtual void	init ()
	Initialise.
virtual BError	open (BString fileName, BString mode)
	Open the file for read or write.
virtual BError	close ()
	Close the file.
virtual BError	setFormat (BString format)
	Set the sub-format.
virtual BString	getFileName ()
	Return the file name.
virtual DataOrder	getDataOrder ()
	Get the expected order of writing data, by sample or by channel.
virtual int	getFeatures ()
	Get bitmask of supported features.
virtual BString	getFixesInfo ()
	Get readable list of fixes that can be applied to faulty data files.
void	getNotices (BStringList &notices)
	Get a list of any notices.
virtual BError	setInfo (const DataInfo &dataInfo, const ChannelInfos &channelInfos, WriteOptionsList options=WriteOptionNone)
	Set information on data for write.
virtual BError	start (BUInt channel, BUInt segment)
	Start writing next segment of data.
virtual BError	writeData (const DataBlock &data)
	Write a block of data.
virtual BError	end ()
	End write segment.
virtual BError	flush ()
	Flush data to disk.
virtual BError	fileNameProcess ()
	Parse the file name for a date/time.
virtual BError	getFormat (BString &format)
	Get sub-format.
virtual BError	getInfo (DataInfo &dataInfo, DataFileOptions options, BList< DataError > &errors)
	Get info on data.
virtual BError	seekBlock (BUInt32 channel, BUInt segment, BTimeStamp time, BUInt32 &blockNumber, BUInt64 &sampleNumber, DataBlock &data)
	Find requested block on given channel given a time.
virtual BError	readData (BUInt32 channel, BUInt segment, BUInt32 blockNumber, DataBlock &dataBlock)
	Read a block.
virtual BError	getMetaData (ChannelInfos &channelInfos, BUInt32 options, BList< DataError > &errors)
	Return all known MetaData in the file.
void	dataErrorFixup (const DataInfo &dataInfo, BList< DataError > &errors)
	Fixup data errors, mainly start/end times to be within data.
BInt64	timeCompare (BTimeStamp t1, BTimeStamp t2, BUInt diff)
	Compare timestamps with a margin.
int	duplicateCheck (const DataBlock &data1, const DataBlock &data2, BUInt channel=0)
	Check if blocks are duplicates.
BUInt64	getFilePosition ()

Static Public Member Functions
static DataFormats	getFormats ()
Static Public Member Functions inherited from Bds::DataFile
static DataFormats	getFormats ()
	Get list of supported formats.

Additional Inherited Members
Public Types inherited from Bds::DataFile
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 , ReadOptionFixCorruptions = 0x04 ,   ReadOptionReorder = 0x08 , ReadOptionDeleteDuplicates = 0x10 , ReadOptionInfoExtra = 0x20 , ReadOptionIgnoreSamplerate = 0x40 ,   ReadOptionPrintBlocks = 0x80 , ReadOptionFixSampleRate = 0x100 }
Protected Attributes inherited from Bds::DataFile
BString	ofileName
BString	omode
BTimeStamp	ofileNameTime
BFile	ofile
BString	oformat
BStringList	onotices

Detailed Description

Data file convertor for CSS format files.

Constructor & Destructor Documentation

DataFileCss()

Bds::DataFileCss::DataFileCss

(

)

Member Function Documentation

getFeatures()

int Bds::DataFileCss::getFeatures ( )

virtual

Get bitmask of supported features.

Reimplemented from Bds::DataFile.

getDataOrder()

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

virtual

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

Reimplemented from Bds::DataFile.

getInfo()

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

virtual

Get info on data.

Parameters

dataInfo	Info on the Sensor data channels to be written
options	A bitmask of options including: ReadOptionValidate = 0x01, ReadOptionFileNameProcess = 0x02, ReadOptionFixCorruptions = 0x04, ReadOptionReorder = 0x08, ReadOptionDeleteDuplicates = 0x10, ReadOptionInfoExtra = 0x20, ReadOptionIgnoreSamplerate = 0x40, ReadOptionPrintBlocks = 0x80, ReadOptionFixSampleRate = 0x100
errors	Returns a list of errors and/or warnings ReadOptionValidate: performs data file validation ReadOptionFileNameProcess: Validate the filename for particular file formats ReadOptionFixCorruptions: Fix know file curruptions ReadOptionReorder: Re-order blocks into time order ReadOptionDeleteDuplicates: Delete duplicate blocks where they are completely duplicate in startTime and data. ReadOptionInfoExtra: Read the extra string Metadata information specific to the format ReadOptionIgnoreSamplerate: Ignore samplerate differences ReadOptionPrintBlocks: debug option to print information on the blocks to stdout ReadOptionFixSampleRate: Fors specific formats fixe curruptions in the samplerate gieven

This function scans the file and returns detailed Metadata from the blocks in the file.

Reimplemented from Bds::DataFile.

readData()

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

virtual

Read a block.

Parameters

channel	The channel number. 0 Means all channels
segment	The segment number. 0 Means all segments
blockNumber	The block number. This starts from 0.
dataBlock	The returned DataBlock

This function is used to read a data block from the file.

Reimplemented from Bds::DataFile.

getFormats()

DataFormats Bds::DataFileCss::getFormats ( )

static

---

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

• /src/blacknest/bds/bds/bdsDataLib/BdsDataFileCss.h
• /src/blacknest/bds/bds/bdsDataLib/BdsDataFileCss.cpp