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

Owns all processors and constructs the signal chain. More...

#include <ProcessorGraph.h>

Inheritance diagram for ProcessorGraph:
AccessClass

List of all members.

Public Member Functions

 ProcessorGraph ()
 ~ProcessorGraph ()
void * createNewProcessor (String &description)
GenericProcessorcreateProcessorFromDescription (String &description)
void removeProcessor (GenericProcessor *processor)
void clearSignalChain ()
bool enableProcessors ()
bool disableProcessors ()
RecordNodegetRecordNode ()
AudioNodegetAudioNode ()
void updateConnections (Array< SignalChainTabButton *, CriticalSection >)
bool processorWithSameNameExists (const String &name)
void changeListenerCallback (ChangeBroadcaster *source)
- 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.

Detailed Description

Owns all processors and constructs the signal chain.

The GUI revolves around the ProcessorGraph, which enables the user to dynamically update the signal chain. This object creates and deletes all of the processors that handle data, and holds the rules for connecting them prior to data acquisition.

The user is able to modify the ProcessGraph through the EditorViewport

See also:
EditorViewport, GenericProcessor, GenericEditor, RecordNode, AudioNode, Configuration, MessageCenter

Constructor & Destructor Documentation

ProcessorGraph::ProcessorGraph ( )
ProcessorGraph::~ProcessorGraph ( )

Member Function Documentation

void* ProcessorGraph::createNewProcessor ( String &  description)
GenericProcessor* ProcessorGraph::createProcessorFromDescription ( String &  description)
void ProcessorGraph::removeProcessor ( GenericProcessor processor)
void ProcessorGraph::clearSignalChain ( )
bool ProcessorGraph::enableProcessors ( )
bool ProcessorGraph::disableProcessors ( )
RecordNode* ProcessorGraph::getRecordNode ( )
AudioNode* ProcessorGraph::getAudioNode ( )
void ProcessorGraph::updateConnections ( Array< SignalChainTabButton *, CriticalSection >  )
bool ProcessorGraph::processorWithSameNameExists ( const String &  name)
void ProcessorGraph::changeListenerCallback ( ChangeBroadcaster *  source)

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