Non-PTR_STRUCT elements of the FrameH structure.
More...
#include <FrameH.hh>
Inherits FrameCPP::Common::TOCInfo.
Inherited by FrameCPP::Version_6::FrameH.
|
| 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...
|
|
| 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...
|
|
|
template<typename SE > |
static void | dataDescription (Common::Description &Desc) |
| The description of structure. More...
|
|
template<typename SE > |
static void | dataDescription (Common::Description &Desc) |
| The description of structure. More...
|
|
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.
◆ FrameHNPS() [1/8]
FrameCPP::Version_6::FrameHNPS::FrameHNPS |
( |
| ) |
|
Default constructor.
Construct a new FrameHNPS object with default values
- Returns
- A new FrameHNPS object.
◆ FrameHNPS() [2/8]
FrameCPP::Version_6::FrameHNPS::FrameHNPS |
( |
const FrameHNPS & |
Source | ) |
|
Copy Constructor.
Construct a new FrameHNPS object based on Source.
- Parameters
-
[in] | Source | Instance to use to populate this instance. |
- Returns
- A new FrameHNPS object.
◆ FrameHNPS() [3/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] | 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. |
- Returns
- A new FrameHNPS object.
◆ FrameHNPS() [4/8]
Copy Constructor based on a previous frame specification.
- Parameters
-
[in] | Source | A 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] | Source | Instance 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] | 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. |
- Returns
- A new FrameHNPS object.
◆ FrameHNPS() [8/8]
Copy Constructor based on a previous frame specification.
- Parameters
-
[in] | Source | A FrmaeHNPS object of a previous frame specification. |
- Returns
- A new FrameHNPS object
◆ assign() [1/2]
void FrameCPP::Version_6::FrameHNPS::assign |
( |
assign_stream_type & |
Stream | ) |
|
|
inlineprotected |
Hook to provide table of contents information.
Assign the contents of the instance
- Parameters
-
[in] | Stream | An 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] | Stream | An 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 FrameCPP::Version_6::FrameHNPS::dataDescription |
( |
Common::Description & |
Desc | ) |
|
|
inlinestaticprotected |
The description of structure.
- Parameters
-
[out] | Desc | Storage 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] | Desc | Storage for the description of the structure. |
◆ GetDataQuality() [1/2]
FrameHNPS::dataQuality_type FrameCPP::Version_6::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 FrameCPP::Version_6::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 FrameCPP::Version_6::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 & FrameCPP::Version_6::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 & FrameCPP::Version_6::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 FrameCPP::Version_6::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 FrameCPP::Version_6::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 FrameCPP::Version_6::FrameHNPS::SetDataQuality |
( |
dataQuality_type |
DataQuality | ) |
|
|
inline |
Establish the data quality flag.
Set the data quality flag of the frame.
- Parameters
-
[in] | DataQuality | The 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] | DataQuality | The value of the data quality flag. |
◆ SetDt() [1/2]
void FrameCPP::Version_6::FrameHNPS::SetDt |
( |
dt_type |
Dt | ) |
|
|
inline |
Establish the frame duration.
Set the length of the frame in seconds.
- Parameters
-
[in] | Dt | The length of the frame in seconds |
◆ SetDt() [2/2]
void FrameCPP::Version_6::FrameHNPS::SetDt |
( |
dt_type |
Dt | ) |
|
Establish the frame duration.
- Parameters
-
[in] | Dt | The length of the frame in seconds |
◆ SetGTime() [1/2]
void FrameCPP::Version_6::FrameHNPS::SetGTime |
( |
const GPSTime & |
GTime | ) |
|
|
inline |
Establish the start time.
Set the start time of the frame.
- Parameters
-
[in] | GTime | The start time of the frame. |
◆ SetGTime() [2/2]
void FrameCPP::Version_6::FrameHNPS::SetGTime |
( |
const GPSTime & |
GTime | ) |
|
Establish the start time.
- Parameters
-
[in] | GTime | The start time of the frame. |
◆ SetName() [1/2]
void FrameCPP::Version_6::FrameHNPS::SetName |
( |
const std::string & |
Name | ) |
|
|
inline |
Establish the name.
- Parameters
-
[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.
◆ SetName() [2/2]
void FrameCPP::Version_6::FrameHNPS::SetName |
( |
const std::string & |
Name | ) |
|
Establish the name.
- Parameters
-
[in] | Name | The name to associate with the frame |
◆ SetRun() [1/2]
void FrameCPP::Version_6::FrameHNPS::SetRun |
( |
run_type |
Run | ) |
|
|
inline |
Establish the run number.
- Parameters
-
[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.
◆ SetRun() [2/2]
void FrameCPP::Version_6::FrameHNPS::SetRun |
( |
run_type |
Run | ) |
|
Establish the run number.
- Parameters
-
[in] | Run | The run number to associate with the frame. |
◆ SetULeapS() [1/2]
void FrameCPP::Version_6::FrameHNPS::SetULeapS |
( |
ULeapS_type |
Value | ) |
|
|
inline |
Establish leap second offset.
Set the number of leap seconds since GPS epoc.
- Parameters
-
[in] | Value | Number of leap seconds since GPS epoc. |
◆ SetULeapS() [2/2]
void FrameCPP::Version_6::FrameHNPS::SetULeapS |
( |
ULeapS_type |
Value | ) |
|
Establish leap second offset.
- Parameters
-
[in] | Value | Number of leap seconds since GPS epoc. |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version6/FrameH.hh
- Version6/FrameH.cc