Class Index Cross Index Namespace Index

Class FrameCPP::Version_6::FrameH


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

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


public function member index:

FrameH(); Default constructor
FrameH(const FrameH& frame, detector_copy_type Copy = SHALLOW_COPY_DETECTORS);
FrameH(const std::string& name, INT_4S run, INT_4U frame, const GPSTime& time, INT_2U uLeapS, const REAL_8& dt, INT_4U dqual = 0);
~FrameH();
INT_8U Bytes() const; Number of bytes needed to write this structure
INT_4U GetDataQuality() const;
REAL_8 GetDt() const;
INT_4U GetFrame() const;
const GPSTime& GetGTime() const;
const std::string& GetName() const;
const FrRawData* GetRawData() const;
FrRawData* GetRawData();
INT_4S GetRun() const;
INT_2U GetULeapS() const;
static FrameH* ReadDynamic(IFrameStream& Stream, const FrBase& Base); Read the structure from stream
void ReadSubset(IFrameStream& Stream, INT_4U ContainerSet);
const auxData_type& RefAuxData() const;
auxData_type& RefAuxData();
const auxTable_type& RefAuxTable() const;
auxTable_type& RefAuxTable();
const detectProc_type& RefDetectProc() const;
detectProc_type& RefDetectProc();
const detectSim_type& RefDetectSim() const;
detectSim_type& RefDetectSim();
const event_type& RefEvent() const;
event_type& RefEvent();
const history_type& RefHistory() const;
history_type& RefHistory();
const procData_type& RefProcData() const;
procData_type& RefProcData();
const simData_type& RefSimData() const;
simData_type& RefSimData();
const simEvent_type& RefSimEvent() const;
simEvent_type& RefSimEvent();
const summaryData_type& RefSummaryData() const;
summaryData_type& RefSummaryData();
const type_type& RefType() const;
type_type& RefType();
const user_type& RefUser() const;
user_type& RefUser();
void SetDataQuality(INT_4U DataQuality);
void SetDt(REAL_8 Dt);
void SetGTime(const GPSTime& GTime);
void SetRawData(const FrRawData& r);
void SetRawData(const FrRawData* r);
void SetRawData(FrRawData* r, bool allocate, bool owns);
void SetRun(INT_4S Run);
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
INT_4U getDataQuality() const;
REAL_8 getDt() const;
INT_4U getFrame() const;
const GPSTime& getGTime() const;
const std::string& getName() const;
FrRawData* getRawData();
const FrRawData* getRawData() const;
INT_4S getRun() const;
static const CHAR* getStaticName();
INT_2U getULeapS() const;
AuxContainer& refAux();
const AuxContainer& refAux() const;
DetectorProcContainer& refDetectorProc();
const DetectorProcContainer& refDetectorProc() const;
DetectorSimContainer& refDetectorSim();
const DetectorSimContainer& refDetectorSim() const;
EventContainer& refEvent();
const EventContainer& refEvent() const;
HistoryContainer& refHistory();
const HistoryContainer& refHistory() const;
ProcDataContainer& refProcData();
const ProcDataContainer& refProcData() const;
SimDataContainer& refSimData();
const SimDataContainer& refSimData() const;
SimEventContainer& refSimEvent();
const SimEventContainer& refSimEvent() const;
SummaryContainer& refSummary();
const SummaryContainer& refSummary() const;
TableContainer& refTable();
const TableContainer& refTable() const;
TypeContainer& refType();
const TypeContainer& refType() const;
UserContainer& refUser();
const UserContainer& refUser() const;
void setDt(REAL_8 Dt);
void setRawData(const FrRawData& r);
void setRawData(const FrRawData* r);
void setRawData(FrRawData* r, bool allocate = true , bool owns = true);
 

private function member index:

void read(IFrameStream& Stream);
 

Description:



Function Member Descriptions:


FrameCPP::Version_6::FrameH::FrameH - Default constructor


FrameH();



FrameCPP::Version_6::FrameH::FrameH


FrameH(const FrameH& frame, detector_copy_type Copy = SHALLOW_COPY_DETECTORS);



FrameCPP::Version_6::FrameH::FrameH


FrameH(const std::string& name, INT_4S run, INT_4U frame, const GPSTime& time, INT_2U uLeapS, const REAL_8& dt, INT_4U dqual = 0);



FrameCPP::Version_6::FrameH::~FrameH


~FrameH();



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


INT_8U Bytes() const;



FrameCPP::Version_6::FrameH::GetDataQuality


INT_4U GetDataQuality() const;



FrameCPP::Version_6::FrameH::GetDt


REAL_8 GetDt() const;



FrameCPP::Version_6::FrameH::GetFrame


INT_4U GetFrame() const;



FrameCPP::Version_6::FrameH::GetGTime


const GPSTime& GetGTime() const;



FrameCPP::Version_6::FrameH::GetName


const std::string& GetName() const;



FrameCPP::Version_6::FrameH::GetRawData


const FrRawData* GetRawData() const;



FrameCPP::Version_6::FrameH::GetRawData


FrRawData* GetRawData();



FrameCPP::Version_6::FrameH::GetRun


INT_4S GetRun() const;



FrameCPP::Version_6::FrameH::GetULeapS


INT_2U GetULeapS() const;



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


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



FrameCPP::Version_6::FrameH::ReadSubset


void ReadSubset(IFrameStream& Stream, INT_4U ContainerSet);



FrameCPP::Version_6::FrameH::RefAuxData


const auxData_type& RefAuxData() const;



FrameCPP::Version_6::FrameH::RefAuxData


auxData_type& RefAuxData();



FrameCPP::Version_6::FrameH::RefAuxTable


const auxTable_type& RefAuxTable() const;



FrameCPP::Version_6::FrameH::RefAuxTable


auxTable_type& RefAuxTable();



FrameCPP::Version_6::FrameH::RefDetectProc


const detectProc_type& RefDetectProc() const;



FrameCPP::Version_6::FrameH::RefDetectProc


detectProc_type& RefDetectProc();



FrameCPP::Version_6::FrameH::RefDetectSim


const detectSim_type& RefDetectSim() const;



FrameCPP::Version_6::FrameH::RefDetectSim


detectSim_type& RefDetectSim();



FrameCPP::Version_6::FrameH::RefEvent


const event_type& RefEvent() const;



FrameCPP::Version_6::FrameH::RefEvent


event_type& RefEvent();



FrameCPP::Version_6::FrameH::RefHistory


const history_type& RefHistory() const;



FrameCPP::Version_6::FrameH::RefHistory


history_type& RefHistory();



FrameCPP::Version_6::FrameH::RefProcData


const procData_type& RefProcData() const;



FrameCPP::Version_6::FrameH::RefProcData


procData_type& RefProcData();



FrameCPP::Version_6::FrameH::RefSimData


const simData_type& RefSimData() const;



FrameCPP::Version_6::FrameH::RefSimData


simData_type& RefSimData();



FrameCPP::Version_6::FrameH::RefSimEvent


const simEvent_type& RefSimEvent() const;



FrameCPP::Version_6::FrameH::RefSimEvent


simEvent_type& RefSimEvent();



FrameCPP::Version_6::FrameH::RefSummaryData


const summaryData_type& RefSummaryData() const;



FrameCPP::Version_6::FrameH::RefSummaryData


summaryData_type& RefSummaryData();



FrameCPP::Version_6::FrameH::RefType


const type_type& RefType() const;



FrameCPP::Version_6::FrameH::RefType


type_type& RefType();



FrameCPP::Version_6::FrameH::RefUser


const user_type& RefUser() const;



FrameCPP::Version_6::FrameH::RefUser


user_type& RefUser();



FrameCPP::Version_6::FrameH::SetDataQuality


void SetDataQuality(INT_4U DataQuality);



FrameCPP::Version_6::FrameH::SetDt


void SetDt(REAL_8 Dt);



FrameCPP::Version_6::FrameH::SetGTime


void SetGTime(const GPSTime& GTime);



FrameCPP::Version_6::FrameH::SetRawData


void SetRawData(const FrRawData& r);



FrameCPP::Version_6::FrameH::SetRawData


void SetRawData(const FrRawData* r);



FrameCPP::Version_6::FrameH::SetRawData


void SetRawData(FrRawData* r, bool allocate, bool owns);



FrameCPP::Version_6::FrameH::SetRun


void SetRun(INT_4S Run);



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


virtual void Write(OFrameStream& Stream) const;



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


virtual void WriteDescription(OFrameStream& Stream) const;



FrameCPP::Version_6::FrameH::getDataQuality


INT_4U getDataQuality() const;



FrameCPP::Version_6::FrameH::getDt


REAL_8 getDt() const;



FrameCPP::Version_6::FrameH::getFrame


INT_4U getFrame() const;



FrameCPP::Version_6::FrameH::getGTime


const GPSTime& getGTime() const;



FrameCPP::Version_6::FrameH::getName


const std::string& getName() const;



FrameCPP::Version_6::FrameH::getRawData


FrRawData* getRawData();
bool isRawDataOwned() const;




FrameCPP::Version_6::FrameH::getRawData


const FrRawData* getRawData() const;



FrameCPP::Version_6::FrameH::getRun


INT_4S getRun() const;



FrameCPP::Version_6::FrameH::getStaticName


static const CHAR* getStaticName();



FrameCPP::Version_6::FrameH::getULeapS


INT_2U getULeapS() const;



FrameCPP::Version_6::FrameH::read


void read(IFrameStream& Stream);



FrameCPP::Version_6::FrameH::refAux


AuxContainer& refAux();



FrameCPP::Version_6::FrameH::refAux


const AuxContainer& refAux() const;



FrameCPP::Version_6::FrameH::refDetectorProc


DetectorProcContainer& refDetectorProc();



FrameCPP::Version_6::FrameH::refDetectorProc


const DetectorProcContainer& refDetectorProc() const;



FrameCPP::Version_6::FrameH::refDetectorSim


DetectorSimContainer& refDetectorSim();



FrameCPP::Version_6::FrameH::refDetectorSim


const DetectorSimContainer& refDetectorSim() const;



FrameCPP::Version_6::FrameH::refEvent


EventContainer& refEvent();



FrameCPP::Version_6::FrameH::refEvent


const EventContainer& refEvent() const;



FrameCPP::Version_6::FrameH::refHistory


HistoryContainer& refHistory();



FrameCPP::Version_6::FrameH::refHistory


const HistoryContainer& refHistory() const;



FrameCPP::Version_6::FrameH::refProcData


ProcDataContainer& refProcData();



FrameCPP::Version_6::FrameH::refProcData


const ProcDataContainer& refProcData() const;



FrameCPP::Version_6::FrameH::refSimData


SimDataContainer& refSimData();



FrameCPP::Version_6::FrameH::refSimData


const SimDataContainer& refSimData() const;



FrameCPP::Version_6::FrameH::refSimEvent


SimEventContainer& refSimEvent();



FrameCPP::Version_6::FrameH::refSimEvent


const SimEventContainer& refSimEvent() const;



FrameCPP::Version_6::FrameH::refSummary


SummaryContainer& refSummary();



FrameCPP::Version_6::FrameH::refSummary


const SummaryContainer& refSummary() const;



FrameCPP::Version_6::FrameH::refTable


TableContainer& refTable();



FrameCPP::Version_6::FrameH::refTable


const TableContainer& refTable() const;



FrameCPP::Version_6::FrameH::refType


TypeContainer& refType();



FrameCPP::Version_6::FrameH::refType


const TypeContainer& refType() const;



FrameCPP::Version_6::FrameH::refUser


UserContainer& refUser();



FrameCPP::Version_6::FrameH::refUser


const UserContainer& refUser() const;



FrameCPP::Version_6::FrameH::setDt


void setDt(REAL_8 Dt);



FrameCPP::Version_6::FrameH::setRawData


void setRawData(const FrRawData& r);



FrameCPP::Version_6::FrameH::setRawData


void setRawData(const FrRawData* r);



FrameCPP::Version_6::FrameH::setRawData


void setRawData(FrRawData* r, bool allocate = true , bool owns = true);



Variable Member Descriptions:


FrameCPP::Version_6::FrameH::m_owns_raw_data -

bool m_owns_raw_data;