ldas-tools-framecpp  2.6.5
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_3::FrameHNPS Class Reference

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

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_3::FrameHNPS:
FrameCPP::Version_3::FrameH

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_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
 

Public Member Functions

 FrameHNPS ()
 Default constructor. More...
 
 FrameHNPS (const FrameHNPS &Source)
 Copy Constructor. More...
 
 FrameHNPS (const std::string &Name, run_type Run, frame_type Frame, const GTime_type &GTimeValue, ULeapS_type ULeapSValue, localTime_type LocalTime, const dt_type Dt)
 Constructor. More...
 
const std::string & GetName () const
 
run_type GetRun () const
 
frame_type GetFrame () const
 
const GTime_typeGetGTime () const
 
ULeapS_type GetULeapS () const
 
dt_type GetDt () const
 
localTime_type GetLocalTime () const
 
void SetRun (run_type Run)
 
void SetDt (dt_type Dt)
 
void SetGTime (const GTime_type &Value)
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset. More...
 

Protected Types

typedef Common::IStringStream assign_stream_type
 

Protected Member Functions

void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
streamsize_type bytes () const
 Number of bytes required by this object. More...
 
bool compare_nps (const FrameHNPS &RHS) const
 
void read (istream_type &Stream)
 
void write (ostream_type &Stream) const
 

Static Protected Member Functions

static void dataDescription (Common::Description &Desc)
 Dictionary description of data. More...
 

Protected Attributes

name_type name
 Name of project or other experiment description. More...
 
run_type run
 Run number. More...
 
frame_type frame
 Frame number. More...
 
GTime_type GTime
 Frame start time. More...
 
ULeapS_type ULeapS
 The number of leap seconds. More...
 
localTime_type localTime
 Local seasonal time. More...
 
dt_type dt
 Frame length in seconds. More...
 

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

◆ dt_type

◆ frame_type

◆ GTime_type

◆ GTimeN_type

◆ GTimeS_type

◆ localTime_type

◆ name_type

◆ run_type

◆ ULeapS_type

Constructor & Destructor Documentation

◆ FrameHNPS() [1/3]

FrameHNPS::FrameHNPS ( )

Default constructor.

◆ FrameHNPS() [2/3]

FrameHNPS::FrameHNPS ( const FrameHNPS Source)

Copy Constructor.

Parameters
[in]SourceThe

◆ FrameHNPS() [3/3]

FrameHNPS::FrameHNPS ( const std::string &  Name,
run_type  Run,
frame_type  Frame,
const GTime_type GTimeValue,
ULeapS_type  ULeapSValue,
localTime_type  LocalTime,
const dt_type  Dt 
)

Constructor.

Member Function Documentation

◆ assign()

void FrameHNPS::assign ( assign_stream_type Stream)
protected

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.

◆ bytes()

streamsize_type FrameHNPS::bytes ( ) const
inlineprotected

Number of bytes required by this object.

Returns
The number of bytes need to read or write this object to a stream.

◆ compare_nps()

bool FrameHNPS::compare_nps ( const FrameHNPS RHS) const
inlineprotected

◆ dataDescription()

void FrameHNPS::dataDescription ( Common::Description Desc)
inlinestaticprotected

Dictionary description of data.

Parameters
[out]DescThe handle to a dictionary description to which this type of object is to be added.

◆ GetDt()

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

◆ GetFrame()

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

◆ GetGTime()

const FrameHNPS::GTime_type & FrameHNPS::GetGTime ( ) const
inline

◆ GetLocalTime()

FrameHNPS::localTime_type FrameHNPS::GetLocalTime ( ) const
inline

◆ GetName()

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

◆ GetRun()

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

◆ GetULeapS()

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

◆ read()

void FrameHNPS::read ( istream_type Stream)
inlineprotected

◆ SetDt()

void FrameHNPS::SetDt ( dt_type  Dt)
inline

◆ SetGTime()

void FrameHNPS::SetGTime ( const GTime_type Value)
inline

◆ SetRun()

void FrameHNPS::SetRun ( run_type  Run)
inline

◆ SetULeapS()

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.

◆ write()

void FrameHNPS::write ( ostream_type Stream) const
inlineprotected

Member Data Documentation

◆ dt

dt_type FrameCPP::Version_3::FrameHNPS::dt
protected

Frame length in seconds.

◆ frame

frame_type FrameCPP::Version_3::FrameHNPS::frame
protected

Frame number.

This value is monotonically increasing until the end of the run.

◆ GTime

GTime_type FrameCPP::Version_3::FrameHNPS::GTime
protected

Frame start time.

The GPS time since GPS standard epoch.

◆ localTime

localTime_type FrameCPP::Version_3::FrameHNPS::localTime
protected

Local seasonal time.

UTC in seconds [integer multiple of 1800 seconds].

◆ name

name_type FrameCPP::Version_3::FrameHNPS::name
protected

Name of project or other experiment description.

Name of project or other experiment description. (e.g., GEO; LIGO; VIRGO; TAMA; ...)

◆ run

run_type FrameCPP::Version_3::FrameHNPS::run
protected

Run number.

◆ ULeapS

ULeapS_type FrameCPP::Version_3::FrameHNPS::ULeapS
protected

The number of leap seconds.

The integer number of leap seconds between GPS\/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].


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