mitkNavigationDataSet.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 MITKNAVIGATIONDATASET_H_HEADER_INCLUDED_
#define MITKNAVIGATIONDATASET_H_HEADER_INCLUDED_

#include <MitkIGTBaseExports.h>
#include "mitkBaseData.h"
#include "mitkNavigationData.h"

namespace mitk {
  class MITKIGTBASE_EXPORT NavigationDataSet : public BaseData
  {
  public:

    typedef std::vector< std::vector<mitk::NavigationData::Pointer> >::iterator NavigationDataSetIterator;

    typedef std::vector< std::vector<mitk::NavigationData::Pointer> >::const_iterator NavigationDataSetConstIterator;

    mitkClassMacro(NavigationDataSet, BaseData);

    mitkNewMacro1Param(Self, unsigned int);

    bool AddNavigationDatas( std::vector<mitk::NavigationData::Pointer> navigationDatas );

    NavigationData::Pointer GetNavigationDataForIndex( unsigned int index, unsigned int toolIndex ) const;

    //* \brief Get last mitk::Navigation object for given tool whose timestamp is less than the given timestamp.
    //* @param toolIndex Index of the tool from which mitk::NavigationData should be returned.
    //* @param timestamp Timestamp for selecting last object before.
    //* @return Last mitk::NavigationData with timestamp less than given timestamp, 0 if there is no adequate object.
    //*/
    // Method not yet supported!
    //NavigationData::Pointer GetNavigationDataBeforeTimestamp( mitk::NavigationData::TimeStampType timestamp , unsigned int toolIndex ) const;

    virtual std::vector< mitk::NavigationData::Pointer > GetDataStreamForTool(unsigned int toolIndex);

    virtual std::vector< mitk::NavigationData::Pointer > GetTimeStep(unsigned int index) const;

    unsigned int GetNumberOfTools() const;

    unsigned int Size() const;

    virtual NavigationDataSetConstIterator Begin() const;

    virtual NavigationDataSetConstIterator End() const;

    // virtual methods, that need to be implemented, but aren't reasonable for NavigationData
    virtual void SetRequestedRegionToLargestPossibleRegion( ) override;
    virtual bool RequestedRegionIsOutsideOfTheBufferedRegion( ) override;
    virtual bool VerifyRequestedRegion( ) override;
    virtual void SetRequestedRegion( const itk::DataObject *data ) override;

    virtual bool IsEmpty() const override;

  protected:
    NavigationDataSet( unsigned int numTools );
    virtual ~NavigationDataSet( );

    std::vector<std::vector<NavigationData::Pointer> > m_NavigationDataVectors;

    unsigned int m_NumberOfTools;
  };
}

#endif // MITKNAVIGATIONDATASET_H_HEADER_INCLUDED_