cxProbe.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.
                 
Copyright (c) SINTEF Department of Medical Technology.
All rights reserved.
                 
CustusX is released under a BSD 3-Clause license.
                 
See Lisence.txt (https://github.com/SINTEFMedtek/CustusX/blob/master/License.txt) for details.
=========================================================================*/


#ifndef CXPROBE_H_
#define CXPROBE_H_

#include "cxResourceExport.h"

#include <QObject>
#include <boost/weak_ptr.hpp>
#include "cxProbeDefinition.h"
#include "cxForwardDeclarations.h"

namespace cx
{
class cxResource_EXPORT Probe: public QObject
{
        Q_OBJECT
public:
        virtual ~Probe()
        {
        }
        virtual bool isValid() const = 0;
        virtual void addXml(QDomNode& dataNode) = 0;
        virtual void parseXml(QDomNode& dataNode) = 0;

        virtual QStringList getConfigIdList() const = 0;
        virtual QString getConfigName(QString uid) = 0;
        virtual QString getConfigId() const = 0;
        virtual QString getConfigurationPath() const = 0;

        virtual void removeCurrentConfig() = 0; 
        virtual void saveCurrentConfig(QString uid, QString name) = 0; 

        virtual void applyNewConfigurationWithId(QString uid) = 0;
        virtual void setTemporalCalibration(double val) = 0;
        virtual void setSoundSpeedCompensationFactor(double val) = 0;
        virtual void setProbeDefinition(ProbeDefinition probeDefinition) = 0;
        virtual void setRTSource(VideoSourcePtr source) = 0;
        virtual void removeRTSource(VideoSourcePtr source) = 0;

        virtual void setActiveStream(QString uid) = 0;
        virtual QString getActiveStream() const = 0;

        virtual QStringList getAvailableVideoSources() = 0; 
        virtual VideoSourcePtr getRTSource(QString uid = "active") const = 0; 
        virtual ProbeDefinition getProbeDefinition(QString uid = "active") const = 0; 
        virtual ProbeSectorPtr getSector(QString uid = "active") = 0; 

signals:
        void sectorChanged();
        void activeConfigChanged();
        void videoSourceAdded(VideoSourcePtr source);
};

typedef boost::shared_ptr<Probe> ProbePtr;
typedef boost::weak_ptr<Probe> ProbeWeakPtr;

}//namespace cx

#endif /* CXPROBE_H_ */