ldas-tools-framecpp
2.6.4
|
Non-PTR_STRUCT elements of the FrameH structure. More...
#include <FrameH.hh>
Classes | |
struct | data_type |
Public Types | |
typedef FRAME_H_NAME_TYPE | name_type |
typedef FRAME_H_RUN_TYPE | run_type |
typedef FRAME_H_FRAME_TYPE | frame_type |
typedef FRAME_H_DATA_QUALITY_TYPE | dataQuality_type |
typedef FRAME_H_G_TIME_S_TYPE | GTimeS_type |
typedef FRAME_H_G_TIME_N_TYPE | GTimeN_type |
typedef FRAME_H_G_TIME_TYPE | GTime_type |
typedef FRAME_H_U_LEAP_S_TYPE | ULeapS_type |
typedef FRAME_H_LOCAL_TIME_TYPE | localTime_type |
typedef FRAME_H_DT_TYPE | dt_type |
enum | { DT_CHAR_PTR, DT_STRING_2, DT_INT_2S, DT_INT_2U, DT_INT_4S, DT_INT_4U, DT_INT_8S, DT_INT_8U, DT_REAL_4, DT_REAL_8 } |
enum | { IC_EOQ, IC_AMPLITUDE, IC_CHANNEL_ID, IC_DATA_QUALITY, IC_DATA_VALID, IC_DETECTOR, IC_DETECTOR_PREFIX, IC_DT, IC_END, IC_FRAME, IC_GROUP_ID, IC_GTIME_N, IC_GTIME_S, IC_ID, IC_LOCAL_TIME, IC_NAME, IC_RUN, IC_START, IC_ULEAP_S, IC_VERSION } |
typedef STRING< INT_2U > | string_2_type |
Public Member Functions | |
FrameHNPS () | |
Default constructor. More... | |
FrameHNPS (const FrameHNPS &Source) | |
Copy Constructor. More... | |
FrameHNPS (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual) | |
Constructor. More... | |
const std::string & | GetName () const |
Retrieve name of project. More... | |
run_type | GetRun () const |
Run number. More... | |
frame_type | GetFrame () const |
Frame number. More... | |
dataQuality_type | GetDataQuality () const |
Data quality flag. More... | |
const GPSTime & | GetGTime () const |
Start Time. More... | |
ULeapS_type | GetULeapS () const |
Leap seconds. More... | |
dt_type | GetDt () const |
Frame length. More... | |
void | SetName (const std::string &Name) |
Establish the name. More... | |
void | SetRun (run_type Run) |
Establish the run number. More... | |
void | SetDataQuality (dataQuality_type DataQuality) |
Establish the data quality flag. More... | |
void | SetDt (dt_type Dt) |
Establish the frame duration. More... | |
void | SetGTime (const GPSTime >ime) |
Establish the start time. More... | |
void | SetULeapS (ULeapS_type Value) |
Establish leap second offset. More... | |
void | TOCQuery (int InfoClass,...) const |
Static Public Member Functions | |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
Protected Types | |
typedef Common::IStringStream | assign_stream_type |
Protected Member Functions | |
FrameHNPS (const Previous::FrameHNPS &Source) | |
Copy Constructor based on a previous frame specification. More... | |
void | assign (assign_stream_type &Stream) |
Hook to provide table of contents information. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Static Protected Member Functions | |
template<typename SE > | |
static void | dataDescription (Common::Description &Desc) |
The description of structure. More... | |
Protected Attributes | |
data_type | m_data |
Non-PTR_STRUCT elements of the FrameH structure.
This class contains the data members of the FrameH structure that are not refernced by a pointer. This allows for easier migration into future frame specifications.
|
protected |
|
inherited |
|
inherited |
|
inherited |
FrameHNPS::FrameHNPS | ( | ) |
FrameHNPS::FrameHNPS | ( | const FrameHNPS & | Source | ) |
FrameHNPS::FrameHNPS | ( | const std::string & | name, |
INT_4S | run, | ||
INT_4U | frame, | ||
const GPSTime & | time, | ||
INT_2U | uLeapS, | ||
const REAL_8 | dt, | ||
INT_4U | dqual | ||
) |
Constructor.
Construct a new FrameHNPS object with explicate values.
[in] | name | Name of project or other experiment description. |
[in] | run | Run number (number < 0 reserved fro simulated data); monotonic for experimental runs. |
[in] | frame | Frame number, monotonically increasing until end of run, re-starting from 0 with each new run. |
[in] | time | Frame start time. |
[in] | uLeapS | The integer number of leap seconds between GPS/TAI and UTC in epoch when the frame is written |
[in] | dt | Frame length in seconds. |
[in] | dqual | A logical 32-bit word to denote top level quality of data. Lowest order bits are reserved in pairs for the various GW detectors. |
|
inlineprotected |
|
inlineprotected |
Hook to provide table of contents information.
Assign the contents of the instance
[in] | Stream | An input stream from which to read information for the instance. |
|
inlinestaticprotected |
The description of structure.
[out] | Desc | Storage for the description of the structure. |
Append descriptions of the fields managed by this object to the user supplied Description object.
|
staticinherited |
|
staticinherited |
|
inline |
Data quality flag.
Retrieve the data quality flag associated with the frame.
|
inline |
Frame length.
Retrieve the duration of the frame in seconds.
|
inline |
Frame number.
Retrieve the frame number associated with the frame.
|
inline |
Start Time.
Retrieve the start time of the frame.
|
inline |
Retrieve name of project.
Retrieve the name of project or other experiment description.
|
inline |
Run number.
Retrieve the run number associated with the frame.
|
inline |
Leap seconds.
Retrieve the number of leap seconds associated with the frame.
|
inline |
Establish the data quality flag.
Set the data quality flag of the frame.
[in] | DataQuality | The value of the data quality flag. |
|
inline |
Establish the frame duration.
Set the length of the frame in seconds.
[in] | Dt | The length of the frame in seconds |
|
inline |
Establish the start time.
Set the start time of the frame.
[in] | GTime | The start time of the frame. |
|
inline |
Establish the name.
[in] | Name | The name to associate with the frame |
Set the project name of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.
|
inline |
Establish the run number.
[in] | Run | The run number to associate with the frame. |
Set the run number of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.
|
inline |
Establish leap second offset.
Set the number of leap seconds since GPS epoc.
[in] | Value | Number of leap seconds since GPS epoc. |
|
inlineinherited |
|
protectedvirtual |
Implements FrameCPP::Common::TOCInfo.
|
protected |