Class Index Cross Index Namespace Index

Class FrameCPP::FrameFilename

Class to parse frame filename
Contained in: FrameCPP
Derived from: none
Derived by: none

#include "framecpp/FrameFilename.hh"


public function member index:

FrameFilename(const std::string& Filename); Constructor
const std::string& Base() const; Return the base filename
const std::string& D() const; Return the description of the contents of a file
const std::string& Dir() const; Return the directory component of the filename
const std::string& Ext() const; Return the extension component of the filename
gps_seconds_type G() const; Return the GPS start time in seconds of the first frame in the file
const std::string& S() const; Return the source of the data
total_time_interval_type T() const; Return the total time interval covered by the file, in seconds
 

Description:

This implemnetation is based on the document LIGO-T010150


Function Member Descriptions:


FrameCPP::FrameFilename::FrameFilename - Constructor


FrameFilename(const std::string& Filename);



FrameCPP::FrameFilename::Base - Return the base filename


const std::string& Base() const;



FrameCPP::FrameFilename::D - Return the description of the contents of a file


const std::string& D() const;



FrameCPP::FrameFilename::Dir - Return the directory component of the filename


const std::string& Dir() const;



FrameCPP::FrameFilename::Ext - Return the extension component of the filename


const std::string& Ext() const;



FrameCPP::FrameFilename::G - Return the GPS start time in seconds of the first frame in the file


gps_seconds_type G() const;



FrameCPP::FrameFilename::S - Return the source of the data


const std::string& S() const;



FrameCPP::FrameFilename::T - Return the total time interval covered by the file, in seconds


total_time_interval_type T() const;



Variable Member Descriptions:


FrameCPP::FrameFilename::m_base - Base component of the filename

std::string m_base;

FrameCPP::FrameFilename::m_d - D component of filename

std::string m_d;

FrameCPP::FrameFilename::m_directory - Directory component of the filename

std::string m_directory;

FrameCPP::FrameFilename::m_ext -

std::string m_ext;

FrameCPP::FrameFilename::m_filename - Origional text of filename

std::string m_filename;

FrameCPP::FrameFilename::m_g - G component of filename

gps_seconds_type m_g;

FrameCPP::FrameFilename::m_good - state indicating that the name comforms to the spec

bool m_good;

FrameCPP::FrameFilename::m_s - S component of filename

std::string m_s;

FrameCPP::FrameFilename::m_spec - Name of document specifying LDAS' naming convetion for frame files

static const std::string m_spec;

FrameCPP::FrameFilename::m_tt - T component of filename

total_time_interval_type m_tt;