Skip to content

D
DaqIOLib
Commit dab6e161 by yiannis
Options

Added doxygen docs; modularized classes in source files'

parent 59bb107d
Showing with 1582 additions and 329 deletions
DaqBuffer.h 0 → 100644
//////////////////////////////////////////////////////////////////////////////////////////
///
/// $Id: DaqBuffer.h,v 1.1 2005/03/14 18:30:48 yiannis Exp $
///
/// Date: December 2004
///
/// Description:
/// A small class that maintains a buffer
///
/////////////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup clib
/// This support class provides buffer space for copying daq data out of a
/// DAQ file. It is used in lieu of raw buffers to minimize the likelihood of
/// memory leaks.
///
/// The class itself is not aware of the type or cardinality of the data,
/// however, it provides a few type-specific access functions to facilitate
/// data access when the user knows the type of data.
///
class CDaqBuffer {
public:
CDaqBuffer() { m_Count = 0; };
~CDaqBuffer() {};
vector<TDaqByte>::const_pointer GetDataPtr() const; ///< Return faw pointer to data
int GetCount() const; ///< Return number of typed elements in buffer
int GetSize() const; ///< Return buffer size in bytes
char* GetChar(int ind=0); ///< Return char type pointer to data
int* GetInt(int ind=0); ///< Return int type pointer to data
float* GetFloat(int ind=0); ///< Return float type pointer to data
double* GetDouble(int ind=0); ///< Return double type pointer to data
short* GetShort(int ind=0); ///< Return short type pointer to data
friend class CDaqLowLevelIo;
vector<TDaqByte> m_Data; ///< data is stored here
protected:
void Append(const void *pData, int size, int count); ///< Add data
void Replace(const void *pData, size_t size, int count); ///< Replace data
void AllocSpace(int size, int count=0); ///< Allocate space
void Clear(void); ///< Release everything
int m_Count; ///< count of data, not in bytes but in type
};
///
/// This function ...
//
inline int
CDaqBuffer::GetSize() const
{
return (int)m_Data.size();
};
///
/// This function ...
inline int
CDaqBuffer::GetCount() const
{
return m_Count;
}
///
/// Return ...
///
inline char*
CDaqBuffer::GetChar(int ind)
{
return ((char *)&m_Data[0]) + ind;
};
///
/// Return ...
///
inline int*
CDaqBuffer::GetInt(int ind)
{
return ((int *)&m_Data[0]) + ind;
};
///
/// This function ...
//
inline float*
CDaqBuffer::GetFloat(int ind) ///< Return float type pointer to data
{
return ((float *)&m_Data[0]) + ind;
};
///
/// This function ...
//
inline double*
CDaqBuffer::GetDouble(int ind) ///< Return double type pointer to data
{
return ((double *)&m_Data[0]) + ind;
};
///
/// This function ...
//
inline short*
CDaqBuffer::GetShort(int ind) ///< Return short type pointer to data
{
return ((short *)&m_Data[0]) + ind;
};
////////////////////////////////////////////////////////////////////////////////
///
/// This function returns a raw pointer to the data in the buffer.
///
inline vector<TDaqByte>::const_pointer
CDaqBuffer::GetDataPtr() const
{
return &m_Data[0];
};
/////////////////////////////////////////////////////////////////////////////////
///
/// This function adds data to the DaqBuffer. It is used by the DAQ library
/// to build the buffers returned to the user, and as such, is not meant to
/// be used by the library client.
///
/// The function receives a pointer to the data, the size of the buffer in
/// bytes and a count of elements in that buffer. The class deals with
/// untyped buffers, so the only way to keep track of how many elements
/// are in the buffer (i.e., 2 integers as opposed to 8 bytes) is for the
/// caller to provide that information, which in this case is the count
/// argument.
///
inline void
CDaqBuffer::Append(
const void* p, ///< pointer to data to append
int size, ///< size in bytes of data
int count) ///< count of data items in that buffer
{
size_t oldsize = m_Data.size();
m_Data.resize(oldsize + size);
memcpy(&m_Data[0]+oldsize, p, size);
m_Count += count;
}
/////////////////////////////////////////////////////////////////////////////////
///
/// This function replaces the existing data with new one.
///
/// The function receives a pointer to the data, the size of the buffer in
/// bytes and a count of elements in that buffer. The class deals with
/// untyped buffers, so the only way to keep track of how many elements
/// are in the buffer (i.e., 2 integers as opposed to 8 bytes) is for the
/// caller to provide that information, which in this case is the count
/// argument.
///
inline void
CDaqBuffer::Replace(
const void* p, ///< pointer to data to append
size_t size, ///< size in bytes of data
int count) ///< count of data items in that buffer
{
size_t oldsize = m_Data.size();
if ( oldsize < size ) {
m_Data.resize(size);
}
memcpy(&m_Data[0], p, size);
m_Count = count;
}
/////////////////////////////////////////////////////////////////////////////////
///
/// This function allocates space in the DaqBuffer.
///
///
inline void
CDaqBuffer::AllocSpace(
int size, ///< size in bytes of data
int count) ///< count of data items in that buffer
{
m_Data.resize(size);
m_Count = count;
}
/////////////////////////////////////////////////////////////////////////////////
///
/// This function allocates space in the DaqBuffer.
///
inline void
CDaqBuffer::Clear(void)
{
m_Data.clear(); m_Count = 0;
}
DaqChannelInfo.h 0 → 100644
///////////////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup clib
/// This class represents all information about a channel stored in the DAQ file.
/// Each channel consist of a number of samples, each sample containing one or more
/// values of the same type. The term item is used to refer to one of those values.
/// The term record is used to refer to all the values in a sample.
///
/// The information maintained for each channel includes an identifier (which
/// is nothing more than the ordinal number of the channel in the definition array),
/// the type of the data, the cardinality of the data, its name and the capture
/// rate. The capture rate is given in Hz and is always a sub-multiple of the DAQ
/// maximum sampling rate.
///
/// In addition, there are three options that refer to the method by which the
/// data for a channel is collected. The sampling rate indicates how often
/// data for that channel is sampled. Usually, the maximum sampling rate
/// is 240 Hz, but most channels are sampled at a frequency lower than that.
/// Data stored in 'differential' mode are only stored when their value has
/// changed from the previously stored value. This can save a tremendous
/// amount of space especially for large but largely unchanged channels.
/// Finally, variable length channels are array channels (i.e., cardinality > 1)
/// that have only a subset of the array stored for each sample. This is done
/// to save space, when the real-time software knows that only a subset of the
/// array has valid data.
///
class CDaqChannelInfo {
public:
CDaqChannelInfo() {
m_Id = m_Items = m_CapRate = m_Type = -1;
m_VarLen = false;
m_Name = "";
}
~CDaqChannelInfo() {};
int GetItemSize() const; ///< A
int GetRecSize() const; ///< B
int GetItemCount() const; ///< C
int GetType() const; ///< D
int GetId() const; ///< E
const string& GetName() const; ///< H
int GetCapRate() const; ///< G
bool IsVarLen() const; ///< H
friend class CDaqLowLevelIo;
private:
int m_Id;
int m_Items;
string m_Name;
int m_CapRate;
int m_Type;
bool m_VarLen;
};
/// Return true, if channel is a variable length array
inline bool
CDaqChannelInfo::IsVarLen(void) const
{
return m_VarLen;
}
///// Return sampling rate, in Hz
inline int
CDaqChannelInfo::GetCapRate(void) const
{
return m_CapRate;
}
///// Return name as specified in cell file
inline const string &
CDaqChannelInfo::GetName(void) const
{
return m_Name;
}
///
/// Return the channel identifier, a small integer that can be
/// used to reference the channel in other calls.
///
/// Keep in mind that the channel identifer can change among DAQ files,
/// even if it refers to the same cell variable.
///
inline int
CDaqChannelInfo::GetId(void) const
{
return m_Id;
}
///// Return type (c=char, f=float, i=int, s=short, d=double
inline int
CDaqChannelInfo::GetType(void) const
{
return m_Type;
}
///// Return number of items in each sample
inline int
CDaqChannelInfo::GetItemCount(void) const
{
return m_Items;
}
/////////// Return record size, in bytes
inline int
CDaqChannelInfo::GetRecSize(void) const
{
return GetItemSize() * GetItemCount();
}
DaqFileIO.cxx
/////////////////////////////////////////////////////////////////////////////
//
// DAQ low level IO Library
//
//
///
/// DAQ low level IO Library
///
/// \defgroup clib C++ Library
///
/// @{
///
#include "DaqIo.h"
#include <assert.h>
//
// Small dummy function to act as the default callback
//
///
/// Small dummy function to act as the default callback
///
static void DefaultErrorFunc(const char *, const char *) {}
///
/// Default functionality for the progress callback
///
static void DefaultProgressFunc(const char *, int, int) {}
struct TFrameInfo {
......@@ -71,6 +78,9 @@ CDaqLowLevelIo::SetCallbacks(
///
/// Doc
///
bool
CDaqLowLevelIo::GetChannelInfo(
int chId,
......@@ -91,7 +101,9 @@ CDaqLowLevelIo::GetChannelInfo(
return true;
}
///
/// adf
///
void
NearDump(FILE* p, int ofs)
{
......@@ -794,7 +806,7 @@ CDaqLowLevelIo::ReadTocFile(
//////////////////////////////////////////////////////////////////////////////////
///
/// This functions returns information about the file's integrity. It can
/// This function returns information about the file's integrity. It can
/// only be called after CheckIntegrity has successfully returned.
///
/// The function returns (in the provided arguments) two arrays of
......@@ -807,9 +819,9 @@ CDaqLowLevelIo::ReadTocFile(
///
bool
CDaqLowLevelIo::QueryIntegrityValues(
vector<int>& drops,
vector<int>& dropedFrm,
vector<int>& skips,
TIntVec& drops,
TIntVec& dropedFrm,
TIntVec& skips,
TDaqEofStatus& eofStat)
{
if ( m_HaveToc == false ) return false;
......@@ -1058,7 +1070,6 @@ CDaqLowLevelIo::CheckIntegrity(
}
}
m_LastError = "";
return true;
}
......@@ -1083,8 +1094,8 @@ CDaqLowLevelIo::CheckIntegrity(
///
bool
CDaqLowLevelIo::LowLevelDataRead(
const vector<int>* pWhichChannels,
vector<CDaqBuffer>& userStorage,
const TIntVec* pWhichChannels,
TDataVec& userStorage,
vector<TIntVec>* pFrameList
)
{
......@@ -1751,7 +1762,7 @@ CDaqLowLevelIo::GetFullData(
CDaqLowLevelIo::TReadErrorCode
CDaqLowLevelIo::ReadDataForOneFrame(
int numEntriesInThisRecord,
vector<int> needChannel,
TIntVec needChannel,
TDataVec& storage,
void* pTempSpace,
vector<bool>& gotData
......@@ -1889,5 +1900,6 @@ CDaqLowLevelIo::ReadFrameHeader(
}
frameToRead = -1; // no seeking needed after a resync
}
}
/// @}
DaqIOLib.vcproj
......@@ -113,8 +113,17 @@
Filter="h;hpp;hxx;hm;inl;inc;xsd"
UniqueIdentifier="{93995380-89BD-4b04-88EB-625FBE52EBFB}">
<File
RelativePath=".\DaqBuffer.h">
</File>
<File
RelativePath=".\DaqChannelInfo.h">
</File>
<File
RelativePath=".\DaqIo.h">
</File>
<File
RelativePath=".\DaqIoLib.h">
</File>
</Filter>
<Filter
Name="Resource Files"
......
DaqIo.h
///////////////////////////////////////////////////////////////////////////////////////////////////
///
///
///
#include <stdio.h>
#include <string>
#include <vector>
#include <map>
using namespace std;
class CDaqBuffer;
class CDaqChannelInfo;
#define DAQ_MAGIC_NUM_VER_2_0 0x2C3D4E5F
#define DAQ_MAGIC_NUM_VER_2_1 0x2C3D4E6F
#define DAQ_MAGIC_NUM_VER_2_2 0x2C3D4E7F
#define DAQ_END_MARK 0x1A2B2C3D
#define DAQ_TOC_MAGIC_NUM 0x2C3ABCDE
typedef unsigned char TDaqByte;
typedef vector<int> TIntVec;
typedef vector<string> TStrVec;
typedef vector<CDaqBuffer> TDataVec;
typedef vector<FILE *> TFileVec;
typedef vector<CDaqChannelInfo> TChanInfoVec;
const int cMaxDaqRec = 128*1024; ///< maximum size of data per DAQ record
const int cMaxChannels = 500; ///< maximum number of channels we can handle
const int cMaxChannResyncLookahead = 2*1024;
///////////////////////////////////////////////////////////////////////////////////
///
/// This enumeration encapsulates various conversion options
/// Appropriate operators have been defined so combining options
/// can be done by using + or |
///
typedef enum {
eNO_OPTION = 0,
eEXPAND_DIFFERENTIAL = 1,
eFILL_MISSING = 2,
eINCLUDE_FRAME = 4,
eBINARY_FORMAT = 32,
eASCII_FORMAT = 64
} TConvertOptions;
inline TConvertOptions
operator+(TConvertOptions left, TConvertOptions right) {
return (TConvertOptions)((int)left + (int)right);
}
inline TConvertOptions
operator|(TConvertOptions left, TConvertOptions right) {
return (TConvertOptions)((int)left | (int)right);
}
///////////////////////////////////////////////////////////////////////////////////////////
///
/// Return code used to specify the status of the end marker of the DAQ file
///
typedef enum {
eDAQ_EOF_OK = 0, ///< Found full EOF marker
eDAQ_EOF_PARTIAL_MARK = 1, ///< Found a partial marker
eDAQ_EOF_NOTFOUND = 2, ///< No EOF marker found
eDAQ_EOF_UNDEFINED = 3 ///< No information available yet
} TDaqEofStatus;
///////////////////////////////////////////////////////////////////////////////////////////
///
/// This class represents all information about a channel stored in the DAQ file.
/// Each channel consist of a number of samples, each sample containing one or more
/// values of the same type. The term item is used to refer to one of those values.
/// The term record is used to refer to all the values in a sample.
///
/// The information maintained for each channel includes an identifier (which
/// is nothing more than the ordinal number of the channel in the definition array),
/// the type of the data, the cardinality of the data, its name and the capture
/// rate. The capture rate is given in Hz and is always a sub-multiple of the DAQ
/// maximum sampling rate.
///
/// In addition, there are three options that refer to the method by which the
/// data for a channel is collected. The sampling rate indicates how often
/// data for that channel is sampled. Usually, the maximum sampling rate
/// is 240 Hz, but most channels are sampled at a frequency lower than that.
/// Data stored in 'differential' mode are only stored when their value has
/// changed from the previously stored value. This can save a tremendous
/// amount of space especially for large but largely unchanged channels.
/// Finally, variable length channels are array channels (i.e., cardinality > 1)
/// that have only a subset of the array stored for each sample. This is done
/// to save space, when the real-time software knows that only a subset of the
/// array has valid data.
///
class CDaqChannelInfo {
public:
CDaqChannelInfo() {
m_Id = m_Items = m_CapRate = m_Type = -1;
m_VarLen = false;
m_Name = "";
}
~CDaqChannelInfo() {};
int GetItemSize() const;
int GetRecSize() const;
int GetItemCount() const;
int GetType() const;
int GetId() const;
const string& GetName() const;
int GetCapRate() const;
bool IsVarLen() const;
friend class CDaqLowLevelIo;
private:
int m_Id;
int m_Items;
string m_Name;
int m_CapRate;
int m_Type;
bool m_VarLen;
};
/// Return true, if channel is a variable length array
inline bool
CDaqChannelInfo::IsVarLen(void) const
{
return m_VarLen;
}
///// Return sampling rate, in Hz
inline int
CDaqChannelInfo::GetCapRate(void) const
{
return m_CapRate;
}
///// Return name as specified in cell file
inline const string &
CDaqChannelInfo::GetName(void) const
{
return m_Name;
}
///
/// Return the channel identifier, a small integer that can be
/// used to reference the channel in other calls.
///
/// Keep in mind that the channel identifer can change among DAQ files,
/// even if it refers to the same cell variable.
///
inline int
CDaqChannelInfo::GetId(void) const
{
return m_Id;
}
///// Return type (c=char, f=float, i=int, s=short, d=double
inline int
CDaqChannelInfo::GetType(void) const
{
return m_Type;
}
///// Return number of items in each sample
inline int
CDaqChannelInfo::GetItemCount(void) const
{
return m_Items;
}
/////////// Return record size, in bytes
inline int
CDaqChannelInfo::GetRecSize(void) const
{
return GetItemSize() * GetItemCount();
}
/////////////////////////////////////////////////////////////////////////////////////////
///
/// This support class provides buffer space for copying daq data out of a
/// DAQ file. It is used in lieu of raw buffers to minimize the likelihood of
/// memory leaks.
///
/// The class itself is not aware of the type or cardinality of the data,
/// however, it provides a few type-specific access functions to facilitate
/// data access when the user knows the type of data.
///
class CDaqBuffer {
public:
CDaqBuffer() { m_Count = 0; };
~CDaqBuffer() {};
vector<TDaqByte>::const_pointer GetDataPtr() const { return &m_Data[0]; };
int GetCount() const ///< Return number of typed elements in buffer
{ return m_Count; };
int GetSize() const ///< Return buffer size in bytes
{ return (int)m_Data.size(); };
char* GetChar(int ind=0) ///< Return char type pointer to data
{ return ((char *)&m_Data[0]) + ind; };
int* GetInt(int ind=0) ///< Return int type pointer to data
{ return ((int *)&m_Data[0]) + ind; };
float* GetFloat(int ind=0) ///< Return float type pointer to data
{ return ((float *)&m_Data[0]) + ind; };
double* GetDouble(int ind=0) ///< Return double type pointer to data
{ return ((double *)&m_Data[0]) + ind; };
short* GetShort(int ind=0) ///< Return short type pointer to data
{ return ((short *)&m_Data[0]) + ind; };
friend class CDaqLowLevelIo;
vector<TDaqByte> m_Data; // data is stored here
protected:
void Append(const void *pData, int size, int count);
void Replace(const void *pData, size_t size, int count);
void AllocSpace(int size, int count=0);
void Clear(void) { m_Data.clear(); m_Count = 0; };
int m_Count; // count of data, not in bytes but in type
};
/////////////////////////////////////////////////////////////////////////////////
///
/// This function adds data to the DaqBuffer. It is used by the DAQ library
/// to build the buffers returned to the user, and as such, is not meant to
/// be used by the library client.
///
/// The function receives a pointer to the data, the size of the buffer in
/// bytes and a count of elements in that buffer. The class deals with
/// untyped buffers, so the only way to keep track of how many elements
/// are in the buffer (i.e., 2 integers as opposed to 8 bytes) is for the
/// caller to provide that information, which in this case is the count
/// argument.
///
inline void
CDaqBuffer::Append(
const void* p, ///< pointer to data to append
int size, ///< size in bytes of data
int count) ///< count of data items in that buffer
{
size_t oldsize = m_Data.size();
m_Data.resize(oldsize + size);
memcpy(&m_Data[0]+oldsize, p, size);
m_Count += count;
}
/////////////////////////////////////////////////////////////////////////////////
///
/// This function replaces the existing data with new one.
///
/// The function receives a pointer to the data, the size of the buffer in
/// bytes and a count of elements in that buffer. The class deals with
/// untyped buffers, so the only way to keep track of how many elements
/// are in the buffer (i.e., 2 integers as opposed to 8 bytes) is for the
/// caller to provide that information, which in this case is the count
/// argument.
///
inline void
CDaqBuffer::Replace(
const void* p, ///< pointer to data to append
size_t size, ///< size in bytes of data
int count) ///< count of data items in that buffer
{
size_t oldsize = m_Data.size();
if ( oldsize < size ) {
m_Data.resize(size);
}
memcpy(&m_Data[0], p, size);
m_Count = count;
}
/////////////////////////////////////////////////////////////////////////////////
///
/// This function allocates space in the DaqBuffer.
///
///
inline void
CDaqBuffer::AllocSpace(
int size, ///< size in bytes of data
int count) ///< count of data items in that buffer
{
m_Data.resize(size);
m_Count = count;
}
#include "DaqIoLib.h"
#include "DaqBuffer.h"
#include "DaqChannelInfo.h"
/////////////////////////////////////////////////////////////////////////////
///
/// \ingroup clib
/// This class provides an API that does low level reading from a DAQ
/// file. In particular, each DAQ file is treated as a set of independent
/// channels, with each channel having its own type/cardinality/sampling
......@@ -312,8 +30,14 @@ public:
CDaqLowLevelIo();
~CDaqLowLevelIo();
bool Open(const string &);
void GetChannels(TChanInfoVec& channels) const;
bool LowLevelDataRead(const TIntVec* , TDataVec& , vector<TIntVec>* pFrameList=0);
bool LowLevelDataCopy(const TIntVec* chans, TFileVec& dest,
TConvertOptions options = eBINARY_FORMAT + eINCLUDE_FRAME);
bool GetFullData(const TIntVec* chans, TDataVec& data, TConvertOptions option = eNO_OPTION,
int firstFrame = -1, int lastFrame = -1, vector<TIntVec>* pFrameList = 0);
bool Open(const string &); ///< Open the file
void GetChannels(TChanInfoVec& channels) const; ///< Return info about channels
bool GetChannelInfo(int chId, CDaqChannelInfo &info) const;
int GetFirstFrame() const;
int GetLastFrame() const;
......@@ -325,27 +49,23 @@ public:
const string& GetSubject() const;
const string& GetRun() const;
const string& GetRunInst() const;
const string& GetFileName() const { return m_Filename; };
const string& GetFileName() const;
size_t GetNumChannels() const;
bool TocFileExists() const { return m_TocExists; };
bool TocFileExists() const;
bool CheckIntegrity(bool buildToc = false, bool forceFileCreate = false);
bool QueryIntegrityValues(TIntVec& drops, TIntVec& dropedFrm, TIntVec& skips,
TDaqEofStatus &stat);
const string& GetLastError(void) const
const string& GetLastError(void) const ///< Return text of most recent error
{ return m_LastError; };
void Close(void);
void Close(void); ///< Close the file
bool FrameDropped(int frm);
bool FrameHasData(int frm);
void SetCallbacks( void errf(const char *, const char *), void progf(const char *, int, int));
bool LowLevelDataRead(const TIntVec* chans, TDataVec& data, vector<TIntVec>* pFrameList=0);
bool LowLevelDataCopy(const TIntVec* chans, TFileVec& dest,
TConvertOptions options = eBINARY_FORMAT + eINCLUDE_FRAME);
bool GetFullData(const TIntVec* chans, TDataVec& data, TConvertOptions option = eNO_OPTION,
int firstFrame = -1, int lastFrame = -1, vector<TIntVec>* pFrameList = 0);
private:
enum TReadErrorCode {
......@@ -374,9 +94,6 @@ private:
TReadErrorCode ReadFrameHeader(int, int& ,int&, int&);
TReadErrorCode ReadDataForOneFrame(int, TIntVec, TDataVec &, void *, vector<bool>&);
// bool GenPurpTraverse(bool frameCB(int frm, int numC, bool end),
// bool channelCB(int frm, int chan) );
string m_Filename;
string m_Version; // file version
FILE* m_pFile;
......@@ -407,13 +124,22 @@ private:
TIntVec m_Skips; // groups of bytes skipped
};
//////////////////////////////////////////////////////////////////////////////
///
/// Return an STL vector containing information about all the channels in the
/// DAQ file.
///
inline void
CDaqLowLevelIo::GetChannels(TChanInfoVec & chn) const
{
chn = m_Channels;
}
/// Return the title stored in the DAQ file
//////////////////////////////////////////////////////////////////////////////
///
/// Return the title stored in the DAQ file.
///
inline const string &
CDaqLowLevelIo::GetTitle(void) const
{
......@@ -421,36 +147,51 @@ CDaqLowLevelIo::GetTitle(void) const
}
/// Return the DAQ file version number
//////////////////////////////////////////////////////////////////////////////
///
/// Return the DAQ file version number as an STL string.
inline const string &
CDaqLowLevelIo::GetVersion(void) const
{
return m_Version;
}
//////////////////////////////////////////////////////////////////////////////
///
/// Return the run instance name. If the feature is not
/// supported due to an older version, an empty string is returned
/// supported due to an older version, an empty string is returned.
///
inline const string &
CDaqLowLevelIo::GetRunInst(void) const
{
return m_RunInst;
}
/// Return the subject name
//////////////////////////////////////////////////////////////////////////////
///
/// Return the subject name (also known as the participant).
///
inline const string &
CDaqLowLevelIo::GetSubject(void) const
{
return m_Subj;
}
//////////////////////////////////////////////////////////////////////////////
///
/// Return the name of the Run that produced the daq file
///
inline const string &
CDaqLowLevelIo::GetRun(void) const
{
return m_Run;
}
/// Return the file creation date as stored in the heade
//////////////////////////////////////////////////////////////////////////////
///
/// Return the file creation date as stored in the header
///
inline const string &
CDaqLowLevelIo::GetDate(void) const
{
......@@ -458,37 +199,74 @@ CDaqLowLevelIo::GetDate(void) const
}
/// Return the sampling frequency
//////////////////////////////////////////////////////////////////////////////
///
/// Return the sampling frequency, in Hz. The frequency is an integer.
///
inline int
CDaqLowLevelIo::GetFrequency(void) const
{
return m_Frequency;
}
//////////////////////////////////////////////////////////////////////////////
///
/// Return the total number of frames in the file
///
inline int
CDaqLowLevelIo::GetFrames(void) const
{
return m_LastFrame - m_FirstFrame;
}
/// Return the first frame number
//////////////////////////////////////////////////////////////////////////////
///
/// Return the first FBS frame number
///
inline int
CDaqLowLevelIo::GetFirstFrame(void) const
{
return m_FirstFrame;
}
/// Return the last frame number
//////////////////////////////////////////////////////////////////////////////
///
/// Return the last FBS frame number
///
inline int
CDaqLowLevelIo::GetLastFrame(void) const
{
return m_LastFrame;
}
//////////////////////////////////////////////////////////////////////////////
///
/// This funcion returns the number of channels in the DAQ file
///
inline size_t
CDaqLowLevelIo::GetNumChannels(void) const
{
return m_Channels.size();
}
//////////////////////////////////////////////////////////////////////////////
///
/// This function returns the name of the DAQ file
///
inline const string&
CDaqLowLevelIo::GetFileName() const
{
return m_Filename;
};
//////////////////////////////////////////////////////////////////////////////
///
/// Returns a boolean indicating if the toc already exists.
///
inline bool
CDaqLowLevelIo::TocFileExists() const
{
return m_TocExists;
};
///
\ No newline at end of file
DaqIoLib.h 0 → 100644
using namespace std;
class CDaqBuffer;
class CDaqChannelInfo;
#define DAQ_MAGIC_NUM_VER_2_0 0x2C3D4E5F
#define DAQ_MAGIC_NUM_VER_2_1 0x2C3D4E6F
#define DAQ_MAGIC_NUM_VER_2_2 0x2C3D4E7F
#define DAQ_END_MARK 0x1A2B2C3D
#define DAQ_TOC_MAGIC_NUM 0x2C3ABCDE
typedef unsigned char TDaqByte;
typedef vector<int> TIntVec;
typedef vector<string> TStrVec;
typedef vector<CDaqBuffer> TDataVec;
typedef vector<FILE *> TFileVec;
typedef vector<CDaqChannelInfo> TChanInfoVec;
const int cMaxDaqRec = 128*1024; ///< maximum size of data per DAQ record
const int cMaxChannels = 500; ///< maximum number of channels we can handle
const int cMaxChannResyncLookahead = 2*1024;
///////////////////////////////////////////////////////////////////////////////////
///
/// This enumeration encapsulates various conversion options
/// Appropriate operators have been defined so combining options
/// can be done by using + or |
///
typedef enum {
eNO_OPTION = 0,
eEXPAND_DIFFERENTIAL = 1,
eFILL_MISSING = 2,
eINCLUDE_FRAME = 4,
eBINARY_FORMAT = 32,
eASCII_FORMAT = 64
} TConvertOptions;
inline TConvertOptions
operator+(TConvertOptions left, TConvertOptions right) {
return (TConvertOptions)((int)left + (int)right);
}
inline TConvertOptions
operator|(TConvertOptions left, TConvertOptions right) {
return (TConvertOptions)((int)left | (int)right);
}
///////////////////////////////////////////////////////////////////////////////////////////
///
/// Return code used to specify the status of the end marker of the DAQ file
///
typedef enum {
eDAQ_EOF_OK = 0, ///< Found full EOF marker
eDAQ_EOF_PARTIAL_MARK = 1, ///< Found a partial marker
eDAQ_EOF_NOTFOUND = 2, ///< No EOF marker found
eDAQ_EOF_UNDEFINED = 3 ///< No information available yet
} TDaqEofStatus;
doxyfile.txt 0 → 100644
# Doxyfile 1.3.4
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
# TAG = value [value, ...]
# For lists items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "NADS DAQ File Access"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 1.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = htmlDoc
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
OUTPUT_LANGUAGE = English
# This tag can be used to specify the encoding used in the generated output.
# The encoding is not always determined by the language that is chosen,
# but also whether or not the output is meant for Windows or non-Windows users.
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
# forces the Windows encoding (this is the default for the Windows binary),
# whereas setting the tag to NO uses a Unix-style encoding (the default for
# all platforms other than Windows).
USE_WINDOWS_ENCODING = YES
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
REPEAT_BRIEF = NO
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
# description.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
# members of a class in the documentation of that class as if those members were
# ordinary class members. Constructors, destructors and assignment operators of
# the base classes will not be shown.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
FULL_PATH_NAMES = NO
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. It is allowed to use relative paths in the argument list.
STRIP_FROM_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
# doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like the Qt-style comments (thus requiring an
# explict @brief command for a brief description.
JAVADOC_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
# description. Set this tag to YES if you prefer the old behaviour instead.
MULTILINE_CPP_IS_BRIEF = NO
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member
# documentation.
DETAILS_AT_TOP = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# reimplements.
INHERIT_DOCS = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
DISTRIBUTE_GROUP_DOC = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
# only. Doxygen will then generate output that is more tailored for Java.
# For instance, namespaces will be presented as packages, qualified scopes
# will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
# the \nosubgrouping command.
SUBGROUPING = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.
EXTRACT_LOCAL_CLASSES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
# documentation.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
# function's detailed documentation block.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# users are advised to set this option to NO.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
# of that file.
SHOW_INCLUDE_FILES = NO
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
# declaration order.
SORT_MEMBER_DOCS = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
# commands in the documentation.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
# command in the documentation regardless of this setting.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
QUIET = YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
WARNINGS = YES
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
WARN_IF_UNDOCUMENTED = YES
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly.
WARN_IF_DOC_ERROR = YES
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
# to stderr.
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = DaqFileIo.cxx DaqIoLib.h DaqChannelInfo.h DaqIo.h DaqBuffer.h
INPUT += ..\matlabiface\daqClose\daqClose.cpp
INPUT += ..\matlabiface\daqOpen\daqOpen.cpp
INPUT += ..\matlabiface\daqRead\daqRead.cpp
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
FILE_PATTERNS =
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
EXCLUDE_PATTERNS =
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter>
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.
INPUT_FILTER =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
# then for each documented function all documented
# functions referencing it will be listed.
REFERENCED_BY_RELATION = YES
# If the REFERENCES_RELATION tag is set to YES (the default)
# then for each documented function all documented entities
# called/used by that function will be listed.
REFERENCES_RELATION = NO
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
# which an include is specified. Set to NO to disable this.
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
# contains a lot of classes, structs, unions or interfaces.
ALPHABETICAL_INDEX = NO
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# in which this list will be split (can be a number in the range [1..20])
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
# should be ignored while generating the index headers.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
# doxygen will generate files with .html extension.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet
HTML_STYLESHEET =
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
# of the generated HTML documentation.
GENERATE_HTMLHELP = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
# written to the html output dir.
CHM_FILE =
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
HHC_LOCATION =
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
# it should be included in the master .chm file (NO).
GENERATE_CHI = NO
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
# normal table of contents (NO) in the .chm file.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members
# to the contents of the HTML help documentation and to the tree view.
TOC_EXPAND = NO
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
DISABLE_INDEX = NO
# This tag can be used to set the number of enum values (range [1..20])
# that doxygen will group on one line in the generated HTML documentation.
ENUM_VALUES_PER_LINE = 4
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
# generated containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# probably better off using the HTML help feature.
GENERATE_TREEVIEW = YES
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
# is shown.
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `latex' will be used as the default path.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
# default command name.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used.
PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
# standard header. Notice: only use this tag if you know what you are doing!
LATEX_HEADER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
PDF_HYPERLINKS = NO
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
USE_PDFLATEX = NO
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.
LATEX_BATCHMODE = NO
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
# in the output.
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimised for Word 97 and may not look very pretty with
# other RTF readers or editors.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `rtf' will be used as the default path.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
# Note: wordpad (write) and others do not support links.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assigments. You only have to provide
# replacements, missing definitions are set to their default value.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an rtf document.
# Syntax is similar to doxygen's config file.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
# generate man pages
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `man' will be used as the default path.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
MAN_EXTENSION = .3
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
# would be unable to find the correct page. The default is NO.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
# moment.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `xml' will be used as the default path.
XML_OUTPUT = xml
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_DTD =
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
# and incomplete at the moment.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
# moment.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
# to generate PDF and DVI output from the Perl module output.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader. This is useful
# if you want to understand what is going on. On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
# and Perl will parse it just the same.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
# Makefile don't overwrite each other's variables.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
# files.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# in the INCLUDE_PATH (see below) will be search if a #include is found.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
# the preprocessor.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
# be used.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse the
# parser if not removed.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::addtions related to external references
#---------------------------------------------------------------------------
# The TAGFILES option can be used to specify one or more tagfiles.
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
# If a tag file is not located in the directory in which doxygen
# is run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
# will be listed.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
# be listed.
EXTERNAL_GROUPS = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
# super classes. Setting the tag to NO turns the diagrams off. Note that this
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
# recommended to install and use dot, since it yields more powerful graphs.
CLASS_DIAGRAMS = YES
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
# or is not a class.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
HAVE_DOT = NO
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similiar to the OMG's Unified Modeling
# Language.
UML_LOOK = NO
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
TEMPLATE_RELATIONS = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
# other documented files.
INCLUDE_GRAPH = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
# generate a call dependency graph for every global function or class method.
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command.
CALL_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
GRAPHICAL_HIERARCHY = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.
DOT_IMAGE_FORMAT = png
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found on the path.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
# \dotfile command).
DOTFILE_DIRS =
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
MAX_DOT_GRAPH_WIDTH = 1024
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
MAX_DOT_GRAPH_HEIGHT = 1024
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes that
# lay further from the root node will be omitted. Note that setting this option to
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
# note that a graph may be further truncated if the graph's image dimensions are
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
MAX_DOT_GRAPH_DEPTH = 0
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
# the various graphs.
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::addtions related to the search engine
#---------------------------------------------------------------------------
# The SEARCHENGINE tag specifies whether or not a search engine should be
# used. If set to NO the values of all tags below this one will be ignored.
SEARCHENGINE = NO
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment