cxTrackingImplService.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 CXTRACKINGIMPLSERVICE_H_
#define CXTRACKINGIMPLSERVICE_H_

#include "org_custusx_core_tracking_Export.h"
#include "cxTrackingService.h"
#include "vtkForwardDeclarations.h"
#include "cxServiceTrackerListener.h"

class QDomNode;
class QDomElement;
class QDomDocument;
class QDomNodeList;
class QTimer;
class QFileInfo;

class ctkPluginContext;

namespace cx
{
typedef boost::shared_ptr<class TrackingImplService> TrackingImplServicePtr;

typedef boost::shared_ptr<class ManualToolAdapter> ManualToolAdapterPtr;
typedef boost::shared_ptr<class PlaybackTime> PlaybackTimePtr;

typedef boost::shared_ptr<class TrackingSystemService> TrackingSystemServicePtr;
typedef boost::shared_ptr<class TrackingSystemPlaybackService> TrackingSystemPlaybackServicePtr;
typedef boost::shared_ptr<class SessionStorageService> SessionStorageServicePtr;

class org_custusx_core_tracking_EXPORT TrackingImplService: public TrackingService
{
Q_OBJECT
Q_INTERFACES(cx::TrackingService)

public:
        TrackingImplService(ctkPluginContext* context);
        virtual ~TrackingImplService();

        virtual Tool::State getState() const;
        virtual void setState(const Tool::State val);

        virtual bool isPlaybackMode() const;

        virtual ToolMap getTools(); 
        virtual ToolPtr getTool(const QString& uid); 

        virtual ToolPtr getActiveTool();
        virtual void setActiveTool(const QString& uid); 

        virtual ToolPtr getReferenceTool() const; 

        virtual ToolPtr getManualTool(); 

        virtual SessionToolHistoryMap getSessionHistory(double startTime, double stopTime);

        virtual void runDummyTool(DummyToolPtr tool);
        virtual ToolPtr getFirstProbe();

        virtual void setPlaybackMode(PlaybackTimePtr controller);
        virtual TrackerConfigurationPtr getConfiguration();

        virtual void installTrackingSystem(TrackingSystemServicePtr system);
        virtual void unInstallTrackingSystem(TrackingSystemServicePtr system);
        virtual std::vector<TrackingSystemServicePtr> getTrackingSystems();

        bool isNull();

private slots:
        void globalConfigurationFileChangedSlot(QString key);
        void onSystemStateChanged();
        void activeCheckSlot(); 
        void onTooltipOffset(double val);

        void onSessionChanged();
        void onSessionCleared();
        void onSessionLoad(QDomElement& node);
        void onSessionSave(QDomElement& node);

private:
    void listenForTrackingSystemServices(ctkPluginContext *context);
    void onTrackingSystemAdded(TrackingSystemService* service);
    void onTrackingSystemRemoved(TrackingSystemService* service);
    void onTrackingSystemModified(TrackingSystemService* service);


        void rebuildCachedTools();
        void initializeManualTool();
        void setConfigurationFile(QString configurationFile); 
        void resetTrackingPositionFilters();
        void waitForState(Tool::State state, int timeout);
        void imbueManualToolWithRealProperties();
        void addToolsFrom(TrackingSystemServicePtr system);
        bool manualToolHasMostRecentTimestamp();
        std::vector<ToolPtr> getVisibleTools();

        void addXml(QDomNode& parentNode); 
        void parseXml(QDomNode& dataNode); 
        virtual void savePositionHistory();
        virtual void loadPositionHistory();

        QString getLoggingFolder();

        ToolMap mTools; 
        ToolPtr mActiveTool; 
        ToolPtr mReferenceTool; 
        ManualToolAdapterPtr mManualTool; 

        double mLastLoadPositionHistory;

        std::vector<TrackingSystemServicePtr> mTrackingSystems;
        TrackingSystemPlaybackServicePtr mPlaybackSystem;
        ctkPluginContext *mContext;
        SessionStorageServicePtr mSession;

        double mToolTipOffset; 

    boost::shared_ptr<ServiceTrackerListener<TrackingSystemService> > mServiceListener;
};

bool toolTypeSort(const ToolPtr tool1, const ToolPtr tool2); 

} //namespace cx


#endif /* CXTRACKINGIMPLSERVICE_H_ */