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

Single-stream header information. More...

#include <M3Header.hh>

Public Member Functions

 M3StreamHeader ()
 
 M3StreamHeader (const std::string &aSource, uint32_t aNumber, uint32_t aNChannels, uint32_t aFirstChannel, uint32_t aFormat, uint32_t anAcqRate, uint32_t aRecSize, uint32_t aSampleSize, uint32_t aDataTypeSize, uint32_t aDataFormat, uint32_t aBitDepth, uint32_t aBitAlignment)
 
 M3StreamHeader (const M3StreamHeader &orig)
 
 ~M3StreamHeader ()
 
 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 "stream[aNumber]". More...
 
 camel_case_mv_accessible_mutable (uint32_t, NChannels)
 
 camel_case_mv_referrable_mutable (std::vector< uint32_t >, Channels)
 
 camel_case_mv_accessible_mutable (uint32_t, ChannelFormat)
 
 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 (uint32_t, NAcquisitions)
 
 camel_case_mv_accessible_mutable (uint32_t, NRecords)
 
void WriteToHDF5 (HAS_GRP_IFC *aParent)
 
void ReadFromHDF5 (const HAS_GRP_IFC *aParent, const std::string &aLabel) const
 

Private Member Functions

void WriteChannels (HAS_ATTR_IFC *aLoc)
 
void ReadChannels (const HAS_ATTR_IFC *aLoc) const
 

Detailed Description

Single-stream header information.

Author
N. S. Oblath

Definition at line 33 of file M3Header.hh.

Constructor & Destructor Documentation

◆ M3StreamHeader() [1/3]

Definition at line 34 of file M3Header.cc.

◆ M3StreamHeader() [2/3]

M3StreamHeader ( const std::string &  aSource,
uint32_t  aNumber,
uint32_t  aNChannels,
uint32_t  aFirstChannel,
uint32_t  aFormat,
uint32_t  anAcqRate,
uint32_t  aRecSize,
uint32_t  aSampleSize,
uint32_t  aDataTypeSize,
uint32_t  aDataFormat,
uint32_t  aBitDepth,
uint32_t  aBitAlignment 
)

Definition at line 53 of file M3Header.cc.

◆ M3StreamHeader() [3/3]

M3StreamHeader ( const M3StreamHeader orig)

Definition at line 80 of file M3Header.cc.

◆ ~M3StreamHeader()

Definition at line 100 of file M3Header.cc.

Member Function Documentation

◆ camel_case_mv_accessible_mutable() [1/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
NChannels   
)

◆ camel_case_mv_accessible_mutable() [2/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
ChannelFormat   
)

◆ camel_case_mv_accessible_mutable() [3/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
AcquisitionRate   
)

◆ camel_case_mv_accessible_mutable() [4/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
RecordSize   
)

◆ camel_case_mv_accessible_mutable() [5/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
SampleSize   
)

◆ camel_case_mv_accessible_mutable() [6/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
DataTypeSize   
)

◆ camel_case_mv_accessible_mutable() [7/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
DataFormat   
)

◆ camel_case_mv_accessible_mutable() [8/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
BitDepth   
)

◆ camel_case_mv_accessible_mutable() [9/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
BitAlignment   
)

◆ camel_case_mv_accessible_mutable() [10/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
NAcquisitions   
)

◆ camel_case_mv_accessible_mutable() [11/11]

camel_case_mv_accessible_mutable ( uint32_t  ,
NRecords   
)

◆ 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() [1/2]

camel_case_mv_referrable_mutable ( std::string  ,
Source   
)

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

◆ camel_case_mv_referrable_mutable() [2/2]

camel_case_mv_referrable_mutable ( std::vector< uint32_t >  ,
Channels   
)

◆ ReadChannels()

void ReadChannels ( const HAS_ATTR_IFC *  aLoc) const
private

Definition at line 189 of file M3Header.cc.

◆ ReadFromHDF5()

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

Definition at line 142 of file M3Header.cc.

◆ SetNumber()

void SetNumber ( uint32_t  aNumber) const

Definition at line 105 of file M3Header.cc.

◆ WriteChannels()

void WriteChannels ( HAS_ATTR_IFC *  aLoc)
private

Definition at line 166 of file M3Header.cc.

◆ WriteToHDF5()

void WriteToHDF5 ( HAS_GRP_IFC *  aParent)

Definition at line 118 of file M3Header.cc.


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