cxProbe.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/


#ifndef CXPROBE_H_
#define CXPROBE_H_

#include "cxResourceExport.h"

#include <QObject>
#include <boost/weak_ptr.hpp>
#include "cxProbeData.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 setProbeSector(ProbeDefinition probeSector) = 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 getProbeData(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_ */