Initial commit

Lts/Plugins/AudioVideoManagement/avm_data_plugin_interface.h

@@ -0,0 +1,102 @@
+/**
+  * @RDE_HEADER@
+  * Data Plugin Interface for AVS (Interface for access from other Plugins)
+  * $Id$
+  * $HeadURL$
+  * $Author$
+  * Created by Christian Ehrlicher, SLSE, 2016-02-29
+  */
+
+#pragma once
+
+#include <PluginInterfaces/data_plugin_interface.h>
+#include <AudioVideoManagement/avm_dtc.h>
+#include <AudioVideoManagement/avm_ftc.h>
+
+namespace ExerciseManagement
+{
+namespace Interface
+{
+class Dtc;
+}
+}
+
+
+namespace OperatorManagement
+{
+namespace Interface
+{
+class Dtc;
+}
+}
+
+
+namespace AudioVideoManagement
+{
+
+class AvaSession;
+class AvaState;
+class VdSession;
+class StreamNameMapping;
+class AvsMenus;
+class PlaybackApp;
+
+/**
+ * @brief The DataInterface class provides the Topics Clients only for the GUI Plugins
+ */
+//
+// cfroebel 2017-06-13: What's the sense of the separation into DataInterface and ForeignDataInterface?
+// Even the AvmMenuEditGuiPlugin uses the ForeignDataInterface.
+// There's not much benefit from a DataInterface that only holds DTC and FTC.
+// Maybe there should only be one DataInterface (the merger of the two) that
+// can be used internally as well as externally.
+// cfroebel 2017-06-14: Merged both interfaces
+//
+class DataInterface : public DataPluginBase::Interface
+{
+public:
+  using DataPluginBase::Interface::Interface;
+
+  virtual std::shared_ptr<AudioVideoManagement::Interface::Dtc> getDtc() = 0;
+  virtual std::shared_ptr<AudioVideoManagement::Interface::Ftc> getFtc() = 0;
+
+  virtual ExerciseManagement::Interface::Dtc *getExmDtc() = 0;
+  virtual OperatorManagement::Interface::Dtc *getOpmDtc() = 0;
+
+  /**
+   * @name Access to the communication session with AVS_Workstation and related parts.
+   * The getter-methods may only be called when hasAvsSession() returns true.
+   * They always return a valid pointer then.
+   */
+  ///@{
+  virtual bool hasAvsSession() const = 0;
+  virtual bool vdSessionEstablished() const = 0;
+  virtual AvaSession *avaSession() = 0;
+  virtual AvaState *avaState() = 0;
+  virtual AvsMenus *menus() = 0;
+  virtual PlaybackApp *videoPlaybackApp() = 0;
+  virtual PlaybackApp *audioPlaybackApp() = 0;
+  virtual PlaybackApp *videoPresentationApp() = 0;
+  virtual PlaybackApp *audioPresentationApp() = 0;
+  ///@}
+
+  /**
+   * @name Access to the communication session with AVS_Export.
+   * The getter-methods may only be called when hasAvsSession() returns true.
+   * They always return a valid pointer then.
+   */
+  ///@{
+  virtual VdSession *vdSession() = 0;
+  ///@}
+
+  /** Only available when not in global partition; must not be called otherwise. */
+  virtual StreamNameMapping *streamNameMapping() = 0;
+
+  virtual void showCamera(QWidget *irreplacableWidget, int mountingPointId) = 0;
+  virtual void showAnnouncementUnit(int mountingPointId) = 0;
+  virtual void showOrCloseAvsApp() = 0;
+};
+
+using ForeignDataInterface = DataInterface;
+
+} //namespace AudioVideoManagement