BBoB_Channel Class Reference

#include <bbob_channel.h>

Inheritance diagram for BBoB_Channel:

QObject BusConsoleChannel ButtonBlockChannel FaderBlockChannel FmodChannel GlExampleChannel LightTreeChannel LiveUpdateChannel SoundChannel TestChannel

List of all members.


Detailed Description

Basic I/O Signals and Slots.

Definition at line 23 of file bbob_channel.h.


Public Member Functions

 BBoB_Channel ()
 BBoB_Channel (BBoB_Module_Base *mod, int channel_dir=Channel_Dir_In, int channel_type=Channel_Type_Bit, QString channel_name="")
 Create a new Channel.
bool operator< (const BBoB_Channel &other) const
 Less than operator for sorting in QMap.
QString getModName ()
 Return the name of the module this channel is in.
QString getName ()
 Return the name of this channel.
void setName (QString n)
 Set the name of this channel.
int getType ()
 Return the type (bit|byte|string) of this channel.
QString getMimetype ()
 Return a string of Mimetype based on type.
int getPointer ()
 Returns a pointer to the channel cast as an int.
void SaveSettings (const BBoB_Settings *settings, const QString modName)
 Default function that can be overidden later.
void Input (const int level, const QString s)
 Keeps a list of data with priority levels, for cue stacking.
virtual void SendOutput (const QString s)=0
virtual void Output (const QString s)=0
virtual void Input (const QString s)=0

Public Attributes

BBoB_Module_BaseModuleBase
 Holds the source of this channel, required to save/load connection state.
QString name
int type
int dir

Private Attributes

QMap< QString, QStringConnections
QMap< int, QStringInputData

Constructor & Destructor Documentation

BBoB_Channel::BBoB_Channel (  ) 

BBoB_Channel::BBoB_Channel ( BBoB_Module_Base mod,
int  channel_dir = Channel_Dir_In,
int  channel_type = Channel_Type_Bit,
QString  channel_name = "" 
)

Create a new Channel.

Definition at line 17 of file bbob_channel.cpp.

References dir, ModuleBase, name, and type.


Member Function Documentation

bool BBoB_Channel::operator< ( const BBoB_Channel other  )  const

Less than operator for sorting in QMap.

Definition at line 36 of file bbob_channel.cpp.

References name.

QString BBoB_Channel::getModName (  ) 

Return the name of the module this channel is in.

Get the name of the Module this is in.

Definition at line 42 of file bbob_channel.cpp.

References BBoB_Module_Base::getName(), and ModuleBase.

Referenced by BCore::connectChannelCue(), BCore::connectChannels(), BCore::loadCues(), Config_Cues::RefreshChans(), BCore::saveCues(), and Config_Cues::selectChannel().

Here is the call graph for this function:

QString BBoB_Channel::getName (  ) 

Return the name of this channel.

Get the name of the Channel.

Definition at line 49 of file bbob_channel.cpp.

References name.

Referenced by Config_Cues::addChan(), BCore::connectChannelCue(), BCore::connectChannels(), BCore::loadCues(), Config_Cues::RefreshChans(), BCore::saveCues(), and Config_Cues::selectChannel().

void BBoB_Channel::setName ( QString  n  ) 

Set the name of this channel.

Set the name of the Channel.

Definition at line 55 of file bbob_channel.cpp.

References name.

int BBoB_Channel::getType (  ) 

Return the type (bit|byte|string) of this channel.

Return the type of channel, may be obsolete soon as all data could be a string.

Definition at line 61 of file bbob_channel.cpp.

References type.

QString BBoB_Channel::getMimetype (  ) 

Return a string of Mimetype based on type.

Return the mime type based on channel_type.

Definition at line 67 of file bbob_channel.cpp.

References Channel_Mimetype_Bit, Channel_Mimetype_Byte, Channel_Mimetype_String, Channel_Type_Bit, Channel_Type_Byte, Channel_Type_String, and type.

Referenced by UdpPlugin::ModuleInputs(), TimeCodePlugin::ModuleInputs(), TestPlugin::ModuleInputs(), TcpPlugin::ModuleInputs(), SoundPlugin::ModuleInputs(), SerialPlugin::ModuleInputs(), SDLPlugin::ModuleInputs(), PluginViewerPlugin::ModuleInputs(), LiveUpdatePlugin::ModuleInputs(), LightTreePlugin::ModuleInputs(), GlExamplePlugin::ModuleInputs(), FmodSystemPlugin::ModuleInputs(), FaderBlockPlugin::ModuleInputs(), ButtonBlockPlugin::ModuleInputs(), BusConsolePlugin::ModuleInputs(), UdpPlugin::ModuleOutputs(), TimeCodePlugin::ModuleOutputs(), TestPlugin::ModuleOutputs(), TcpPlugin::ModuleOutputs(), SoundPlugin::ModuleOutputs(), SerialPlugin::ModuleOutputs(), SDLPlugin::ModuleOutputs(), PluginViewerPlugin::ModuleOutputs(), LiveUpdatePlugin::ModuleOutputs(), LightTreePlugin::ModuleOutputs(), GlExamplePlugin::ModuleOutputs(), FmodSystemPlugin::ModuleOutputs(), FaderBlockPlugin::ModuleOutputs(), ButtonBlockPlugin::ModuleOutputs(), and BusConsolePlugin::ModuleOutputs().

int BBoB_Channel::getPointer (  ) 

Returns a pointer to the channel cast as an int.

Returns a pointer to this object as an integer.

Definition at line 79 of file bbob_channel.cpp.

void BBoB_Channel::SaveSettings ( const BBoB_Settings settings,
const QString  modName 
)

Default function that can be overidden later.

Reimplemented in BusConsoleChannel, ButtonBlockChannel, FaderBlockChannel, FmodChannel, GlExampleChannel, LiveUpdateChannel, SoundChannel, and TestChannel.

Definition at line 84 of file bbob_channel.cpp.

void BBoB_Channel::Input ( const int  level,
const QString  s 
)

Keeps a list of data with priority levels, for cue stacking.

Definition at line 27 of file bbob_channel.cpp.

References InputData, and QMap::values().

Here is the call graph for this function:

virtual void BBoB_Channel::SendOutput ( const QString  s  )  [pure virtual]

Implemented in BusConsoleChannel, ButtonBlockChannel, FaderBlockChannel, FmodChannel, GlExampleChannel, LightTreeChannel, LiveUpdateChannel, SoundChannel, and TestChannel.

Referenced by FaderBlockModule::dataIn(), and ButtonBlockModule::dataIn().

virtual void BBoB_Channel::Output ( const QString  s  )  [pure virtual]

Implemented in BusConsoleChannel, ButtonBlockChannel, FaderBlockChannel, FmodChannel, GlExampleChannel, LightTreeChannel, LiveUpdateChannel, SoundChannel, and TestChannel.

virtual void BBoB_Channel::Input ( const QString  s  )  [pure virtual]

Implemented in BusConsoleChannel, ButtonBlockChannel, FaderBlockChannel, FmodChannel, GlExampleChannel, LightTreeChannel, LiveUpdateChannel, SoundChannel, and TestChannel.


Member Data Documentation

QMap<QString, QString> BBoB_Channel::Connections [private]

Definition at line 25 of file bbob_channel.h.

QMap<int, QString> BBoB_Channel::InputData [private]

Definition at line 27 of file bbob_channel.h.

Referenced by Input().

BBoB_Module_Base* BBoB_Channel::ModuleBase

Holds the source of this channel, required to save/load connection state.

Definition at line 37 of file bbob_channel.h.

Referenced by BBoB_Channel(), and getModName().

QString BBoB_Channel::name

Definition at line 39 of file bbob_channel.h.

Referenced by BBoB_Channel(), BCore::findChannel(), getName(), SoundChannel::Input(), LightTreeChannel::Input(), FmodChannel::Input(), BusConsoleChannel::Input(), UdpPlugin::ModuleInputs(), TimeCodePlugin::ModuleInputs(), TestPlugin::ModuleInputs(), TcpPlugin::ModuleInputs(), SoundPlugin::ModuleInputs(), SerialPlugin::ModuleInputs(), SDLPlugin::ModuleInputs(), PluginViewerPlugin::ModuleInputs(), LiveUpdatePlugin::ModuleInputs(), LightTreePlugin::ModuleInputs(), GlExamplePlugin::ModuleInputs(), FmodSystemPlugin::ModuleInputs(), FaderBlockPlugin::ModuleInputs(), ButtonBlockPlugin::ModuleInputs(), BusConsolePlugin::ModuleInputs(), UdpPlugin::ModuleOutputs(), TimeCodePlugin::ModuleOutputs(), TestPlugin::ModuleOutputs(), TcpPlugin::ModuleOutputs(), SoundPlugin::ModuleOutputs(), SerialPlugin::ModuleOutputs(), SDLPlugin::ModuleOutputs(), PluginViewerPlugin::ModuleOutputs(), LiveUpdatePlugin::ModuleOutputs(), LightTreePlugin::ModuleOutputs(), GlExamplePlugin::ModuleOutputs(), FmodSystemPlugin::ModuleOutputs(), FaderBlockPlugin::ModuleOutputs(), ButtonBlockPlugin::ModuleOutputs(), BusConsolePlugin::ModuleOutputs(), operator<(), and setName().

int BBoB_Channel::type

Definition at line 40 of file bbob_channel.h.

Referenced by BBoB_Channel(), getMimetype(), getType(), and GlExampleChannel::Input().

int BBoB_Channel::dir

Definition at line 41 of file bbob_channel.h.

Referenced by BBoB_Channel(), UdpPlugin::ModuleInputs(), TimeCodePlugin::ModuleInputs(), TestPlugin::ModuleInputs(), TcpPlugin::ModuleInputs(), SoundPlugin::ModuleInputs(), SerialPlugin::ModuleInputs(), SDLPlugin::ModuleInputs(), PluginViewerPlugin::ModuleInputs(), LiveUpdatePlugin::ModuleInputs(), LightTreePlugin::ModuleInputs(), GlExamplePlugin::ModuleInputs(), FmodSystemPlugin::ModuleInputs(), FaderBlockPlugin::ModuleInputs(), ButtonBlockPlugin::ModuleInputs(), BusConsolePlugin::ModuleInputs(), UdpPlugin::ModuleOutputs(), TimeCodePlugin::ModuleOutputs(), TestPlugin::ModuleOutputs(), TcpPlugin::ModuleOutputs(), SoundPlugin::ModuleOutputs(), SerialPlugin::ModuleOutputs(), SDLPlugin::ModuleOutputs(), PluginViewerPlugin::ModuleOutputs(), LiveUpdatePlugin::ModuleOutputs(), LightTreePlugin::ModuleOutputs(), GlExamplePlugin::ModuleOutputs(), FmodSystemPlugin::ModuleOutputs(), FaderBlockPlugin::ModuleOutputs(), ButtonBlockPlugin::ModuleOutputs(), and BusConsolePlugin::ModuleOutputs().


The documentation for this class was generated from the following files:
Generated on Sun Oct 28 22:51:33 2007 for BBoB by  doxygen 1.5.3