Recording Class Reference

Represents the data within a file. More...

#include <recording.h>

Inheritance diagram for Recording:

Public Member Functions
	Recording ()
	Default constuctor.
	Recording (const Channel &c_Channel)
	Constructor.
	Recording (const std::deque< Channel > &ChannelList)
	Constructor.
	Recording (std::size_t c_n_channels, std::size_t c_n_sections=0, std::size_t c_n_points=0)
	Constructor.
virtual	~Recording ()
	Destructor.
std::size_t	GetChannelSize (std::size_t n_channel) const
	Retrieves the number of sections in a channel.
const std::deque< Channel > &	get () const
	Retrieves the channels (read-only).
std::deque< Channel > &	get ()
	Retrieves the channels (read and write).
const std::string &	GetFileDescription () const
	Retrieves the file description.
const std::string &	GetGlobalSectionDescription () const
	Retrieves the common section description.
const std::string &	GetScaling () const
	Retrieves the scaling as a string.
struct tm	GetDateTime () const
	Retrieves the date of recording as a string.
const std::string &	GetComment () const
	Retrieves a comment string.
const std::string &	GetXUnits () const
	Retrieves the x units.
std::size_t	size () const
	Retrieves the size of the channel array.
double	GetXScale () const
	Retrieves the x scaling (sampling interval).
double	GetSR () const
	Retrieves the sampling rate ( 1 / x-scale )
std::size_t	GetCurChIndex () const
	Retrieves the index of the current channel.
std::size_t	GetSecChIndex () const
	Retrieves the index of the second channel.
std::size_t	GetCurSecIndex () const
	Retrieves the index of the current section.
const std::vector< std::size_t > &	GetSelectedSections () const
	Retrieves the indices of the selected sections (read-only).
std::vector< std::size_t > &	GetSelectedSectionsW ()
	Retrieves the indices of the selected sections (read and write).
const Vector_double &	GetSelectBase () const
	Retrieves the stored baseline values of the selected sections (read-only).
Vector_double &	GetSelectBaseW ()
	Retrieves the stored baseline values of the selected sections (read and write).
const Section &	cursec () const
	Retrieves the currently accessed section in the active channel (read-only)
Section &	cursec ()
	Retrieves the currently accessed section in the active channel (read and write)
const Section &	secsec () const
	Retrieves the currently accessed section in the second (reference) channel (read-only)
const Channel &	curch () const
	Retrieves the active channel (read-only)
Channel &	curch ()
	Retrieves active channel (read and write)
const Channel &	secch () const
	Retrieves the second (reference) channel (read-only)
const Channel &	at (std::size_t n_c) const
	Range-checked access to a channel (read-only).
Channel &	at (std::size_t n_c)
	Range-checked access to a channel (read and write).
void	SetFileDescription (const std::string &value)
	Sets the file description.
void	SetGlobalSectionDescription (const std::string &value)
	Sets the common section description.
void	SetScaling (const std::string &value)
	Sets the scaling as a string.
int	SetTime (const std::string &value)
	Sets the time of recording as a string.
int	SetTime (int hour, int minute, int sec)
int	SetDate (const std::string &value)
	Sets the date of recording as a string.
int	SetDate (int year, int month, int mday)
void	SetDateTime (const struct tm &value)
	Sets the date and time of recording as struct tm.
void	SetDateTime (int year, int month, int mday, int hour, int minute, int sec)
void	SetComment (const std::string &value)
	Sets a comment string.
void	SetGlobalYUnits (std::size_t n_channel, const std::string &value)
	Sets the y units for a channel.
void	SetXUnits (const std::string &value)
	Sets the x units.
void	SetXScale (double value)
	Sets the x scaling.
void	SetCurChIndex (std::size_t value)
	Sets the index of the current channel.
void	SetSecChIndex (std::size_t value)
	Sets the index of the second channel.
void	SetCurSecIndex (std::size_t value)
	Sets the index of the current section.
virtual void	resize (std::size_t c_n_channels)
	Resize the Recording to a new number of channels.
virtual void	InsertChannel (Channel &c_Channel, std::size_t pos)
	Insert a Channel at a given position.
void	CopyAttributes (const Recording &c_Recording)
	Copy descriptive attributes from another Recording to this Recording.
void	MakeAverage (Section &AverageReturn, Section &SigReturn, std::size_t channel, const std::vector< std::size_t > &section_index, bool isSig, const std::vector< int > &shift) const
	Calculates an average of several traces.
void	AddRec (const Recording &toAdd)
	Add a Recording at the end of this Recording.
void	SelectTrace (std::size_t sectionToSelect, std::ptrdiff_t base_start, std::ptrdiff_t base_end)
	Selects a section.
bool	UnselectTrace (std::size_t sectionToUnselect)
	Unselects a section if it was selected before.
Channel &	operator[] (std::size_t at)
	Unchecked channel access (read and write)
const Channel &	operator[] (std::size_t at) const
	Unchecked channel access (read-only)
std::string	GetEventDescription (int type)
	Get Description of Event Type.
void	SetEventDescription (int type, const char *Description)
	Set Description of Event Type.
void	InitSectionMarkerList (size_t n)
	Initialize List of Section Markers.
int	GetSectionType (size_t section_number)
	Get Type of Section.
void	SetSectionType (size_t section_number, int type)
	Set Type of Section.

Detailed Description

Represents the data within a file.

Contains an array of channels that can be accessed either via at() (range-checked, will throw an exception if out of range) or the []-operator (range unchecked). Moreover all the metadata such as time, date, samling rate and comments are stored here.

Definition at line 44 of file recording.h.

---

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

• src/libstfio/recording.h