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

#include <ReferenceNodeEditor.h>

Inheritance diagram for ReferenceNodeEditor:
GenericEditor AccessClass

List of all members.

Public Member Functions

 ReferenceNodeEditor (GenericProcessor *parentNode)
virtual ~ReferenceNodeEditor ()
void buttonEvent (Button *button)
 Called by buttonClicked().
- Public Member Functions inherited from GenericEditor
 GenericEditor (GenericProcessor *owner)
 Constructor.
virtual ~GenericEditor ()
 Destructor.
void paint (Graphics &g)
 Draws the editor's background.
bool keyPressed (const KeyPress &key)
 Called whenever a key is pressed and the editor has keyboard focus.
void switchSelectedState ()
 Toggles the editor's selection state.
void select ()
 Highlights an editor and calls editorWasClicked().
void highlight ()
 Highlights an editor.
void deselect ()
 Deselects an editor.
bool getSelectionState ()
 Returns an editor's selection state.
void enable ()
 Used to enable an editor's processor.
void disable ()
 Used to disable an editor's processor.
bool getEnabledState ()
 Returns whether or not the editor's processor is enabled (i.e., whether it's able to handle data.
void setEnabledState (bool)
 Used to enable or disable an editor's processor.
void startAcquisition ()
 Called just prior to the start of acquisition, to allow the editor to prepare.
void stopAcquisition ()
 Called after the end of acquisition.
String getName ()
 Returns the name of the editor.
virtual void tabNumber (int t)
 Sets the number of the editor's associated tab in the DataViewport.
int tabNumber ()
 Returns the number of the editor's associated tab in the DataViewport.
virtual void switchSource (int)
 Required for MergerEditor only.
virtual void switchSource ()
 Required for MergerEditor only.
GenericProcessorgetProcessor () const
 Returns the processor associated with an editor.
void fadeIn ()
 Causes the editor to fade in when it first appears in the EditorViewport.
virtual void switchDest ()
 Required for SplitterEditor only.
virtual void switchIO (int)
 Required for SplitterEditor and MergerEditor only.
virtual void buttonClicked (Button *button)
 Handles button clicks for all editors.
virtual void sliderValueChanged (Slider *slider)
 Handles slider events for all editors.
virtual void sliderEvent (Slider *slider)
 Called by sliderValueChanged().
virtual void editorWasClicked ()
 Required for opening displays in a VisualizerEditor.
bool checkDrawerButton (Button *button)
 Checks to see if a button click occurred on the ChannelSelector drawer button.
bool getRecordStatus (int chan)
 Returns the record status of a given channel from the ChannelSelector.
bool getAudioStatus (int chan)
 Returns the audio monitoring status of a given channel from the ChannelSelector.
void selectChannels (Array< int >)
 Selects all the channels in the input array.
void refreshColors ()
 Refreshes an editor's background colors when the user selects new ones with the ColourSelector.
virtual void update ()
 Called when an editor's processor updates its settings (mainly to update channel count).
virtual void updateSettings ()
 Called by the update() method to allow the editor to update its custom settings.
virtual void updateVisualizer ()
 Allows an editor to update the settings of its visualizer (such as channel count and sample rate).
virtual void channelChanged (int chan)
 Used by SpikeDetectorEditor.
Array< int > getActiveChannels ()
 Returns all selected channels from the ChannelSelector.
ChannelgetChannel (int chan)
 Returns the Channel object for a given continuous channel number.
ChannelgetEventChannel (int chan)
 Returns the Channel object for a given event channel number.
- Public Member Functions inherited from AccessClass
 AccessClass ()
 ~AccessClass ()
void setUIComponent (UIComponent *)
 Sets the object's UIComponent and copies all the necessary pointers from the UIComponent.
virtual void updateChildComponents ()
 Called within setUIComponent() to enable subclasses to update their members' pointers.
EditorViewportgetEditorViewport ()
 Returns a pointer to the application's EditorViewport.
DataViewportgetDataViewport ()
 Returns a pointer to the application's DataViewport.
ProcessorListgetProcessorList ()
 Returns a pointer to the application's ProcessorList.
ProcessorGraphgetProcessorGraph ()
 Returns a pointer to the application's ProcessorGraph.
ControlPanelgetControlPanel ()
 Returns a pointer to the application's DataViewport.
MessageCentergetMessageCenter ()
 Returns a pointer to the application's MessageCenter.
UIComponentgetUIComponent ()
 Returns a pointer to the application's UIComponent.
AudioComponentgetAudioComponent ()
 Returns a pointer to the application's AudioComponent.

Additional Inherited Members

- Public Attributes inherited from GenericEditor
int desiredWidth
 Determines how wide the editor will be drawn.
int nodeId
 The unique integer ID of the editor's processor.
bool isFading
 Indicates whether or not the editor is in the processof fading in.
float accumulator
 Used to control the speed at which the editor fades in.
Array< ParameterEditor * > parameterEditors
 An array of pointers to ParameterEditors created based on the Parameters of an editor's underlying processor.
Font titleFont
 Stores the font used to display the editor's name.
- Protected Member Functions inherited from GenericEditor
virtual void addParameterEditors ()
 Can be overridden to customize the layout of ParameterEditors.
- Protected Attributes inherited from GenericEditor
DrawerButtondrawerButton
 A pointer to the button that opens the drawer for the ChannelSelector.
int drawerWidth
 Determines the width of the ChannelSelector drawer when opened.
ChannelSelectorchannelSelector
 A pointer to the editor's ChannelSelector.

Constructor & Destructor Documentation

ReferenceNodeEditor::ReferenceNodeEditor ( GenericProcessor parentNode)
virtual ReferenceNodeEditor::~ReferenceNodeEditor ( )
virtual

Member Function Documentation

void ReferenceNodeEditor::buttonEvent ( Button *  button)
virtual

Called by buttonClicked().

Deals with clicks on custom buttons. Subclasses of GenericEditor should modify this method only.

Reimplemented from GenericEditor.


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