BdsApi  3.0.12
This is the Blacknest BDS API.
Public Member Functions | Static Public Member Functions | List of all members
Bds::DataFileBknas Class Reference

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

#include <BdsDataFileBknas.h>

Inheritance diagram for Bds::DataFileBknas:
Bds::DataFile

Public Member Functions

 DataFileBknas ()
 
BError open (BString fileName, BString mode)
 Open the file for read or write. More...
 
BError setInfo (const DataInfo &dataInfo, const ChannelInfos &channelInfos, WriteOptionsList options=WriteOptionSensorData)
 Set information on data for write. More...
 
BError writeData (const DataBlock &data)
 Write a block of data. More...
 
- Public Member Functions inherited from Bds::DataFile
 DataFile ()
 
virtual ~DataFile ()
 
virtual void init ()
 Initialise. 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 BString getFixesInfo ()
 Get readable list of fixes that can be applied to faulty data files. More...
 
virtual BError start (BUInt channel, BUInt segment)
 Start writing next segment of data. More...
 
virtual BError end ()
 End write 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, BUInt32 options, BList< DataError > &errors)
 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 DataFormats getFormats ()
 
- Static Public Member Functions inherited from Bds::DataFile
static DataFormats getFormats ()
 Get list of supported formats. More...
 

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
 

Detailed Description

Data file convertor for BKNAS format files.

Constructor & Destructor Documentation

◆ DataFileBknas()

Bds::DataFileBknas::DataFileBknas ( )

Member Function Documentation

◆ getFormats()

DataFormats Bds::DataFileBknas::getFormats ( )
static

◆ open()

BError Bds::DataFileBknas::open ( BString  fileName,
BString  mode 
)
virtual

Open the file for read or write.

Reimplemented from Bds::DataFile.

◆ setInfo()

BError Bds::DataFileBknas::setInfo ( const DataInfo dataInfo,
const ChannelInfos channelInfos,
WriteOptionsList  options = WriteOptionSensorData 
)
virtual

Set information on data for write.

Reimplemented from Bds::DataFile.

◆ writeData()

BError Bds::DataFileBknas::writeData ( const DataBlock data)
virtual

Write a block of data.

Reimplemented from Bds::DataFile.


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