Mixxx

ChannelGroup Class Reference

Describes a group of channels, typically a pair for stereo sound in Mixxx. More...

#include <soundmanagerutil.h>

List of all members.

Public Member Functions

 ChannelGroup (unsigned char channelBase, unsigned char channels)
unsigned char getChannelBase () const
unsigned char getChannelCount () const
bool operator== (const ChannelGroup &other) const
bool clashesWith (const ChannelGroup &other) const
unsigned int getHash () const

Detailed Description

Describes a group of channels, typically a pair for stereo sound in Mixxx.

Definition at line 30 of file soundmanagerutil.h.


Constructor & Destructor Documentation

ChannelGroup::ChannelGroup ( unsigned char  channelBase,
unsigned char  channels 
)

Constructs a ChannelGroup.

Parameters:
channelBasethe first channel in the group.
channelsthe number of channels.

Definition at line 24 of file soundmanagerutil.cpp.


Member Function Documentation

bool ChannelGroup::clashesWith ( const ChannelGroup other) const

Checks if another ChannelGroup shares channels with this one.

Parameters:
otherthe other ChannelGroup to check for a clash with.
Returns:
true if the other and this ChannelGroup share any channels, false otherwise.

Definition at line 59 of file soundmanagerutil.cpp.

Here is the caller graph for this function:

unsigned char ChannelGroup::getChannelBase ( ) const
Returns:
This ChannelGroup's base channel

Definition at line 32 of file soundmanagerutil.cpp.

Here is the caller graph for this function:

unsigned char ChannelGroup::getChannelCount ( ) const
Returns:
The number of channels in this ChannelGroup

Definition at line 39 of file soundmanagerutil.cpp.

Here is the caller graph for this function:

unsigned int ChannelGroup::getHash ( ) const

Generates a hash of this ChannelGroup, so it can act as a key in a QHash.

Returns:
a hash for this ChannelGroup

Definition at line 75 of file soundmanagerutil.cpp.

Here is the caller graph for this function:

bool ChannelGroup::operator== ( const ChannelGroup other) const

Defines equality between two ChannelGroups.

Returns:
true if the two ChannelGroups share a common base channel and channel count, otherwise false.

Definition at line 48 of file soundmanagerutil.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines