ITK  4.6.0
Insight Segmentation and Registration Toolkit
itkTemporalDataObject.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef __itkTemporalDataObject_h
19 #define __itkTemporalDataObject_h
20 
21 #include "itkDataObject.h"
22 #include "itkRingBuffer.h"
23 #include "itkTemporalRegion.h"
24 
25 namespace itk
26 {
27 
42 {
43 public:
44 
51 
54 
57 
58  itkNewMacro(Self);
59 
61  itkTypeMacro(TemporalDataObject, DataObject);
62 
64  virtual TemporalUnitType GetTemporalUnit() const;
65 
67  virtual void SetTemporalUnitToFrame();
68  virtual void SetTemporalUnitToRealTime();
69  virtual void SetTemporalUnitToFrameAndRealTime();
71 
76 
78  const TemporalRegionType & region);
80 
81  virtual void SetBufferedTemporalRegion(const TemporalRegionType & region);
82  virtual const TemporalRegionType & GetBufferedTemporalRegion() const;
83  virtual void SetRequestedTemporalRegion(const TemporalRegionType & region);
84  virtual const TemporalRegionType & GetRequestedTemporalRegion() const;
85 
89 
90  virtual void SetRequestedRegionToLargestPossibleRegion() ITK_OVERRIDE;
91 
92  virtual bool RequestedRegionIsOutsideOfTheBufferedRegion() ITK_OVERRIDE;
93 
94  virtual bool VerifyRequestedRegion() ITK_OVERRIDE;
95 
96  virtual void CopyInformation(const DataObject *) ITK_OVERRIDE;
97 
98  virtual void SetRequestedRegion(const DataObject *) ITK_OVERRIDE;
99 
100  virtual void Graft(const DataObject *) ITK_OVERRIDE;
101 
102 protected:
103 
105  virtual ~TemporalDataObject();
106  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
107 
110 
115 
117 
118 private:
119 
120  TemporalDataObject(const Self &); //purposely not implemented
121  void operator=(const Self &); //purposely not implemented
122 
123 }; // end class TemporalDataObject
124 
125 } // end namespace itk
126 
127 #endif
TemporalRegionType m_LargestPossibleTemporalRegion
virtual TemporalUnitType GetTemporalUnit() const
SizeValueType GetNumberOfBuffers()
virtual void CopyInformation(const DataObject *) ITK_OVERRIDE
virtual const TemporalRegionType & GetLargestPossibleTemporalRegion() const
virtual const TemporalRegionType GetUnbufferedRequestedTemporalRegion()
SmartPointer< Self > Pointer
virtual void SetTemporalUnitToFrame()
virtual void PrintSelf(std::ostream &os, Indent indent) const ITK_OVERRIDE
virtual void SetRequestedTemporalRegion(const TemporalRegionType &region)
virtual void SetRequestedRegion(const DataObject *) ITK_OVERRIDE
virtual const TemporalRegionType & GetRequestedTemporalRegion() const
Implements a weak reference to an object.
unsigned long SizeValueType
Definition: itkIntTypes.h:143
TemporalRegionType m_BufferedTemporalRegion
virtual void SetTemporalUnitToRealTime()
virtual void SetLargestPossibleTemporalRegion(const TemporalRegionType &region)
Region subclass that holds a region in time.
virtual void SetRequestedRegionToLargestPossibleRegion() ITK_OVERRIDE
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion() ITK_OVERRIDE
virtual void Graft(const DataObject *) ITK_OVERRIDE
RingBuffer< DataObject > BufferType
void SetNumberOfBuffers(SizeValueType num)
TemporalRegionType m_RequestedTemporalRegion
virtual const TemporalRegionType & GetBufferedTemporalRegion() const
Control indentation during Print() invocation.
Definition: itkIndent.h:49
DataObject subclass with knowledge of temporal region.
virtual void SetTemporalUnitToFrameAndRealTime()
WeakPointer< const Self > ConstWeakPointer
BufferType::Pointer m_DataObjectBuffer
virtual bool VerifyRequestedRegion() ITK_OVERRIDE
Templated ring buffer for holding anything.
Definition: itkRingBuffer.h:39
SmartPointer< const Self > ConstPointer
Base class for all data objects in ITK.
virtual void SetBufferedTemporalRegion(const TemporalRegionType &region)