makVrv::DtVideoStreamConfigurationWidget Class Reference

DtVideoStreamConfigurationWidget provides the GUI used to configure a video stream. More...

Inheritance diagram for makVrv::DtVideoStreamConfigurationWidget:

Public Member Functions
virtual	~DtVideoStreamConfigurationWidget ()
	DTOR.
void	setupGui ()
	Create and initialize the widgets that make up the GUI.
QSize	sizeHint () const
	Override QWidget::sizeHint to size the widget within the video stream edit page correctly.
virtual void	activate ()
	Create the logic element.
virtual void	setCurrentWindowName (const DtUnicode &windowName)
	Set the window name to display in the window selection widget.
virtual void	addWindowName (const DtUnicode &windowName)
	Add a window name to the window selection widget.
virtual void	removeWindowName (const DtUnicode &windowName)
	Remove a window name from the window selection widget.
virtual void	setCurrentChannelName (const DtUnicode &channelName)
	Set the channel name to display in the channel selection widget.
virtual void	addChannelName (const DtUnicode &channelName)
	Add a channel name to the channel selection widget.
virtual void	removeChannelName (const DtUnicode &channelName)
	Remove a channel name from the channel selection widget.
virtual void	setCurrentFrameRate (int frameRate)
	Set the frame rate the video should be streamed at.
virtual void	setCurrentNumBuffers (int numBuffers)
	Set the value of the number of buffers widget.
virtual void	setCurrentReadBuffer (const DtUnicode &readBuffer)
	Set the value of the read buffer type widget, e.g. "back".
virtual void	setReadBufferValues (const std::list< DtUnicode > &data, const std::list< DtUnicode > &names)
	Set the allowable values for readBuffer; this populates the read buffer selection widget.
virtual void	setImageTaskTypesAndNames (const std::list< DtUnicode > &taskTypes, const std::list< DtUnicode > &taskNames)
	Provide the list of all process image tasks currently supported.
virtual void	setMetadataPublisherTypesAndNames (const std::list< DtUnicode > &publisherTypes, const std::list< DtUnicode > &publisherNames)
	Provide the list of all metadata plublisher types currently supported.
virtual void	addImageTask (int index, const makArchives::DtImageTaskRecord &task)
	Add an image task to the image task pipeline.
virtual void	setImageTask (int index, const makArchives::DtImageTaskRecord &task)
	Specify the process image task that should be at the location indicated by index in the image task pipeline.
virtual void	removeImageTask (int index)
	Remove an image task from the image task pipeline.
virtual void	swapImageTasks (int index1, int index2)
	Swap the image tasks at the pipeline at the specified indices.
virtual void	setImageTaskMoveUpArrowEnabled (int index, bool enabled)
	Enable or disable the move up arrow button for the image task at the specified index in the pipeline.
virtual void	setImageTaskMoveDownArrowEnabled (int index, bool enabled)
	Enable or disable the move down arrow button for the image task at the specified index in the pipeline.
virtual void	setWindowChannelNameWarningLabel (bool warn)
	Set the state of the window/channel warning label.
virtual void	disableMetadataPublishers ()
	Called during initialization if there are no metadata publisher plugins installed.
virtual void	setMetadataCheckBox (bool onOff)
	Set the value of the metadata checkbox.
virtual void	setMetadataPublisherVisible (bool visible)
	Set whether the metadata publisher selection widget is shown.
virtual void	setMetadataPublisherType (const DtUnicode &publisherType)
	Set the selected metadata publisher type (if shown)
virtual void	setActionButtonState (DtVideoStreamConfigurationInterface::VideoStreamState state)
	Set the state of the action button (start / stop )
virtual void	setVideoStreamAutoStartState (bool autoStart)
	Set the state of the auto start button.
Public Member Functions inherited from makVrv::DtVideoStreamConfigurationInterface
	DtVideoStreamConfigurationInterface ()
	CTOR.
virtual	~DtVideoStreamConfigurationInterface ()
	DTOR.

Protected Slots
virtual void	onWindowNameSelectionChanged (int index)
virtual void	onChannelNameSelectionChanged (int index)
virtual void	onFrameRateSelectionChanged (int frameRate)
virtual void	onNumBuffersSelectionChanged (int numBuffers)
virtual void	onReadBufferSelectionChanged (int index)
virtual void	onMetadataPublisherIncludedChanged (int state)
virtual void	onMetadataPublisherSelectionChanged (int index)
virtual void	onAddTaskButtonClicked ()
virtual void	onActionButtonClicked ()
virtual void	onAutoStartButtonClicked ()

Protected Member Functions
	DtVideoStreamConfigurationWidget (DtDe &de, DtVideoStream &videoStream)
	CTOR (callable only by DtVideoStreamConfigWidgetCreator)
virtual void	setWarningLabel (QLabel *label, bool warn, const QString &toolTipIfTrue)
virtual void	connectImageTaskSignals (int index, DtImageTaskElementWidget *widget)
	Connect the widget to signals from an image task element widget that's being added to the image task pipeline.
virtual void	disconnectImageTaskSignals (int index, DtImageTaskElementWidget *widget)
	Disonnect the widget to signals from an image task element widget that's being removed to the image task pipeline.
virtual void	slot_imageTaskTypeChanged (int index, const DtUnicode &taskType)
	Boost slot connected to an image task element widget's image task type changed signal.
virtual void	slot_deleteImageTaskPressed (int index)
	Boost slot connected to an image task element widget's delete task signal.
virtual void	slot_moveImageTaskUpPressed (int index)
	Boost slot connected to an image task element widget's move task up signal.
virtual void	slot_moveImageTaskDownPressed (int index)
	Boost slot connected to an image task element widget's move task up signal.

Protected Attributes
DtDe &	myDe
DtVideoStream &	myVideoStream
DtVideoStreamConfigurationLogic *	myLogic
QVBoxLayout *	myLeftSideLayout
QVBoxLayout *	myPipelineElementLayout
QGroupBox *	myPipelineBox
QPushButton *	myActionButton
QPushButton *	myAutoStartButton
QLabel *	myMetadataPublisherLabel
QLabel *	myWindowChannelNameWarningLabel
QComboBox *	myWindowNameComboBox
QComboBox *	myChannelNameComboBox
QSpinBox *	myFrameRateSpinBox
QComboBox *	myDataTypeComboBox
QComboBox *	myPixelFormatComboBox
QSpinBox *	myNumBuffersSpinBox
QComboBox *	myReadBufferComboBox
QPushButton *	myAddTaskButton
QCheckBox *	myMetadataCheckBox
QComboBox *	myMetadataPublisherComboBox
std::list< DtUnicode >	myImageTaskTypes
std::list< DtUnicode >	myImageTaskNames
std::vector < DtImageTaskElementWidget * >	myImageTaskWidgets
DtMetadataPublisherConfigurationWidget *	myMetadataPublisherConfigWidget
QSpacerItem *	myEndSpacerItem
QVBoxLayout *	myMetadataLayout

Friends
class	DtVideoStreamConfigWidgetCreator
	Friend the creator class that will create instances of this widget.

Additional Inherited Members
Public Types inherited from makVrv::DtVideoStreamConfigurationInterface
enum	VideoStreamState { Stopped, Started, Suspended, Unavailable }
	Enumerate the possible video states. More...
Public Attributes inherited from makVrv::DtVideoStreamConfigurationInterface
boost::signal< void(const DtUnicode &)>	signal_windowNameSelectionChanged
	Signal raised by the widget when a window name is selected.
boost::signal< void(const DtUnicode &)>	signal_channelNameSelectionChanged
	Signal raised by the widget when a channel name is selected.
boost::signal< void(int)>	signal_frameRateSelectionChanged
	Signal raised by the widget when a frame rate is selected.
boost::signal< void(int)>	signal_numBuffersSelectionChanged
	Signal raised by the widget when a buffer count is selected.
boost::signal< void(const DtUnicode &)>	signal_readBufferSelectionChanged
	Signal raised by the widget when a read buffer type is selected.
boost::signal< void(int)>	signal_metadataPublisherIncludedChanged
	Signal raised by the widget when inclusion or exclusion of a metadata publisher is selected.
boost::signal< void(const DtUnicode &)>	signal_metadataPublisherTypeSelectionChanged
	Signal raised by the widget when a metadata publisher type is selected.
boost::signal< void(int index, const DtUnicode &taskType)>	signal_imageTaskTypeChanged
	Signal raised by the widget when a process image task type is selected.
boost::signal< void()>	signal_addImageTaskPressed
	Signal raised by the widget when the addition of a process image task is indicated.
boost::signal< void(int index)>	signal_deleteImageTaskPressed
	Signal raised by the widget when the deletion of a process image task is indicated.
boost::signal< void(int index)>	signal_moveImageTaskUpPressed
	Signal raised by the widget when the move up button of a process image task is pressed.
boost::signal< void(int index)>	signal_moveImageTaskDownPressed
	Signal raised by the widget when the move down button of a process image task is pressed.
boost::signal< void()>	signal_toggleVideoStreamState
	Signal raised by the widget when the action button is pressed, indicating that the video stream should be started or stopped.
boost::signal< void()>	signal_toggleCurrentVideoStreamAutoStartState
	Signal raised by the widget when the auto start button is pressed, enabling or disabling auto start for the video stream.

Detailed Description

DtVideoStreamConfigurationWidget provides the GUI used to configure a video stream.

Constructor & Destructor Documentation

virtual makVrv::DtVideoStreamConfigurationWidget::~DtVideoStreamConfigurationWidget ( )

virtual

DTOR.

makVrv::DtVideoStreamConfigurationWidget::DtVideoStreamConfigurationWidget ( DtDe &  de, DtVideoStream &  videoStream  )

protected

CTOR (callable only by DtVideoStreamConfigWidgetCreator)

Member Function Documentation

void makVrv::DtVideoStreamConfigurationWidget::setupGui

(

)

Create and initialize the widgets that make up the GUI.

QSize makVrv::DtVideoStreamConfigurationWidget::sizeHint

(

)

const

Override QWidget::sizeHint to size the widget within the video stream edit page correctly.

virtual void makVrv::DtVideoStreamConfigurationWidget::activate ( )

virtual

Create the logic element.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setCurrentWindowName ( const DtUnicode &  windowName )

virtual

Set the window name to display in the window selection widget.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::addWindowName ( const DtUnicode &  windowName )

virtual

Add a window name to the window selection widget.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::removeWindowName ( const DtUnicode &  windowName )

virtual

Remove a window name from the window selection widget.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setCurrentChannelName ( const DtUnicode &  channelName )

virtual

Set the channel name to display in the channel selection widget.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::addChannelName ( const DtUnicode &  channelName )

virtual

Add a channel name to the channel selection widget.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::removeChannelName ( const DtUnicode &  channelName )

virtual

Remove a channel name from the channel selection widget.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setCurrentFrameRate ( int  frameRate )

virtual

Set the frame rate the video should be streamed at.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setCurrentNumBuffers ( int  numBuffers )

virtual

Set the value of the number of buffers widget.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setCurrentReadBuffer ( const DtUnicode &  readBuffer )

virtual

Set the value of the read buffer type widget, e.g. "back".

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setReadBufferValues ( const std::list< DtUnicode > &  data, const std::list< DtUnicode > &  names  )

virtual

Set the allowable values for readBuffer; this populates the read buffer selection widget.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setImageTaskTypesAndNames ( const std::list< DtUnicode > &  taskTypes, const std::list< DtUnicode > &  taskNames  )

virtual

Provide the list of all process image tasks currently supported.

The widget maintains this list, making it available to process ismage task configuration widgets as they are added to the image task pipeline

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setMetadataPublisherTypesAndNames ( const std::list< DtUnicode > &  publisherTypes, const std::list< DtUnicode > &  publisherNames  )

virtual

Provide the list of all metadata plublisher types currently supported.

This populates the metadata publisher selection widget

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::addImageTask ( int  index, const makArchives::DtImageTaskRecord &  task  )

virtual

Add an image task to the image task pipeline.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setImageTask ( int  index, const makArchives::DtImageTaskRecord &  task  )

virtual

Specify the process image task that should be at the location indicated by index in the image task pipeline.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::removeImageTask ( int  index )

virtual

Remove an image task from the image task pipeline.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::swapImageTasks ( int  index1, int  index2  )

virtual

Swap the image tasks at the pipeline at the specified indices.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setImageTaskMoveUpArrowEnabled ( int  index, bool  enabled  )

virtual

Enable or disable the move up arrow button for the image task at the specified index in the pipeline.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setImageTaskMoveDownArrowEnabled ( int  index, bool  enabled  )

virtual

Enable or disable the move down arrow button for the image task at the specified index in the pipeline.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setWindowChannelNameWarningLabel ( bool  warn )

virtual

Set the state of the window/channel warning label.

This label is shown when the selected window name/channel name does not exist

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::disableMetadataPublishers ( )

virtual

Called during initialization if there are no metadata publisher plugins installed.

Causes everything related to metadata publishers to be removed from the dialog

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setMetadataCheckBox ( bool  onOff )

virtual

Set the value of the metadata checkbox.

This widget indicates whether a metadata publisher is included in this video stream

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setMetadataPublisherVisible ( bool  visible )

virtual

Set whether the metadata publisher selection widget is shown.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setMetadataPublisherType ( const DtUnicode &  publisherType )

virtual

Set the selected metadata publisher type (if shown)

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setActionButtonState ( DtVideoStreamConfigurationInterface::VideoStreamState  state )

virtual

Set the state of the action button (start / stop )

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::setVideoStreamAutoStartState ( bool  autoStart )

virtual

Set the state of the auto start button.

Implements makVrv::DtVideoStreamConfigurationInterface.

virtual void makVrv::DtVideoStreamConfigurationWidget::onWindowNameSelectionChanged ( int  index )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onChannelNameSelectionChanged ( int  index )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onFrameRateSelectionChanged ( int  frameRate )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onNumBuffersSelectionChanged ( int  numBuffers )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onReadBufferSelectionChanged ( int  index )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onMetadataPublisherIncludedChanged ( int  state )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onMetadataPublisherSelectionChanged ( int  index )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onAddTaskButtonClicked ( )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onActionButtonClicked ( )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::onAutoStartButtonClicked ( )

protectedvirtualslot

virtual void makVrv::DtVideoStreamConfigurationWidget::setWarningLabel ( QLabel *  label, bool  warn, const QString &  toolTipIfTrue  )

protectedvirtual

virtual void makVrv::DtVideoStreamConfigurationWidget::connectImageTaskSignals ( int  index, DtImageTaskElementWidget *  widget  )

protectedvirtual

Connect the widget to signals from an image task element widget that's being added to the image task pipeline.

virtual void makVrv::DtVideoStreamConfigurationWidget::disconnectImageTaskSignals ( int  index, DtImageTaskElementWidget *  widget  )

protectedvirtual

Disonnect the widget to signals from an image task element widget that's being removed to the image task pipeline.

virtual void makVrv::DtVideoStreamConfigurationWidget::slot_imageTaskTypeChanged ( int  index, const DtUnicode &  taskType  )

protectedvirtual

Boost slot connected to an image task element widget's image task type changed signal.

virtual void makVrv::DtVideoStreamConfigurationWidget::slot_deleteImageTaskPressed ( int  index )

protectedvirtual

Boost slot connected to an image task element widget's delete task signal.

virtual void makVrv::DtVideoStreamConfigurationWidget::slot_moveImageTaskUpPressed ( int  index )

protectedvirtual

Boost slot connected to an image task element widget's move task up signal.

virtual void makVrv::DtVideoStreamConfigurationWidget::slot_moveImageTaskDownPressed ( int  index )

protectedvirtual

Boost slot connected to an image task element widget's move task up signal.

Friends And Related Function Documentation

friend class DtVideoStreamConfigWidgetCreator

friend

Friend the creator class that will create instances of this widget.

Member Data Documentation

DtDe& makVrv::DtVideoStreamConfigurationWidget::myDe

protected

DtVideoStream& makVrv::DtVideoStreamConfigurationWidget::myVideoStream

protected

DtVideoStreamConfigurationLogic* makVrv::DtVideoStreamConfigurationWidget::myLogic

protected

QVBoxLayout* makVrv::DtVideoStreamConfigurationWidget::myLeftSideLayout

protected

QVBoxLayout* makVrv::DtVideoStreamConfigurationWidget::myPipelineElementLayout

protected

QGroupBox* makVrv::DtVideoStreamConfigurationWidget::myPipelineBox

protected

QPushButton* makVrv::DtVideoStreamConfigurationWidget::myActionButton

protected

QPushButton* makVrv::DtVideoStreamConfigurationWidget::myAutoStartButton

protected

QLabel* makVrv::DtVideoStreamConfigurationWidget::myMetadataPublisherLabel

protected

QLabel* makVrv::DtVideoStreamConfigurationWidget::myWindowChannelNameWarningLabel

protected

QComboBox* makVrv::DtVideoStreamConfigurationWidget::myWindowNameComboBox

protected

QComboBox* makVrv::DtVideoStreamConfigurationWidget::myChannelNameComboBox

protected

QSpinBox* makVrv::DtVideoStreamConfigurationWidget::myFrameRateSpinBox

protected

QComboBox* makVrv::DtVideoStreamConfigurationWidget::myDataTypeComboBox

protected

QComboBox* makVrv::DtVideoStreamConfigurationWidget::myPixelFormatComboBox

protected

QSpinBox* makVrv::DtVideoStreamConfigurationWidget::myNumBuffersSpinBox

protected

QComboBox* makVrv::DtVideoStreamConfigurationWidget::myReadBufferComboBox

protected

QPushButton* makVrv::DtVideoStreamConfigurationWidget::myAddTaskButton

protected

QCheckBox* makVrv::DtVideoStreamConfigurationWidget::myMetadataCheckBox

protected

QComboBox* makVrv::DtVideoStreamConfigurationWidget::myMetadataPublisherComboBox

protected

std::list<DtUnicode> makVrv::DtVideoStreamConfigurationWidget::myImageTaskTypes

protected

std::list<DtUnicode> makVrv::DtVideoStreamConfigurationWidget::myImageTaskNames

protected

std::vector<DtImageTaskElementWidget*> makVrv::DtVideoStreamConfigurationWidget::myImageTaskWidgets

protected

DtMetadataPublisherConfigurationWidget* makVrv::DtVideoStreamConfigurationWidget::myMetadataPublisherConfigWidget

protected

QSpacerItem* makVrv::DtVideoStreamConfigurationWidget::myEndSpacerItem

protected

QVBoxLayout* makVrv::DtVideoStreamConfigurationWidget::myMetadataLayout

protected

---

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

• include/vrvVideoStreamQt/DtVideoStreamConfigurationWidget.h