ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_6::FrameHNPS Class Reference

Non-PTR_STRUCT elements of the FrameH structure. More...

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_6::FrameHNPS:
Collaboration diagram for FrameCPP::Version_6::FrameHNPS:

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
 
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
}
 
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
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrameHNPS ()
 Default constructor.
 
 FrameHNPS (const FrameHNPS &Source)
 Copy Constructor.
 
 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.
 
const std::string & GetName () const
 Retrieve name of project.
 
run_type GetRun () const
 Run number.
 
frame_type GetFrame () const
 Frame number.
 
dataQuality_type GetDataQuality () const
 Data quality flag.
 
const GPSTimeGetGTime () const
 Start Time.
 
ULeapS_type GetULeapS () const
 Leap seconds.
 
dt_type GetDt () const
 Frame length.
 
void SetName (const std::string &Name)
 Establish the name.
 
void SetRun (run_type Run)
 Establish the run number.
 
void SetDataQuality (dataQuality_type DataQuality)
 Establish the data quality flag.
 
void SetDt (dt_type Dt)
 Establish the frame duration.
 
void SetGTime (const GPSTime &GTime)
 Establish the start time.
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
 
 FrameHNPS ()
 Default constructor.
 
 FrameHNPS (const FrameHNPS &Source)
 Copy Constructor.
 
 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.
 
const std::string & GetName () const
 Retrieve name of project.
 
run_type GetRun () const
 Run number.
 
frame_type GetFrame () const
 Frame number.
 
dataQuality_type GetDataQuality () const
 Data quality flag.
 
const GPSTimeGetGTime () const
 Start Time.
 
ULeapS_type GetULeapS () const
 Leap seconds.
 
dt_type GetDt () const
 Frame length.
 
void SetName (const std::string &Name)
 Establish the name.
 
void SetRun (run_type Run)
 Establish the run number.
 
void SetDataQuality (dataQuality_type DataQuality)
 Establish the data quality flag.
 
void SetDt (dt_type Dt)
 Establish the frame duration.
 
void SetGTime (const GPSTime &GTime)
 Establish the start time.
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
 
void TOCQuery (int InfoClass,...) const
 
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)
 
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
 
typedef Common::IStringStream assign_stream_type
 

Protected Member Functions

 FrameHNPS (const Previous::FrameHNPS &Source)
 Copy Constructor based on a previous frame specification.
 
void assign (assign_stream_type &Stream)
 Hook to provide table of contents information.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
 FrameHNPS (const Previous::FrameHNPS &Source)
 Copy Constructor based on a previous frame specification.
 
void assign (assign_stream_type &Stream)
 Hook to provide table of contents information.
 
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.
 
template<typename SE>
static void dataDescription (Common::Description &Desc)
 The description of structure.
 

Protected Attributes

data_type m_data
 

Detailed Description

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.

Member Typedef Documentation

◆ assign_stream_type [1/2]

◆ assign_stream_type [2/2]

◆ dataQuality_type [1/2]

◆ dataQuality_type [2/2]

◆ dt_type [1/2]

◆ dt_type [2/2]

◆ frame_type [1/2]

◆ frame_type [2/2]

◆ GTime_type [1/2]

◆ GTime_type [2/2]

◆ GTimeN_type [1/2]

◆ GTimeN_type [2/2]

◆ GTimeS_type [1/2]

◆ GTimeS_type [2/2]

◆ localTime_type [1/2]

◆ localTime_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ run_type [1/2]

◆ run_type [2/2]

◆ string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ ULeapS_type [1/2]

◆ ULeapS_type [2/2]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
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 

◆ anonymous enum

anonymous enum
inherited
Enumerator
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 

◆ anonymous enum

anonymous enum
inherited
Enumerator
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 

◆ anonymous enum

anonymous enum
inherited
Enumerator
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 

Constructor & Destructor Documentation

◆ FrameHNPS() [1/8]

FrameHNPS::FrameHNPS ( )

Default constructor.

Construct a new FrameHNPS object with default values

Returns
A new FrameHNPS object.

◆ FrameHNPS() [2/8]

FrameHNPS::FrameHNPS ( const FrameHNPS & Source)

Copy Constructor.

Construct a new FrameHNPS object based on Source.

Parameters
[in]SourceInstance to use to populate this instance.
Returns
A new FrameHNPS object.

◆ FrameHNPS() [3/8]

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.

Parameters
[in]nameName of project or other experiment description.
[in]runRun number (number < 0 reserved fro simulated data); monotonic for experimental runs.
[in]frameFrame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]timeFrame start time.
[in]uLeapSThe integer number of leap seconds between GPS/TAI and UTC in epoch when the frame is written
[in]dtFrame length in seconds.
[in]dqualA logical 32-bit word to denote top level quality of data. Lowest order bits are reserved in pairs for the various GW detectors.
Returns
A new FrameHNPS object.

◆ FrameHNPS() [4/8]

FrameHNPS::FrameHNPS ( const Previous::FrameHNPS & Source)
inlineprotected

Copy Constructor based on a previous frame specification.

Parameters
[in]SourceA FrmaeHNPS object of a previous frame specification.
Returns
A new FrameHNPS object

Construct a new FrameHNPS object using values from a previous frame specification.

◆ FrameHNPS() [5/8]

FrameCPP::Version_6::FrameHNPS::FrameHNPS ( )

Default constructor.

Construct a new FrameHNPS object with default values

Returns
A new FrameHNPS object.

◆ FrameHNPS() [6/8]

FrameCPP::Version_6::FrameHNPS::FrameHNPS ( const FrameHNPS & Source)

Copy Constructor.

Construct a new FrameHNPS object based on Source.

Parameters
[in]SourceInstance to use to populate this instance.
Returns
A new FrameHNPS object.

◆ FrameHNPS() [7/8]

FrameCPP::Version_6::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.

Parameters
[in]nameName of project or other experiment description.
[in]runRun number (number < 0 reserved fro simulated data); monotonic for experimental runs.
[in]frameFrame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]timeFrame start time.
[in]uLeapSThe integer number of leap seconds between GPS/TAI and UTC in epoch when the frame is written
[in]dtFrame length in seconds.
[in]dqualA logical 32-bit word to denote top level quality of data. Lowest order bits are reserved in pairs for the various GW detectors.
Returns
A new FrameHNPS object.

◆ FrameHNPS() [8/8]

FrameCPP::Version_6::FrameHNPS::FrameHNPS ( const Previous::FrameHNPS & Source)
protected

Copy Constructor based on a previous frame specification.

Parameters
[in]SourceA FrmaeHNPS object of a previous frame specification.
Returns
A new FrameHNPS object

Member Function Documentation

◆ assign() [1/2]

void FrameHNPS::assign ( assign_stream_type & Stream)
inlineprotected

Hook to provide table of contents information.

Assign the contents of the instance

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ assign() [2/2]

void FrameCPP::Version_6::FrameHNPS::assign ( assign_stream_type & Stream)
protected

Hook to provide table of contents information.

Assign the contents of the instance

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ dataDescription() [1/2]

template<typename SE>
void FrameHNPS::dataDescription ( Common::Description & Desc)
inlinestaticprotected

The description of structure.

Parameters
[out]DescStorage for the description of the structure.

Append descriptions of the fields managed by this object to the user supplied Description object.

◆ dataDescription() [2/2]

template<typename SE>
static void FrameCPP::Version_6::FrameHNPS::dataDescription ( Common::Description & Desc)
staticprotected

The description of structure.

Parameters
[out]DescStorage for the description of the structure.

◆ DataType() [1/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [2/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [3/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ DataType() [4/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ GetDataQuality() [1/2]

FrameHNPS::dataQuality_type FrameHNPS::GetDataQuality ( ) const
inline

Data quality flag.

Retrieve the data quality flag associated with the frame.

Returns
The data quality flag for the frame

◆ GetDataQuality() [2/2]

dataQuality_type FrameCPP::Version_6::FrameHNPS::GetDataQuality ( ) const

Data quality flag.

Returns
The data quality flag for the frame

◆ GetDt() [1/2]

FrameHNPS::dt_type FrameHNPS::GetDt ( ) const
inline

Frame length.

Retrieve the duration of the frame in seconds.

Returns
Length of frame in seconds.

◆ GetDt() [2/2]

dt_type FrameCPP::Version_6::FrameHNPS::GetDt ( ) const

Frame length.

Returns
Length of frame in seconds.

◆ GetFrame() [1/2]

FrameHNPS::frame_type FrameHNPS::GetFrame ( ) const
inline

Frame number.

Retrieve the frame number associated with the frame.

Returns
The frame number of the frame

◆ GetFrame() [2/2]

frame_type FrameCPP::Version_6::FrameHNPS::GetFrame ( ) const

Frame number.

Returns
The frame number of the frame

◆ GetGTime() [1/2]

const GPSTime & FrameHNPS::GetGTime ( ) const
inline

Start Time.

Retrieve the start time of the frame.

Returns
The start time of the frame

◆ GetGTime() [2/2]

const GPSTime & FrameCPP::Version_6::FrameHNPS::GetGTime ( ) const

Start Time.

Returns
The start time of the frame

◆ GetName() [1/2]

const std::string & FrameHNPS::GetName ( ) const
inline

Retrieve name of project.

Retrieve the name of project or other experiment description.

Returns
Name of project

◆ GetName() [2/2]

const std::string & FrameCPP::Version_6::FrameHNPS::GetName ( ) const

Retrieve name of project.

Returns
Name of project

◆ GetRun() [1/2]

FrameHNPS::run_type FrameHNPS::GetRun ( ) const
inline

Run number.

Retrieve the run number associated with the frame.

Returns
The run number of the frame

◆ GetRun() [2/2]

run_type FrameCPP::Version_6::FrameHNPS::GetRun ( ) const

Run number.

Returns
The run number of the frame

◆ GetULeapS() [1/2]

FrameHNPS::ULeapS_type FrameHNPS::GetULeapS ( ) const
inline

Leap seconds.

Retrieve the number of leap seconds associated with the frame.

Returns
The integer number of leap seconds associated with the start time.

◆ GetULeapS() [2/2]

ULeapS_type FrameCPP::Version_6::FrameHNPS::GetULeapS ( ) const

Leap seconds.

Returns
The integer number of leap seconds associated with the start time.

◆ SetDataQuality() [1/2]

void FrameHNPS::SetDataQuality ( dataQuality_type DataQuality)
inline

Establish the data quality flag.

Set the data quality flag of the frame.

Parameters
[in]DataQualityThe value of the data quality flag.

◆ SetDataQuality() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetDataQuality ( dataQuality_type DataQuality)

Establish the data quality flag.

Parameters
[in]DataQualityThe value of the data quality flag.

◆ SetDt() [1/2]

void FrameHNPS::SetDt ( dt_type Dt)
inline

Establish the frame duration.

Set the length of the frame in seconds.

Parameters
[in]DtThe length of the frame in seconds

◆ SetDt() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetDt ( dt_type Dt)

Establish the frame duration.

Parameters
[in]DtThe length of the frame in seconds

◆ SetGTime() [1/2]

void FrameHNPS::SetGTime ( const GPSTime & GTime)
inline

Establish the start time.

Set the start time of the frame.

Parameters
[in]GTimeThe start time of the frame.

◆ SetGTime() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetGTime ( const GPSTime & GTime)

Establish the start time.

Parameters
[in]GTimeThe start time of the frame.

◆ SetName() [1/2]

void FrameHNPS::SetName ( const std::string & Name)
inline

Establish the name.

Parameters
[in]NameThe 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.

◆ SetName() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetName ( const std::string & Name)

Establish the name.

Parameters
[in]NameThe name to associate with the frame

◆ SetRun() [1/2]

void FrameHNPS::SetRun ( run_type Run)
inline

Establish the run number.

Parameters
[in]RunThe 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.

◆ SetRun() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetRun ( run_type Run)

Establish the run number.

Parameters
[in]RunThe run number to associate with the frame.

◆ SetULeapS() [1/2]

void FrameHNPS::SetULeapS ( ULeapS_type Value)
inline

Establish leap second offset.

Set the number of leap seconds since GPS epoc.

Parameters
[in]ValueNumber of leap seconds since GPS epoc.

◆ SetULeapS() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetULeapS ( ULeapS_type Value)

Establish leap second offset.

Parameters
[in]ValueNumber of leap seconds since GPS epoc.

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inherited

◆ vTOCQuery() [1/2]

void FrameHNPS::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtual

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_6::FrameHNPS::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtual

Member Data Documentation

◆ m_data

data_type FrameHNPS::m_data
protected

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