Monarch  v3.8.2
Project 8 Data File Format Library
Public Member Functions | List of all members
M3ChannelHeader Class Reference

Single-channel header information. More...

#include <M3Header.hh>

Public Member Functions

 M3ChannelHeader ()
 
 M3ChannelHeader (const std::string &aSource, uint32_t aNumber, uint32_t anAcqRate, uint32_t aRecSize, uint32_t aSampleSize, uint32_t aDataTypeSize, uint32_t aDataFormat, uint32_t aBitDepth, uint32_t aBitAlignment)
 
 M3ChannelHeader (const M3ChannelHeader &orig)
 
 ~M3ChannelHeader ()
 
 camel_case_mv_assignable_mutable (char, Label)
 
 camel_case_mv_accessible_mutable_noset (uint32_t, Number)
 
void SetNumber (uint32_t aNumber) const
 
 camel_case_mv_referrable_mutable (std::string, Source)
 In addition to setting the number, sets the label to "channel[aNumber]". More...
 
 camel_case_mv_accessible_mutable (uint32_t, AcquisitionRate)
 
 camel_case_mv_accessible_mutable (uint32_t, RecordSize)
 
 camel_case_mv_accessible_mutable (uint32_t, SampleSize)
 
 camel_case_mv_accessible_mutable (uint32_t, DataTypeSize)
 
 camel_case_mv_accessible_mutable (uint32_t, DataFormat)
 
 camel_case_mv_accessible_mutable (uint32_t, BitDepth)
 
 camel_case_mv_accessible_mutable (uint32_t, BitAlignment)
 
 camel_case_mv_accessible_mutable (double, VoltageOffset)
 
 camel_case_mv_accessible_mutable (double, VoltageRange)
 
 camel_case_mv_accessible_mutable (double, DACGain)
 
 camel_case_mv_accessible_mutable (double, FrequencyMin)
 
 camel_case_mv_accessible_mutable (double, FrequencyRange)
 
void WriteToHDF5 (HAS_GRP_IFC *aParent)
 
void ReadFromHDF5 (const HAS_GRP_IFC *aParent, const std::string &aLabel) const
 

Detailed Description

Single-channel header information.

Author
N. S. Oblath

Definition at line 92 of file M3Header.hh.

Constructor & Destructor Documentation

◆ M3ChannelHeader() [1/3]

Definition at line 226 of file M3Header.cc.

◆ M3ChannelHeader() [2/3]

M3ChannelHeader ( const std::string &  aSource,
uint32_t  aNumber,
uint32_t  anAcqRate,
uint32_t  aRecSize,
uint32_t  aSampleSize,
uint32_t  aDataTypeSize,
uint32_t  aDataFormat,
uint32_t  aBitDepth,
uint32_t  aBitAlignment 
)

Definition at line 245 of file M3Header.cc.

◆ M3ChannelHeader() [3/3]

M3ChannelHeader ( const M3ChannelHeader orig)

Definition at line 268 of file M3Header.cc.

◆ ~M3ChannelHeader()

Definition at line 288 of file M3Header.cc.

Member Function Documentation

◆ camel_case_mv_accessible_mutable() [1/12]

camel_case_mv_accessible_mutable ( uint32_t  ,
AcquisitionRate   
)

◆ camel_case_mv_accessible_mutable() [2/12]

camel_case_mv_accessible_mutable ( uint32_t  ,
RecordSize   
)

◆ camel_case_mv_accessible_mutable() [3/12]

camel_case_mv_accessible_mutable ( uint32_t  ,
SampleSize   
)

◆ camel_case_mv_accessible_mutable() [4/12]

camel_case_mv_accessible_mutable ( uint32_t  ,
DataTypeSize   
)

◆ camel_case_mv_accessible_mutable() [5/12]

camel_case_mv_accessible_mutable ( uint32_t  ,
DataFormat   
)

◆ camel_case_mv_accessible_mutable() [6/12]

camel_case_mv_accessible_mutable ( uint32_t  ,
BitDepth   
)

◆ camel_case_mv_accessible_mutable() [7/12]

camel_case_mv_accessible_mutable ( uint32_t  ,
BitAlignment   
)

◆ camel_case_mv_accessible_mutable() [8/12]

camel_case_mv_accessible_mutable ( double  ,
VoltageOffset   
)

◆ camel_case_mv_accessible_mutable() [9/12]

camel_case_mv_accessible_mutable ( double  ,
VoltageRange   
)

◆ camel_case_mv_accessible_mutable() [10/12]

camel_case_mv_accessible_mutable ( double  ,
DACGain   
)

◆ camel_case_mv_accessible_mutable() [11/12]

camel_case_mv_accessible_mutable ( double  ,
FrequencyMin   
)

◆ camel_case_mv_accessible_mutable() [12/12]

camel_case_mv_accessible_mutable ( double  ,
FrequencyRange   
)

◆ camel_case_mv_accessible_mutable_noset()

camel_case_mv_accessible_mutable_noset ( uint32_t  ,
Number   
)

◆ camel_case_mv_assignable_mutable()

camel_case_mv_assignable_mutable ( char  ,
Label   
)

◆ camel_case_mv_referrable_mutable()

camel_case_mv_referrable_mutable ( std::string  ,
Source   
)

In addition to setting the number, sets the label to "channel[aNumber]".

◆ ReadFromHDF5()

void ReadFromHDF5 ( const HAS_GRP_IFC *  aParent,
const std::string &  aLabel 
) const

Definition at line 329 of file M3Header.cc.

◆ SetNumber()

void SetNumber ( uint32_t  aNumber) const

Definition at line 293 of file M3Header.cc.

◆ WriteToHDF5()

void WriteToHDF5 ( HAS_GRP_IFC *  aParent)

Definition at line 306 of file M3Header.cc.


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