libcdx: Interfaces to the Channel Data Exchange (CDX) File Format
C++, Python, and Matlab library to exchange data for radio propagation channels
Public Types | Public Member Functions | Protected Attributes | List of all members
CDX::ReadContinuousDelayFile Class Reference

Reads CIRs from CDX file. More...

#include <ReadContinuousDelayFile.h>

Inheritance diagram for CDX::ReadContinuousDelayFile:
Inheritance graph
[legend]
Collaboration diagram for CDX::ReadContinuousDelayFile:
Collaboration graph
[legend]

Public Types

typedef boost::shared_ptr< ReadContinuousDelayFileptr
 

Public Member Functions

 ReadContinuousDelayFile (std::string _filename)
 
cir_t get_cir (std::string link, unsigned int cir_num)
 returns CIR with a given number More...
 
unsigned int get_nof_cirs () const
 Return the number of CIRs in file. More...
 
- Public Member Functions inherited from CDX::ReadFile
 ReadFile (std::string _file_name)
 
- Public Member Functions inherited from CDX::File
 File (std::string _file_name)
 Construction from a file name. More...
 
 File (std::string _file_name, double _c0_m_s, double _cir_rate_Hz, double _transmitter_frequency_Hz, const std::vector< std::string > &_link_names)
 Construction from file name and parameters. More...
 
virtual ~File ()
 Destructor.
 
H5::H5File get_file_handle () const
 Returns the file handle to the HDF5 file. More...
 
size_t get_nof_links () const
 Returns number of links. More...
 
double get_cir_rate_Hz () const
 Return the CIR rate of the file. More...
 
double get_c0_m_s () const
 Returns the speed of light in m/s as defined in the CDX file. More...
 
double get_transmitter_frequency_Hz () const
 Returns the transmitter frequency in Hz. More...
 
std::vector< std::string > get_link_names () const
 Returns the link names. More...
 

Protected Attributes

unsigned int nof_cirs
 
std::map< std::string, H5::Group * > cir_groups
 
H5::CompType * cp_echo
 
- Protected Attributes inherited from CDX::ReadFile
std::map< std::string, std::vector< double > > ref_delays
 
- Protected Attributes inherited from CDX::File
const std::string file_name
 the CDX file's name
 
H5::H5File h5file
 the handle to the HDF5 file
 
double c0_m_s
 the speed of light in m/s
 
double cir_rate_Hz
 the CIR update rate in Hz
 
double transmitter_frequency_Hz
 the transmitter frequency in Hz
 
std::string delay_type
 the delay type, either "continuous-delay" or "discrete-delay"
 
std::vector< std::string > link_names
 vector of the link names
 
H5::Group links_group
 handle to the group in the HDF5 file that stores the links
 
const size_t nof_links
 the number of the links
 
std::map< std::string, H5::Group * > link_groups
 vector of pointers to HDF5 groups which contain data for each link in file
 

Additional Inherited Members

- Static Public Member Functions inherited from CDX::File
static double read_double_h5 (H5::H5File file, std::string dataset_name)
 Reads a double from an HDF5 file. More...
 
static std::string read_string_h5 (H5::H5File file, std::string path)
 Reads string of given path from an CDX file. More...
 
- Protected Member Functions inherited from CDX::ReadFile
std::vector< double > get_reference_delays (std::string link)
 

Detailed Description

Reads CIRs from CDX file.

Parameters
filename

Member Function Documentation

◆ get_cir()

cir_t CDX::ReadContinuousDelayFile::get_cir ( std::string  link,
unsigned int  cir_num 
)

returns CIR with a given number

Parameters
<cir_num>CIR number
Returns
CIR

◆ get_nof_cirs()

unsigned int CDX::ReadContinuousDelayFile::get_nof_cirs ( ) const
inline

Return the number of CIRs in file.

Returns
CIR amount

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