ITK  4.3.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 
41 class ITK_EXPORT TemporalDataObject : public DataObject
42 {
43 public:
44 
51 
54 
56  typedef enum {Frame, RealTime, FrameAndRealTime} TemporalUnitType;
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 
73  SizeValueType GetNumberOfBuffers();
74  void SetNumberOfBuffers(SizeValueType num);
76 
77  virtual void SetLargestPossibleTemporalRegion(
78  const TemporalRegionType & region);
79  virtual const TemporalRegionType & GetLargestPossibleTemporalRegion() const;
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 
88  virtual const TemporalRegionType GetUnbufferedRequestedTemporalRegion();
89 
90  virtual void SetRequestedRegionToLargestPossibleRegion();
91 
92  virtual bool RequestedRegionIsOutsideOfTheBufferedRegion();
93 
94  virtual bool VerifyRequestedRegion();
95 
96  virtual void CopyInformation(const DataObject *);
97 
98  virtual void SetRequestedRegion(const DataObject *);
99 
100  virtual void Graft(const DataObject *);
101 
102 protected:
103 
105  virtual ~TemporalDataObject();
106  virtual void PrintSelf(std::ostream & os, Indent indent) const;
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
128