stf::Event Class Reference

Describes the attributes of an event. More...

#include <stf.h>

List of all members.

Public Member Functions
	Event (std::size_t start, std::size_t peak, std::size_t size, bool discard_=false)
	Constructor.
	~Event ()
	Destructor.
std::size_t	GetEventStartIndex () const
	Retrieves the start index of an event.
std::size_t	GetEventPeakIndex () const
	Retrieves the index of an event's peak.
std::size_t	GetEventSize () const
	Retrieves the size of an event.
bool	GetDiscard () const
	Indicates whether an event should be discarded.
void	SetEventStartIndex (std::size_t value)
	Sets the start index of an event.
void	SetEventPeakIndex (std::size_t value)
	Sets the index of an event's peak.
void	SetEventSize (std::size_t value)
	Sets the size of an event.
void	SetDiscard (bool value)
	Determines whether an event should be discarded.
void	ToggleStatus ()
	Sets discard to true if it was false and vice versa.

---

Detailed Description

Describes the attributes of an event.

---

Member Function Documentation

bool stf::Event::GetDiscard

(

)

const [inline]

Indicates whether an event should be discarded.

Returns:

true if it should be discarded, false otherwise.

Referenced by wxStfCheckBox::ResetEvent().

std::size_t stf::Event::GetEventPeakIndex

(

)

const [inline]

Retrieves the index of an event's peak.

Returns:

The index of an event's peak within a section.

std::size_t stf::Event::GetEventSize

(

)

const [inline]

Retrieves the size of an event.

Returns:

The size of an event in units of data points.

std::size_t stf::Event::GetEventStartIndex

(

)

const [inline]

Retrieves the start index of an event.

Returns:

The start index of an event within a section.

void stf::Event::SetDiscard

(

bool

value

)

[inline]

Determines whether an event should be discarded.

Returns:

true if it should be discarded, false otherwise.

void stf::Event::SetEventPeakIndex

(

std::size_t

value

)

[inline]

Sets the index of an event's peak.

Parameters:

value

The index of an event's peak within a section.

void stf::Event::SetEventSize

(

std::size_t

value

)

[inline]

Sets the size of an event.

Parameters:

value

The size of an event in units of data points.

void stf::Event::SetEventStartIndex

(

std::size_t

value

)

[inline]

Sets the start index of an event.

Parameters:

value

The start index of an event within a section.

---

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

• src/stimfit/stf.h