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

Allows subclasses to access important pointers within the application. More...

#include <AccessClass.h>

Inheritance diagram for AccessClass:
AudioConfigurationWindow AudioEditor ChannelSelector ControlPanel DataViewport EditorViewport GenericEditor GenericProcessor ProcessorGraph ProcessorList SignalChainManager

List of all members.

Public Member Functions

 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

Allows subclasses to access important pointers within the application.

When an object inherits from AccessClass, it makes it much more convenient to get and set pointers to other objects, such as the EditorViewport, ProcessorList, and ProcessorGraph that are used throughout the application. In addition, every subclass of AccessClass automatically adds the MessageCenter as an ActionListener, which means messages sent by that object [using sendActionMessage("Message.")] will appear in the MessageCenter by default.

See also:
UIComponent, MessageCenter

Constructor & Destructor Documentation

AccessClass::AccessClass ( )
AccessClass::~AccessClass ( )

Member Function Documentation

void AccessClass::setUIComponent ( UIComponent )

Sets the object's UIComponent and copies all the necessary pointers from the UIComponent.

Automatically adds the MessageCenter as an ActionListener, which causes messages sent using sendActionMessage("Message") to appear in the MessageCenter.

virtual void AccessClass::updateChildComponents ( )
virtual

Called within setUIComponent() to enable subclasses to update their members' pointers.

EditorViewport* AccessClass::getEditorViewport ( )

Returns a pointer to the application's EditorViewport.

DataViewport* AccessClass::getDataViewport ( )

Returns a pointer to the application's DataViewport.

ProcessorList* AccessClass::getProcessorList ( )

Returns a pointer to the application's ProcessorList.

ProcessorGraph* AccessClass::getProcessorGraph ( )

Returns a pointer to the application's ProcessorGraph.

ControlPanel* AccessClass::getControlPanel ( )

Returns a pointer to the application's DataViewport.

MessageCenter* AccessClass::getMessageCenter ( )

Returns a pointer to the application's MessageCenter.

UIComponent* AccessClass::getUIComponent ( )

Returns a pointer to the application's UIComponent.

AudioComponent* AccessClass::getAudioComponent ( )

Returns a pointer to the application's AudioComponent.


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