FrameFilename Class Reference

Class to parse frame filename. More...

#include <FrameFilename.hh>

Classes
class	InvalidFrameFilename
	Exception describing a corrupted frame file name. More...

Public Types
typedef unsigned int	gps_seconds_type
typedef unsigned int	gps_seconds_type
typedef unsigned int	total_time_interval_type
typedef unsigned int	total_time_interval_type

Public Member Functions
	FrameFilename (const std::string &Filename)
	Constructor.
	FrameFilename (const std::string &Filename)
	Constructor.
const std::string &	Base () const
	Return the base filename.
const std::string &	Base () const
	Return the base filename.
const std::string &	Dir () const
	Return the directory component of the filename.
const std::string &	Dir () const
	Return the directory component of the filename.
const std::string &	D () const
	Return the description of the contents of a file.
const std::string &	D () const
	Return the description of the contents of a file.
gps_seconds_type	G () const
	Return the GPS start time in seconds of the first frame in the.
gps_seconds_type	G () const
	Return the GPS start time in seconds of the first frame in the.
const std::string &	S () const
	Return the source of the data.
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.
total_time_interval_type	T () const
	Return the total time interval covered by the file, in seconds.
const std::string &	Ext () const
	Return the extension component of the filename.
const std::string &	Ext () const
	Return the extension component of the filename.

Private Attributes
std::string	m_filename
	Origional text of filename.
std::string	m_s
	S component of filename.
std::string	m_d
	D component of filename.
gps_seconds_type	m_g
	G component of filename.
total_time_interval_type	m_tt
	T component of filename.
std::string	m_ext
std::string	m_base
	Base component of the filename.
std::string	m_directory
	Directory component of the filename.
bool	m_good
	state indicating that the name comforms to the spec

Static Private Attributes
static const std::string	m_spec
	Name of document specifying LDAS' naming convetion for frame files.

Detailed Description

Class to parse frame filename.

This implemnetation is based on the document LIGO-T010150

Member Typedef Documentation

gps_seconds_type [1/2]

typedef unsigned int FrameCPP::Common::FrameFilename::gps_seconds_type

gps_seconds_type [2/2]

typedef unsigned int FrameCPP::Common::FrameFilename::gps_seconds_type

total_time_interval_type [1/2]

typedef unsigned int FrameCPP::Common::FrameFilename::total_time_interval_type

total_time_interval_type [2/2]

typedef unsigned int FrameCPP::Common::FrameFilename::total_time_interval_type

Constructor & Destructor Documentation

FrameFilename() [1/2]

FrameCPP::Common::FrameFilename::FrameFilename

(

const std::string &

Filename

)

Constructor.

FrameFilename() [2/2]

FrameCPP::Common::FrameFilename::FrameFilename

(

const std::string &

Filename

)

Constructor.

Member Function Documentation

Base() [1/2]

const std::string & FrameCPP::Common::FrameFilename::Base ( ) const

inline

Return the base filename.

Base() [2/2]

const std::string & FrameCPP::Common::FrameFilename::Base

(

)

const

Return the base filename.

D() [1/2]

const std::string & FrameCPP::Common::FrameFilename::D ( ) const

inline

Return the description of the contents of a file.

D() [2/2]

const std::string & FrameCPP::Common::FrameFilename::D

(

)

const

Return the description of the contents of a file.

Dir() [1/2]

const std::string & FrameCPP::Common::FrameFilename::Dir ( ) const

inline

Return the directory component of the filename.

Dir() [2/2]

const std::string & FrameCPP::Common::FrameFilename::Dir

(

)

const

Return the directory component of the filename.

Ext() [1/2]

const std::string & FrameCPP::Common::FrameFilename::Ext ( ) const

inline

Return the extension component of the filename.

Ext() [2/2]

const std::string & FrameCPP::Common::FrameFilename::Ext

(

)

const

Return the extension component of the filename.

G() [1/2]

FrameFilename::gps_seconds_type FrameCPP::Common::FrameFilename::G ( ) const

inline

Return the GPS start time in seconds of the first frame in the.

G() [2/2]

gps_seconds_type FrameCPP::Common::FrameFilename::G

(

)

const

Return the GPS start time in seconds of the first frame in the.

S() [1/2]

const std::string & FrameCPP::Common::FrameFilename::S ( ) const

inline

Return the source of the data.

S() [2/2]

const std::string & FrameCPP::Common::FrameFilename::S

(

)

const

Return the source of the data.

T() [1/2]

FrameFilename::total_time_interval_type FrameCPP::Common::FrameFilename::T ( ) const

inline

Return the total time interval covered by the file, in seconds.

T() [2/2]

total_time_interval_type FrameCPP::Common::FrameFilename::T

(

)

const

Return the total time interval covered by the file, in seconds.

Member Data Documentation

m_base

std::string FrameCPP::Common::FrameFilename::m_base

private

Base component of the filename.

m_d

std::string FrameCPP::Common::FrameFilename::m_d

private

D component of filename.

m_directory

std::string FrameCPP::Common::FrameFilename::m_directory

private

Directory component of the filename.

m_ext

std::string FrameCPP::Common::FrameFilename::m_ext

private

m_filename

std::string FrameCPP::Common::FrameFilename::m_filename

private

Origional text of filename.

m_g

gps_seconds_type FrameCPP::Common::FrameFilename::m_g

private

G component of filename.

m_good

bool FrameCPP::Common::FrameFilename::m_good

private

state indicating that the name comforms to the spec

m_s

std::string FrameCPP::Common::FrameFilename::m_s

private

S component of filename.

m_spec

const std::string FrameCPP::Common::FrameFilename::m_spec

staticprivate

Name of document specifying LDAS' naming convetion for frame files.

m_tt

total_time_interval_type FrameCPP::Common::FrameFilename::m_tt

private

T component of filename.

---

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

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/FrameFilename.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameFilename.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameFilename.cc