Class Index Cross Index Namespace Index

Class FrameCPP::Version_6::FrAdcData


Contained in: FrameCPP::Version_6
Derived from: FrameCPP::Version_6::FrBase
Derived by: none

#include "../../../../../lib/framecpp/src/Version6/FrAdcData.hh"


public function member index:

FrAdcData(); Default constructor
FrAdcData(const FrAdcData& Source);
FrAdcData(const std::string& name, INT_4U group, INT_4U channel, INT_4U nBits, REAL_8 sampleRate, REAL_4 bias = FR_ADC_DATA_DEFAULT_BIAS, REAL_4 slope = FR_ADC_DATA_DEFAULT_SLOPE, const std::string& units = FR_ADC_DATA_DEFAULT_UNITS( ), REAL_8 fShift = FR_ADC_DATA_DEFAULT_FSHIFT, REAL_8 timeOffset = FR_ADC_DATA_DEFAULT_TIME_OFFSET, INT_2U dataValid = FR_ADC_DATA_DEFAULT_DATA_VALID, REAL_4 phase = FR_ADC_DATA_DEFAULT_PHASE);
FrAdcData(const std::string& name, INT_4U group, INT_4U channel, INT_4U nBits, const REAL_8& sampleRate, REAL_4 bias = 0.0, REAL_4 slope = 1.0, const std::string& units = "counts", const REAL_8& fShift = 0.0, const GPSTime& timeOffset = GPSTime( 0, 0 ), INT_2U dataValid = 0, const REAL_4& phase = 0.0);
~FrAdcData();
void AppendComment(const std::string& comment);
INT_8U Bytes() const; Number of bytes needed to write this structure
REAL_4 GetBias() const;
INT_4U GetChannelGroup() const;
INT_4U GetChannelNumber() const;
const std::string& GetComment() const;
INT_2U GetDataValid() const;
REAL_8 GetFShift() const;
INT_4U GetNBits() const;
const std::string& GetName() const;
REAL_4 GetPhase() const;
REAL_8 GetSampleRate() const;
REAL_4 GetSlope() const;
REAL_8 GetTimeOffset() const;
STRING GetUnits() const;
FrAdcData& Merge(const FrAdcData& RHS); Merge with another FrAdcData
static FrAdcData* ReadDynamic(IFrameStream& Stream, const FrBase& Base); Read the structure from stream
const aux_type& RefAux() const;
aux_type& RefAux();
const data_type& RefData() const;
data_type& RefData();
void SetBias(REAL_4 bias);
void SetDataValid(INT_2U flag);
void SetSlope(REAL_4 slope);
void SetTimeOffset(REAL_8 time);
std::auto_ptr< FrAdcData > SubFrAdcData(REAL_8 Offset, REAL_8 Dt) const;
virtual void Write(OFrameStream& Stream) const; Write the structure to the stream
virtual void WriteDescription(OFrameStream& Stream) const; Write the structure description to the stream
void appendComment(const std::string& comment);
REAL_4 getBias() const;
INT_4U getChannelGroup() const;
INT_4U getChannelNumber() const;
const std::string& getComment() const;
INT_2U getDataValid() const;
REAL_8 getFShift() const;
INT_4U getNBits() const;
const std::string& getName() const;
REAL_4 getPhase() const;
REAL_8 getSampleRate() const;
REAL_4 getSlope() const;
static const char* getStaticName();
const GPSTime& getTimeOffset() const;
STRING getUnits() const;
bool operator !=(const FrAdcData& RHS) const;
bool operator ==(const FrAdcData& RHS) const; Comparison operator
const FrAdcData::AuxContainer& refAux() const;
FrAdcData::AuxContainer& refAux();
const FrAdcData::DataContainer& refData() const;
FrAdcData::DataContainer& refData();
void setBias(REAL_4 bias);
void setDataValid(INT_2U flag);
void setSlope(REAL_4 slope);
void setTimeOffset(const GPSTime& time);
 

private function member index:

void read(IFrameStream& Stream);
 

Description:



Function Member Descriptions:


FrameCPP::Version_6::FrAdcData::FrAdcData - Default constructor


FrAdcData();



FrameCPP::Version_6::FrAdcData::FrAdcData


FrAdcData(const FrAdcData& Source);



FrameCPP::Version_6::FrAdcData::FrAdcData


FrAdcData(const std::string& name, INT_4U group, INT_4U channel, INT_4U nBits, REAL_8 sampleRate, REAL_4 bias = FR_ADC_DATA_DEFAULT_BIAS, REAL_4 slope = FR_ADC_DATA_DEFAULT_SLOPE, const std::string& units = FR_ADC_DATA_DEFAULT_UNITS( ), REAL_8 fShift = FR_ADC_DATA_DEFAULT_FSHIFT, REAL_8 timeOffset = FR_ADC_DATA_DEFAULT_TIME_OFFSET, INT_2U dataValid = FR_ADC_DATA_DEFAULT_DATA_VALID, REAL_4 phase = FR_ADC_DATA_DEFAULT_PHASE);



FrameCPP::Version_6::FrAdcData::FrAdcData


FrAdcData(const std::string& name, INT_4U group, INT_4U channel, INT_4U nBits, const REAL_8& sampleRate, REAL_4 bias = 0.0, REAL_4 slope = 1.0, const std::string& units = "counts", const REAL_8& fShift = 0.0, const GPSTime& timeOffset = GPSTime( 0, 0 ), INT_2U dataValid = 0, const REAL_4& phase = 0.0);



FrameCPP::Version_6::FrAdcData::~FrAdcData


~FrAdcData();



FrameCPP::Version_6::FrAdcData::AppendComment


void AppendComment(const std::string& comment);
Mutators




FrameCPP::Version_6::FrAdcData::Bytes - Number of bytes needed to write this structure


INT_8U Bytes() const;



FrameCPP::Version_6::FrAdcData::GetBias


REAL_4 GetBias() const;



FrameCPP::Version_6::FrAdcData::GetChannelGroup


INT_4U GetChannelGroup() const;



FrameCPP::Version_6::FrAdcData::GetChannelNumber


INT_4U GetChannelNumber() const;



FrameCPP::Version_6::FrAdcData::GetComment


const std::string& GetComment() const;



FrameCPP::Version_6::FrAdcData::GetDataValid


INT_2U GetDataValid() const;



FrameCPP::Version_6::FrAdcData::GetFShift


REAL_8 GetFShift() const;



FrameCPP::Version_6::FrAdcData::GetNBits


INT_4U GetNBits() const;



FrameCPP::Version_6::FrAdcData::GetName


const std::string& GetName() const;
Accessors




FrameCPP::Version_6::FrAdcData::GetPhase


REAL_4 GetPhase() const;



FrameCPP::Version_6::FrAdcData::GetSampleRate


REAL_8 GetSampleRate() const;



FrameCPP::Version_6::FrAdcData::GetSlope


REAL_4 GetSlope() const;



FrameCPP::Version_6::FrAdcData::GetTimeOffset


REAL_8 GetTimeOffset() const;



FrameCPP::Version_6::FrAdcData::GetUnits


STRING GetUnits() const;



FrameCPP::Version_6::FrAdcData::Merge - Merge with another FrAdcData


FrAdcData& Merge(const FrAdcData& RHS);



FrameCPP::Version_6::FrAdcData::ReadDynamic - Read the structure from stream


static FrAdcData* ReadDynamic(IFrameStream& Stream, const FrBase& Base);



FrameCPP::Version_6::FrAdcData::RefAux


const aux_type& RefAux() const;



FrameCPP::Version_6::FrAdcData::RefAux


aux_type& RefAux();



FrameCPP::Version_6::FrAdcData::RefData


const data_type& RefData() const;



FrameCPP::Version_6::FrAdcData::RefData


data_type& RefData();



FrameCPP::Version_6::FrAdcData::SetBias


void SetBias(REAL_4 bias);



FrameCPP::Version_6::FrAdcData::SetDataValid


void SetDataValid(INT_2U flag);



FrameCPP::Version_6::FrAdcData::SetSlope


void SetSlope(REAL_4 slope);



FrameCPP::Version_6::FrAdcData::SetTimeOffset


void SetTimeOffset(REAL_8 time);



FrameCPP::Version_6::FrAdcData::SubFrAdcData


std::auto_ptr< FrAdcData > SubFrAdcData(REAL_8 Offset, REAL_8 Dt) const;



FrameCPP::Version_6::FrAdcData::Write - Write the structure to the stream


virtual void Write(OFrameStream& Stream) const;



FrameCPP::Version_6::FrAdcData::WriteDescription - Write the structure description to the stream


virtual void WriteDescription(OFrameStream& Stream) const;



FrameCPP::Version_6::FrAdcData::appendComment


void appendComment(const std::string& comment);



FrameCPP::Version_6::FrAdcData::getBias


REAL_4 getBias() const;



FrameCPP::Version_6::FrAdcData::getChannelGroup


INT_4U getChannelGroup() const;



FrameCPP::Version_6::FrAdcData::getChannelNumber


INT_4U getChannelNumber() const;



FrameCPP::Version_6::FrAdcData::getComment


const std::string& getComment() const;



FrameCPP::Version_6::FrAdcData::getDataValid


INT_2U getDataValid() const;



FrameCPP::Version_6::FrAdcData::getFShift


REAL_8 getFShift() const;



FrameCPP::Version_6::FrAdcData::getNBits


INT_4U getNBits() const;



FrameCPP::Version_6::FrAdcData::getName


const std::string& getName() const;



FrameCPP::Version_6::FrAdcData::getPhase


REAL_4 getPhase() const;



FrameCPP::Version_6::FrAdcData::getSampleRate


REAL_8 getSampleRate() const;



FrameCPP::Version_6::FrAdcData::getSlope


REAL_4 getSlope() const;



FrameCPP::Version_6::FrAdcData::getStaticName


static const char* getStaticName();



FrameCPP::Version_6::FrAdcData::getTimeOffset


const GPSTime& getTimeOffset() const;



FrameCPP::Version_6::FrAdcData::getUnits


STRING getUnits() const;



FrameCPP::Version_6::FrAdcData::operator !=


bool operator !=(const FrAdcData& RHS) const;



FrameCPP::Version_6::FrAdcData::operator == - Comparison operator


bool operator ==(const FrAdcData& RHS) const;



FrameCPP::Version_6::FrAdcData::read


void read(IFrameStream& Stream);



FrameCPP::Version_6::FrAdcData::refAux


const FrAdcData::AuxContainer& refAux() const;



FrameCPP::Version_6::FrAdcData::refAux


FrAdcData::AuxContainer& refAux();



FrameCPP::Version_6::FrAdcData::refData


const FrAdcData::DataContainer& refData() const;



FrameCPP::Version_6::FrAdcData::refData


FrAdcData::DataContainer& refData();



FrameCPP::Version_6::FrAdcData::setBias


void setBias(REAL_4 bias);



FrameCPP::Version_6::FrAdcData::setDataValid


void setDataValid(INT_2U flag);



FrameCPP::Version_6::FrAdcData::setSlope


void setSlope(REAL_4 slope);



FrameCPP::Version_6::FrAdcData::setTimeOffset


void setTimeOffset(const GPSTime& time);



Variable Member Descriptions:


FrameCPP::Version_6::FrAdcData::offsetVersion5 -

mutable GPSTime offsetVersion5;