QGoDBTrackManager.h

Go to the documentation of this file.

/*=========================================================================
 Authors: The GoFigure Dev. Team.
 at Megason Lab, Systems biology, Harvard Medical school, 2009-11

 Copyright (c) 2009-11, President and Fellows of Harvard College.
 All rights reserved.

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

 Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 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.
 Neither the name of the  President and Fellows of Harvard College
 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 OWNER 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 __QGoDBTrackManager_h
#define __QGoDBTrackManager_h

#include "QGoTableWidget.h"
#include "GoDBCollectionOfTraces.h"
#include "GoDBTWContainerForTrack.h"
#include "QGoDBTraceManager.h"
#include "QGoGUILibConfigure.h"
#include "TrackContainer.h"
#include "GoDBTrackFamilyRow.h"

class TrackStructure;

class QGOGUILIB_EXPORT QGoDBTrackManager:public QGoDBTraceManager
{
  Q_OBJECT
public:
  QGoDBTrackManager(int iImgSessionID, QWidget *iparent);
  ~QGoDBTrackManager();

  virtual void DisplayInfoForLastCreatedTrace(vtkMySQLDatabase *iDatabaseConnector);

  virtual void DisplayInfoForExistingTrace(vtkMySQLDatabase *iDatabaseConnector,
                                           int iTraceID);

  void SetTracksInfoContainerForVisu(TrackContainer *iContainerForVisu);

  void DisplayInfoAndLoadVisuContainerForAllTracks(
    vtkMySQLDatabase *iDatabaseConnector);

  void LoadInfoVisuContainerForTrackFamilies(vtkMySQLDatabase *iDatabaseConnector);

  void DisplayOnlyCalculatedValuesForExistingTrack(
    GoFigureTrackAttributes *iTrackAttributes, unsigned int iTrackID);

  unsigned int CreateNewTrackWithNoMesh(
    vtkMySQLDatabase *iDatabaseConnector);

  //virtual pure method in QGoDBTraceManager
  std::list< unsigned int > UpdateTheTracesColor(vtkMySQLDatabase *iDatabaseConnector);

  //virtual pure method in QGoDBTraceManager
  virtual void UpdateTWAndContainerForImportedTraces(
    const std::vector< int > & iVectorImportedTraces,
    vtkMySQLDatabase *iDatabaseConnector);

  void DeleteListTraces(vtkMySQLDatabase *iDatabaseConnector,
    const std::list<unsigned int> & iListTraces);

  //virtual pure method in QGoDBTraceManager
  virtual void DeleteCheckedTraces( vtkMySQLDatabase *iDatabaseConnector);


   //virtual pure method in QGoDBTraceManager
  virtual std::list< unsigned int > GetListHighlightedIDs();

  void UpdateCurrentElementTrackContainer();

  void UpdatePointsOfCurrentElementForImportedTrack(
    std::map<unsigned int,double*> iMeshesInfo,
    vtkMySQLDatabase* iDatabaseConnector);

  //method in QGoDBTraceManager
  void UpdateBoundingBoxes(
    vtkMySQLDatabase *iDatabaseConnector,
    const std::list< unsigned int > & iListTracesIDs);

  std::string CheckMeshCanBeAddedToTrack( vtkMySQLDatabase* iDatabaseConnector,
                                          unsigned int iTrackID,
                                          unsigned int iMeshTimePoint,
                                          std::list<unsigned int> &ioMotherTrackDivisionToUpdate);

  void UpdateDivisions(const std::list<unsigned int> & iListMotherTrackIDs);

  void AddVolume(const unsigned int& iTrackID, const double& iVolume);

  void AddVolumes(const std::list< std::pair<unsigned int, double> > & iVolumes);

  void RemoveVolumes(const std::list< std::pair<unsigned int, double> > & iVolumes);

  void AddVolumes(const std::list< std::pair<unsigned int, double> > & iVolumes,
                  unsigned int iTrackID);

  void RemoveVolumes(const std::list< std::pair<unsigned int, double> > & iVolumes,
                     unsigned int iTrackID);

  std::vector<unsigned int> GetTrackFamily(vtkMySQLDatabase* iDatabaseConnector,
                                           unsigned int iTrackID);

  bool isMother(vtkMySQLDatabase* iDatabaseConnector, unsigned int iTrackID);

  int CreateTrackFamily(vtkMySQLDatabase* iDatabaseConnector,
                        unsigned int iMotherTrackID,
                        const std::list<unsigned int> & iDaughtersID);

signals:
  void NeedMeshesInfoForImportedTrack(unsigned int iTrackID);
  void TrackToSplit(unsigned int iTrackID, std::list<unsigned int> iListMeshIDs);
  void TrackIDToBeModifiedWithWidget(std::list<unsigned int> iListTracksID);
  void MeshesToAddToTrack(std::list<unsigned int> iListMeshes, unsigned int iTrackID);

  void CheckedTracksToAddToSelectedLineage(std::list<unsigned int> iDaughtersID, unsigned int iLineageID,
    std::list<unsigned> iLineagesToDelete);

  void NewLineageToCreateFromTracks( std::list<unsigned int> iCheckedTracksIDs, unsigned int iTrackIDRoot,
    std::list<unsigned> iLineagesToDelete);

  void NeedToGoToTheRealLocation(double, double, double, int);

public slots:
  void DeleteTheDivisions(std::list<unsigned int> iDivisions = std::list<unsigned int>());

  void CreateCorrespondingTrackFamily(std::list<unsigned int> iDivisions = std::list<unsigned int>());

protected:
  GoDBTWContainerForTrack *m_TWContainer;
  TrackContainer          *m_TrackContainerInfoForVisu;

  //virtual pure method in QGoDBTraceManager
  virtual void SetCollectionsTraceNames();

  //virtual pure method in QGoDBTraceManager
  virtual void DisplayInfoForAllTraces(vtkMySQLDatabase *iDatabaseConnector);

  virtual void DisplayInfoForTracesForSpecificTPs(
    vtkMySQLDatabase *iDatabaseConnector, const std::list<unsigned int> & iListTPs);

  //virtual pure method in QGoDBTraceManager
  virtual void GetTracesInfoFromDBAndModifyContainerForVisu(
    vtkMySQLDatabase* iDatabaseConnector,
    std::list<unsigned int> iListTraceIDs = std::list< unsigned int >());

  void UpdateTrackPolydataForVisu(vtkMySQLDatabase *iDatabaseConnector,unsigned int iTrackID);

  //virtual in QGoDBTraceManager
  void AddActionsContextMenu(QMenu *iMenu);

  void SaveTrackCurrentElement(vtkMySQLDatabase* iDatabaseConnector);

  void SaveTrackStructure(vtkMySQLDatabase* iDatabaseConnector,
      TrackStructure* iStructure);

  bool CheckOverlappingTracks(std::list<unsigned int> iTrackIDs,
    unsigned int &ioTraceIDToKeep, unsigned int &ioTraceIDToDelete,
    vtkMySQLDatabase* iDatabaseConnector);

  void UpdateTrackFamilyIDForDaughter(vtkMySQLDatabase* iDatabaseConnector,
    unsigned int iDaughterID,unsigned int iTrackFamilyID);

  bool IdentifyMotherDaughtersToCreateTrackFamily(
    vtkMySQLDatabase* iDatabaseConnector,
    const std::list<unsigned int> & iListTracksID,
    int &ioMotherID,
    std::list<unsigned int> &ioDaughtersID);

  std::list<unsigned int> GetTrackIDFromDaughtersFamilies( vtkMySQLDatabase* iDatabaseConnector,
    std::list<unsigned int> &ioTrackIDsOfTheFamilies);

  void DeleteOneDivision(GoDBTrackFamilyRow iDivision, vtkMySQLDatabase* iDatabaseConnector,
    std::list<unsigned int> &ioTrackIDsNoLineage, std::list<unsigned int> &ioMotherLineageToDelete);

  void PrintAMessageForTracksWithNoDivision(std::list<unsigned int> iTracksNoDivision);

  void CreateALineageWithFormerDaughterOfADeletedDivision(
    unsigned int iDaughterID, vtkMySQLDatabase* iDatabaseConnector, bool &ioPartOfHigherLineage);

  unsigned int IsTheTrackAMother(unsigned int iDaughterID,
    vtkMySQLDatabase* iDatabaseConnector);

  unsigned int IsTheTrackADaughter(unsigned int iTrackID,
  vtkMySQLDatabase* iDatabaseConnector);

  void UpdateFormerDaughtersOfADeletedDivision(
    std::list<unsigned int> iDaughtersID,
    std::list<unsigned int> &ioTrackIDsNoLineage,
    bool &ioPartOfHigherLineage);

  std::list<unsigned int> GetDivisionIDsTheTrackBelongsTo(
    vtkMySQLDatabase* iDatabaseConnector, unsigned int iTrackID );
  unsigned int CheckBoundingBoxDivisionAsAMother(vtkMySQLDatabase* iDatabaseConnector,
    unsigned int iTimePoint, unsigned int iTrackFamilyID );

  unsigned int CheckBoundingBoxDivisionAsADaughter(vtkMySQLDatabase* iDatabaseConnector,
    unsigned int iTimePoint, unsigned int iTrackFamilyID );

protected slots:

  //virtual pure method in QGoDBTraceManager
  virtual void UpdateHighlightedElementsInVisuContainer(int iTraceID);

  //virtual pure method in QGoDBTraceManager
  virtual void UpdateVisibleElementsInVisuContainer(int iTraceID);


 //virtual pure method in QGoDBTraceManager
  virtual void SetColorCoding(bool IsChecked);

  void SplitMergeTrackWithWidget();

  void TrackIDToEmit();

  void MergeTracks();

  void GoToTrackEnd();
  void GoToTrackBegin();
};
#endif