mitkUSVideoDevice.h

Go to the documentation of this file.

/*===================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef MITKUSVideoDevice_H_HEADER_INCLUDED_
#define MITKUSVideoDevice_H_HEADER_INCLUDED_

#include <MitkUSExports.h>
#include <mitkCommon.h>
#include "mitkUSDevice.h"
#include "mitkUSImageVideoSource.h"
#include "mitkUSProbe.h"
#include <itkObjectFactory.h>

namespace itk {
  template<class T> class SmartPointer;
}

namespace mitk {
  class USVideoDeviceCustomControls;
  class USAbstractControlInterface;

  class MITKUS_EXPORT USVideoDevice : public mitk::USDevice
  {
  public:
    mitkClassMacro(USVideoDevice, mitk::USDevice);
    // To open a device (DeviceID, Manufacturer, Model)
    mitkNewMacro3Param(Self, int, std::string, std::string);
    // To open A VideoFile (Path, Manufacturer, Model)
    mitkNewMacro3Param(Self, std::string, std::string, std::string);
    // To open a device (DeviceID, Metadata)
    mitkNewMacro2Param(Self, int, mitk::USImageMetadata::Pointer);
    // To open A VideoFile (Path, Metadata)
    mitkNewMacro2Param(Self, std::string, mitk::USImageMetadata::Pointer);

    virtual std::string GetDeviceClass() override;

    static std::string GetDeviceClassStatic();

    virtual itk::SmartPointer<USAbstractControlInterface> GetControlInterfaceCustom() override;

    void UnregisterOnService();

    virtual USImageSource::Pointer GetUSImageSource() override;

    std::vector<mitk::USProbe::Pointer> GetAllProbes();

    mitk::USProbe::Pointer GetCurrentProbe();

    void AddNewProbe(mitk::USProbe::Pointer probe);

    mitk::USProbe::Pointer GetProbeByName(std::string name);

    void RemoveProbeByName(std::string name);

    bool GetIsSourceFile();

    itkGetMacro(Image, mitk::Image::Pointer);
    itkGetMacro(DeviceID, int);
    itkGetMacro(FilePath, std::string);
  protected:

    USVideoDevice(int videoDeviceNumber, std::string manufacturer, std::string model);
    USVideoDevice(std::string videoFilePath, std::string manufacturer, std::string model);
    USVideoDevice(int videoDeviceNumber, mitk::USImageMetadata::Pointer metadata);
    USVideoDevice(std::string videoFilePath, mitk::USImageMetadata::Pointer metadata);

    virtual ~USVideoDevice();

    void Init();

    virtual bool OnInitialization() override;

    virtual bool OnConnection() override;

    virtual bool OnDisconnection() override;

    virtual bool OnActivation() override;

    virtual bool OnDeactivation() override;

    mitk::USImageVideoSource::Pointer m_Source;

    bool m_SourceIsFile;

    int m_DeviceID;

    std::string m_FilePath;

    itk::SmartPointer<USVideoDeviceCustomControls> m_ControlInterfaceCustom;

    std::vector < mitk::USProbe::Pointer > m_Probes;

    mitk::USProbe::Pointer m_CurrentProbe;
  };
} // namespace mitk

#endif // MITKUSVideoDevice_H_HEADER_INCLUDED_