AQNWB::Channel Class Reference

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.

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.

~Channel()

Channel::~Channel

(

)

Destructor.

Channel() [2/3]

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

default

Copy constructor.

Channel() [3/3]

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

default

Move constructor.

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.

operator=() [2/2]

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

default

Assignment operator.

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.

---

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

• src/Channel.hpp
• src/Channel.cpp