Public Member Functions

QStreamer::QPinList Class Reference

#include <qpinlist.h>

List of all members.

Public Member Functions

 QPinList ()
 Constructor.
 ~QPinList ()
 Destructor.
class QSourcePinsourcePin (const QString &name)
 Returns the source pin with the given name or 0 if the pin is not found.
class QSinkPinsinkPin (const QString &name)
 Returns the sink pin with the given name or 0 if the pin is not found.
class QPinpin (const QString &name)
 Returns the pin with the given name or 0 if the pin is not found.
bool add (QPin *pin)
bool remove (QPin *pin)
class QSourcePintakeFirstSourcePin ()
class QSinkPintakeFirstSinkPin ()
bool contains (QPin *pin)
 Returns true if the given pin exists in the list.
bool contains (const QString &name)
 Returns true if a pin with the given name exists in the list.
quint32 count () const
 Returns the number of pins in the list.
quint32 sourcePinCount () const
 Returns the number of source pins in the list.
quint32 sinkPinCount () const
 Returns the number of sink pins in the list.

Detailed Description

Provides a container for tracking source and sink pins within an element

Note:
this class is specifically designed for use directly by QElement.

Constructor & Destructor Documentation

QStreamer::QPinList::QPinList (  )

Constructor.

QStreamer::QPinList::~QPinList (  )

Destructor.


Member Function Documentation

bool QStreamer::QPinList::add ( QPin pin )

Adds the given pin to the list if the pin is neither already in the list or the pin's name doesn't already exist in the list.

Parameters:
pinthe pin to add.
Returns:
true if it was added successfully, false if it wasn't.
bool QStreamer::QPinList::contains ( QPin pin )

Returns true if the given pin exists in the list.

bool QStreamer::QPinList::contains ( const QString &  name )

Returns true if a pin with the given name exists in the list.

quint32 QStreamer::QPinList::count (  ) const

Returns the number of pins in the list.

class QPin * QStreamer::QPinList::pin ( const QString &  name )

Returns the pin with the given name or 0 if the pin is not found.

bool QStreamer::QPinList::remove ( QPin pin )

Removes the given pin from the list.

Parameters:
pinthe pin to attempt to remove.
Returns:
true if it was removed successfully, false if it wasn't.
class QSinkPin * QStreamer::QPinList::sinkPin ( const QString &  name )

Returns the sink pin with the given name or 0 if the pin is not found.

quint32 QStreamer::QPinList::sinkPinCount (  ) const

Returns the number of sink pins in the list.

class QSourcePin * QStreamer::QPinList::sourcePin ( const QString &  name )

Returns the source pin with the given name or 0 if the pin is not found.

quint32 QStreamer::QPinList::sourcePinCount (  ) const

Returns the number of source pins in the list.

class QSinkPin * QStreamer::QPinList::takeFirstSinkPin (  )

Removes the first sink pin from the list and returns the removed pin.

Returns:
the pointer to the pin removed or 0 if there was no sink pin to remove.
class QSourcePin * QStreamer::QPinList::takeFirstSourcePin (  )

Removes the first source pin from the list and returns the removed pin.

Returns:
the pointer to the pin removed or 0 if there was no source pin to remove.

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