vtkPlusDataCollector.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
Program: Plus
Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
See License.txt for details.
=========================================================Plus=header=end*/

#ifndef __vtkPlusDataCollector_h
#define __vtkPlusDataCollector_h

// Local includes
#include "igsioCommon.h"
#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusDevice.h"

// VTK includes
#include <vtkObject.h>

//class igsioTrackedFrame; 
class vtkPlusChannel;
class vtkPlusDeviceFactory;
//class vtkIGSIOTrackedFrameList;
class vtkXMLDataElement;

class vtkPlusDataCollectionExport vtkPlusDataCollector : public vtkObject
{
public:
  static vtkPlusDataCollector* New();
  vtkTypeMacro(vtkPlusDataCollector, vtkObject);
  virtual void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  PlusStatus ReadConfiguration(vtkXMLDataElement* aConfig);
  PlusStatus ReadConfiguration(const std::string& fileName);
  PlusStatus WriteConfiguration(vtkXMLDataElement* aConfig);

  void SetDeviceFactory(vtkSmartPointer<vtkPlusDeviceFactory> factory);
  vtkPlusDeviceFactory& GetDeviceFactory();

  PlusStatus Start();

  PlusStatus Stop();

  PlusStatus Connect();

  PlusStatus Disconnect();

  virtual PlusStatus SetLoopTimes();

  PlusStatus AddDevice(vtkPlusDevice* aDevice);

  PlusStatus GetDevice(vtkPlusDevice*& aDevice, const std::string& aDeviceId) const;

  PlusStatus GetChannel(vtkPlusChannel*& aChannel, const std::string& aChannelId) const;
  PlusStatus GetFirstChannel(vtkPlusChannel*& aChannel) const;

  DeviceCollectionConstIterator GetDeviceConstIteratorBegin() const;
  DeviceCollectionConstIterator GetDeviceConstIteratorEnd() const;

  PlusStatus DumpBuffersToDirectory(const char* aDirectory);

  PlusStatus GetTrackingData(vtkPlusChannel* aRequestedChannel, double& aTimestampFrom, vtkIGSIOTrackedFrameList* aTrackedFrameList);

  virtual PlusStatus GetVideoData(vtkPlusChannel* aRequestedChannel, double& aTimestamp, vtkIGSIOTrackedFrameList* aTrackedFrameList);

  /*
  * Functions to manage the currently active stream mixers
  */
  PlusStatus GetDevices(DeviceCollection& OutVector) const;

  /*
    Identify if the device is started or not
  */
  bool GetStarted() const;
  bool IsStarted() const { return this->GetStarted(); }

  /*
    Is the system connected?
  */
  bool GetConnected() const;

  vtkSetMacro(StartupDelaySec, double);
  vtkGetMacro(StartupDelaySec, double);

protected:
  vtkPlusDataCollector();
  virtual ~vtkPlusDataCollector();

  double StartupDelaySec;

  vtkSmartPointer<vtkPlusDeviceFactory> DeviceFactory;

  DeviceCollection Devices;

  bool Connected;
  bool Started;

private:
  vtkPlusDataCollector(const vtkPlusDataCollector&);
  void operator=(const vtkPlusDataCollector&);
};

#endif