Open Ephys GUI
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes
Channel Class Reference

Holds metadata about a given channel within a processor. More...

#include <Channel.h>

List of all members.

Public Member Functions

 Channel (GenericProcessor *p, int n)
 Default constructor for creating Channels from scratch.
 Channel (const Channel &ch)
 Copy constructor.
String getName ()
 Returns the name of a given channel.
void reset ()
 Restores the default settings for a given channel.
void setProcessor (GenericProcessor *)
 Sets the processor to which a channel belongs.

Public Attributes

int num
 The channel number.
int nodeId
 The ID of the channel's processor.
int eventType
 Used for EventChannels only.
bool isEventChannel
bool isRecording
bool isMonitored
bool isEnabled
GenericProcessorprocessor
 Pointer to the channel's parent processor.
float sampleRate
float bitVolts
String filename
FILE * file
String name

Detailed Description

Holds metadata about a given channel within a processor.

The Channel class provides a convenient way to store settings for individual channels, and to pass that information between processors. It's especially handy for the interactions with the AudioNode and RecordNode, which need to access/update Channel information for multiple processors at once.

See also:
GenericProcessor, RecordNode, AudioNode

Constructor & Destructor Documentation

Channel::Channel ( GenericProcessor p,
int  n 
)

Default constructor for creating Channels from scratch.

Channel::Channel ( const Channel ch)

Copy constructor.


Member Function Documentation

String Channel::getName ( )

Returns the name of a given channel.

void Channel::reset ( )

Restores the default settings for a given channel.

void Channel::setProcessor ( GenericProcessor )

Sets the processor to which a channel belongs.


Member Data Documentation

int Channel::num

The channel number.

int Channel::nodeId

The ID of the channel's processor.

int Channel::eventType

Used for EventChannels only.

bool Channel::isEventChannel
bool Channel::isRecording
bool Channel::isMonitored
bool Channel::isEnabled
GenericProcessor* Channel::processor

Pointer to the channel's parent processor.

float Channel::sampleRate
float Channel::bitVolts
String Channel::filename
FILE* Channel::file
String Channel::name

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