Class for storing acquisition system channel information. More...

#include <Channel.hpp>

Public Member Functions
	Channel (const std::string name, const std::string groupName, const SizeType groupIndex, const SizeType localIndex, const SizeType globalIndex, const float conversion=1e6f, const float samplingRate=30000.f, const float bitVolts=0.05f, const std::array< float, 3 > position={0.f, 0.f, 0.f}, const std::string comments="no comments")
	Constructor.

	~Channel ()
	Destructor.

	Channel (const Channel &other)=default
	Copy constructor.

	Channel (Channel &&other)=default
	Move constructor.

Channel &	operator= (const Channel &other)=default
	Assignment operator.

Channel &	operator= (Channel &&other)=default
	Move assignment operator.

float	getConversion () const
	Getter for conversion factor.

float	getSamplingRate () const
	Getter for sampling rate of the channel.

float	getBitVolts () const
	Getter for bitVolts floating point value of microvolts per bit.

std::string	getGroupName () const
	Get the name of the array group the channel belongs to.

std::string	getName () const
	Get the name of the channel.

SizeType	getGroupIndex () const
	Get the array group index the channel belongs to.

SizeType	getLocalIndex () const
	Get the index of the channel within the recording array.

SizeType	getGlobalIndex () const
	Get the index of the channel across the recording system.

const std::array< float, 3 > &	getPosition () const
	Get the coordinates of channel (x, y, z) within the recording array.

std::string	getComments () const
	Get comments about the channel.

void	setComments (const std::string &comments)
	Set comments about the channel.

void	setPosition (const std::array< float, 3 > &position)
	Set coordinates of channel (x, y, z) within the recording array.

void	setName (const std::string &name)
	Set name of the channel.

Private Attributes
std::string	m_name
	Name of the channel.

std::string	m_groupName
	Name of the array group the channel belongs to.

SizeType	m_groupIndex
	Index of array group the channel belongs to.

SizeType	m_localIndex
	Index of channel within the recording array.

SizeType	m_globalIndex
	Index of channel across the recording system.

float	m_conversion
	Conversion factor.

float	m_samplingRate
	Sampling rate of the channel.

float	m_bitVolts
	floating point value of microvolts per bit

std::array< float, 3 >	m_position
	Coordinates of channel (x, y, z) within the recording array.

std::string	m_comments
	Comments about the channel.

Detailed Description

Class for storing acquisition system channel information.

Constructor & Destructor Documentation

◆ Channel() [1/3]

Channel::Channel	(	const std::string	name,
		const std::string	groupName,
		const SizeType	groupIndex,
		const SizeType	localIndex,
		const SizeType	globalIndex,
		const float	conversion = 1e6f,
		const float	samplingRate = 30000.f,
		const float	bitVolts = 0.05f,
		const std::array< float, 3 >	position = {0.f, 0.f, 0.f},
		const std::string	comments = "no comments" )

Constructor.

Here is the caller graph for this function:

◆ ~Channel()

Channel::~Channel ( )

Destructor.

◆ Channel() [2/3]

AQNWB::Channel::Channel ( const Channel & other )

default

Copy constructor.

Here is the call graph for this function:

◆ Channel() [3/3]

AQNWB::Channel::Channel ( Channel && other )

default

Move constructor.

Here is the call graph for this function:

Member Function Documentation

◆ getBitVolts()

float AQNWB::Channel::getBitVolts ( ) const

inline

Getter for bitVolts floating point value of microvolts per bit.

Returns: The bitVolts value.

◆ getComments()

std::string AQNWB::Channel::getComments ( ) const

inline

Get comments about the channel.

Returns: The comments value.

◆ getConversion()

float AQNWB::Channel::getConversion ( ) const

inline

Getter for conversion factor.

Returns: The conversion value.

◆ getGlobalIndex()

SizeType AQNWB::Channel::getGlobalIndex ( ) const

inline

Get the index of the channel across the recording system.

Returns: The globalIndex value.

◆ getGroupIndex()

SizeType AQNWB::Channel::getGroupIndex ( ) const

inline

Get the array group index the channel belongs to.

Returns: The groupIndex value.

◆ getGroupName()

std::string AQNWB::Channel::getGroupName ( ) const

inline

Get the name of the array group the channel belongs to.

Returns: The groupName value.

◆ getLocalIndex()

SizeType AQNWB::Channel::getLocalIndex ( ) const

inline

Get the index of the channel within the recording array.

Returns: The localIndex value.

Here is the caller graph for this function:

◆ getName()

std::string AQNWB::Channel::getName ( ) const

inline

Get the name of the channel.

Returns: The name value.

◆ getPosition()

const std::array< float, 3 > & AQNWB::Channel::getPosition ( ) const

inline

Get the coordinates of channel (x, y, z) within the recording array.

Returns: The position value.

◆ getSamplingRate()

float AQNWB::Channel::getSamplingRate ( ) const

inline

Getter for sampling rate of the channel.

Returns: The sampling rate value.

◆ operator=() [1/2]

Channel & AQNWB::Channel::operator= ( Channel && other )

default

Move assignment operator.

Here is the call graph for this function:

◆ operator=() [2/2]

Channel & AQNWB::Channel::operator= ( const Channel & other )

default

Assignment operator.

Here is the call graph for this function:

◆ setComments()

void AQNWB::Channel::setComments ( const std::string & comments )

inline

Set comments about the channel.

Parameters

comments The comments to set.

◆ setName()

void AQNWB::Channel::setName ( const std::string & name )

inline

Set name of the channel.

Parameters

name	The name to set.

◆ setPosition()

void AQNWB::Channel::setPosition ( const std::array< float, 3 > & position )

inline

Set coordinates of channel (x, y, z) within the recording array.

Parameters

position The position to set.

Member Data Documentation

◆ m_bitVolts

float AQNWB::Channel::m_bitVolts

private

floating point value of microvolts per bit

◆ m_comments

std::string AQNWB::Channel::m_comments

private

Comments about the channel.

◆ m_conversion

float AQNWB::Channel::m_conversion

private

Conversion factor.

◆ m_globalIndex

SizeType AQNWB::Channel::m_globalIndex

private

Index of channel across the recording system.

◆ m_groupIndex

SizeType AQNWB::Channel::m_groupIndex

private

Index of array group the channel belongs to.

◆ m_groupName

std::string AQNWB::Channel::m_groupName

private

Name of the array group the channel belongs to.

◆ m_localIndex

SizeType AQNWB::Channel::m_localIndex

private

Index of channel within the recording array.

◆ m_name

std::string AQNWB::Channel::m_name

private

Name of the channel.

◆ m_position

std::array<float, 3> AQNWB::Channel::m_position

private

Coordinates of channel (x, y, z) within the recording array.

◆ m_samplingRate

float AQNWB::Channel::m_samplingRate

private

Sampling rate of the channel.

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

src/Channel.hpp
src/Channel.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Channel() [1/3]

◆ ~Channel()

◆ Channel() [2/3]

◆ Channel() [3/3]

Member Function Documentation

◆ getBitVolts()

◆ getComments()

◆ getConversion()

◆ getGlobalIndex()

◆ getGroupIndex()

◆ getGroupName()

◆ getLocalIndex()

◆ getName()

◆ getPosition()

◆ getSamplingRate()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setComments()

◆ setName()

◆ setPosition()

Member Data Documentation

◆ m_bitVolts

◆ m_comments

◆ m_conversion

◆ m_globalIndex

◆ m_groupIndex

◆ m_groupName

◆ m_localIndex

◆ m_name

◆ m_position

◆ m_samplingRate