Bds::DataFile Class Reference

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

#include <BdsDataFile.h>

Inheritance diagram for Bds::DataFile:

Bds::DataFileAscii Bds::DataFileBdrs Bds::DataFileBds Bds::DataFileBknas Bds::DataFileGcf Bds::DataFileIms Bds::DataFileTapeDigitiser Bds::DataFileWra Bds::DataFileWraAgso List of all members.

Public Types

typedef int Options
 DataOrderUnknown
 DataOrderAll
 DataOrderSample
 DataOrderChannel
 FeatureNone = 0x00
 FeatureCanWrite = 0x01
 FeatureCanRead = 0x02
 OptionNone = 0x00
 OptionValidate = 0x01
 OptionFileNameProcess = 0x02
 OptionValidateCorruptions = 0x04
 OptionReorder = 0x08
 OptionDeleteDuplicates = 0x10
enum  DataOrder { DataOrderUnknown, DataOrderAll, DataOrderSample, DataOrderChannel }
enum  Features { FeatureNone = 0x00, FeatureCanWrite = 0x01, FeatureCanRead = 0x02 }
enum  OptionsList {
  OptionNone = 0x00, OptionValidate = 0x01, OptionFileNameProcess = 0x02, OptionValidateCorruptions = 0x04,
  OptionReorder = 0x08, OptionDeleteDuplicates = 0x10
}

Public Member Functions

 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 BError setInfo (DataInfo &dataInfo, BList< ChannelInfo > &channelInfos)
 Set information on data for write.
virtual BError start (BUInt channel, BUInt segment)
 Start next segment of data.
virtual BError writeData (DataBlock &data)
 Write a block of data.
virtual BError end ()
 End segment.
virtual BError fileNameProcess ()
 Parse the file name for a date/time.
virtual BError getFormat (BString &format)
 Get sub-format.
virtual BError getInfo (DataInfo &dataInfo, Options options, BList< BError > &errors)
 Get info on data.
virtual BError seekBlock (BUInt32 channel, BTimeStamp time, BUInt32 &blockNumber)
 Find requested block on given channel given a time.
virtual BError readData (BUInt32 channel, BUInt32 blockNumber, DataBlock &data)
 Read a block.

Static Public Member Functions

static DataFormat getFormats ()
 Get list of supported formats.

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 Typedef Documentation

typedef int Bds::DataFile::Options


Member Enumeration Documentation

enum Bds::DataFile::DataOrder

Enumerator:
DataOrderUnknown 
DataOrderAll 
DataOrderSample 
DataOrderChannel 

enum Bds::DataFile::Features

Enumerator:
FeatureNone 
FeatureCanWrite 
FeatureCanRead 

enum Bds::DataFile::OptionsList

Enumerator:
OptionNone 
OptionValidate 
OptionFileNameProcess 
OptionValidateCorruptions 
OptionReorder 
OptionDeleteDuplicates 


Constructor & Destructor Documentation

Bds::DataFile::DataFile (  ) 

Bds::DataFile::~DataFile (  )  [virtual]


Member Function Documentation

BError Bds::DataFile::close (  )  [virtual]

Close the file.

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

BError Bds::DataFile::end (  )  [virtual]

End segment.

Reimplemented in Bds::DataFileIms.

BError Bds::DataFile::fileNameProcess (  )  [virtual]

Parse the file name for a date/time.

DataFile::DataOrder Bds::DataFile::getDataOrder (  )  [virtual]

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

Reimplemented in Bds::DataFileBdrs, Bds::DataFileBds, Bds::DataFileIms, Bds::DataFileWra, and Bds::DataFileWraAgso.

int Bds::DataFile::getFeatures (  )  [virtual]

Get bitmask of supported features.

Reimplemented in Bds::DataFileBdrs, Bds::DataFileGcf, Bds::DataFileIms, Bds::DataFileWra, and Bds::DataFileWraAgso.

BString Bds::DataFile::getFileName (  )  [virtual]

Return the file name.

BError Bds::DataFile::getFormat ( BString &  format  )  [virtual]

Get sub-format.

DataFormat Bds::DataFile::getFormats (  )  [static]

Get list of supported formats.

Reimplemented in Bds::DataFileAscii, Bds::DataFileBdrs, Bds::DataFileBds, Bds::DataFileBknas, Bds::DataFileGcf, Bds::DataFileIms, Bds::DataFileTapeDigitiser, Bds::DataFileWra, and Bds::DataFileWraAgso.

BError Bds::DataFile::getInfo ( DataInfo dataInfo,
Options  options,
BList< BError > &  errors 
) [virtual]

Get info on data.

void Bds::DataFile::init (  )  [virtual]

Initialise.

BError Bds::DataFile::open ( BString  fileName,
BString  mode 
) [virtual]

Open the file for read or write.

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

BError Bds::DataFile::readData ( BUInt32  channel,
BUInt32  blockNumber,
DataBlock data 
) [virtual]

Read a block.

Reimplemented in Bds::DataFileBdrs, Bds::DataFileBds, Bds::DataFileGcf, Bds::DataFileTapeDigitiser, Bds::DataFileWra, and Bds::DataFileWraAgso.

BError Bds::DataFile::seekBlock ( BUInt32  channel,
BTimeStamp  time,
BUInt32 &  blockNumber 
) [virtual]

Find requested block on given channel given a time.

Reimplemented in Bds::DataFileBds.

BError Bds::DataFile::setFormat ( BString  format  )  [virtual]

Set the sub-format.

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

BError Bds::DataFile::setInfo ( DataInfo dataInfo,
BList< ChannelInfo > &  channelInfos 
) [virtual]

Set information on data for write.

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

BError Bds::DataFile::start ( BUInt  channel,
BUInt  segment 
) [virtual]

Start next segment of data.

Reimplemented in Bds::DataFileIms.

BError Bds::DataFile::writeData ( DataBlock data  )  [virtual]

Write a block of data.

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


Member Data Documentation

BFile Bds::DataFile::ofile [protected]

BString Bds::DataFile::ofileName [protected]

BTimeStamp Bds::DataFile::ofileNameTime [protected]

BString Bds::DataFile::oformat [protected]

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

BString Bds::DataFile::omode [protected]


The documentation for this class was generated from the following files:
Generated on Wed Jan 27 10:58:40 2010 for BdsApi by  doxygen 1.4.7