HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TimeSampling.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2012,
4 // Sony Pictures Imageworks, Inc. and
5 // Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
6 //
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are
11 // met:
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above
15 // copyright notice, this list of conditions and the following disclaimer
16 // in the documentation and/or other materials provided with the
17 // distribution.
18 // * Neither the name of Sony Pictures Imageworks, nor
19 // Industrial Light & Magic nor the names of their contributors may be used
20 // to endorse or promote products derived from this software without specific
21 // prior written permission.
22 //
23 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 //
35 //-*****************************************************************************
36 
37 #ifndef Alembic_AbcCoreAbstract_TimeSampling_h
38 #define Alembic_AbcCoreAbstract_TimeSampling_h
39 
40 #include <Alembic/Util/Export.h>
44 
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48 
49 
50 //-*****************************************************************************
51 //! The TimeSampling class's whole job is to report information about the
52 //! time values that are associated with the samples that were written
53 //! to a property. Most of the time, the sampling will be uniform or
54 //! cyclic, in which case this is mostly an algorithmic interface to
55 //! the small sample times buffer. In the case where the sampling is
56 //! truly acyclic, this class acts as an accessor to that array of times.
58 {
59 public:
60  //! The TimeSampling class is really a portable interface, usable
61  //! via aggregation, that the SimplePropertyReaders and Writers (and
62  //! their derived classes) can use to provide consistent time-sampling
63  //! introspection to clients.
64  TimeSampling( const TimeSamplingType & iTimeSamplingType,
65 
66  //! The number of time samples per cycle
67  const std::vector < chrono_t > & iSampleTimes );
68 
69  //! Convenience constructor which creates uniform time sampling with
70  //! the specified time per cycle and the specified start time.
71  TimeSampling( chrono_t iTimePerCycle, chrono_t iStartTime );
72 
73  TimeSampling( const TimeSampling &copy );
74 
75  TimeSampling();
76 
77  bool operator==( const TimeSampling & iRhs ) const
78  {
79  return (m_timeSamplingType == iRhs.m_timeSamplingType &&
80  m_sampleTimes == iRhs.m_sampleTimes);
81  }
82 
83  //! Get the number of stored times.
84  //! This is same as the samples per cycle in the time sampling type except
85  //! for acyclic time sampling. There will always be at least one sample
86  //! because a start time is always needed.
87  size_t getNumStoredTimes() const
88  {
89  return m_sampleTimes.size();
90  }
91 
92  const std::vector < chrono_t > & getStoredTimes() const
93  {
94  return m_sampleTimes;
95  }
96 
98  {
99  return m_timeSamplingType;
100  }
101 
102  //! Get the time of any sample
103  //! it is invalid to call this for out-of-range indices.
104  chrono_t getSampleTime( index_t iIndex ) const;
105 
106  //! Find the largest valid index that has a time less than or equal
107  //! to the given time. Invalid to call this with zero samples.
108  //! If the minimum sample time is greater than iTime, index
109  //! 0 will be returned.
110  std::pair<index_t, chrono_t> getFloorIndex( chrono_t iTime,
111  index_t iNumSamples ) const;
112 
113  //! Find the smallest valid index that has a time greater
114  //! than the given time. Invalid to call this with zero samples.
115  //! If the maximum sample time is less than iTime, index
116  //! numSamples-1 will be returned.
117  std::pair<index_t, chrono_t> getCeilIndex( chrono_t iTime,
118  index_t iNumSamples ) const;
119 
120  //! Find the valid index with the closest time to the given
121  //! time. Invalid to call this with zero samples.
122  std::pair<index_t, chrono_t> getNearIndex( chrono_t iTime,
123  index_t iNumSamples ) const;
124 
125 protected:
126  //! A TimeSamplingType
127  //! This is "Uniform", "Cyclic", or "Acyclic".
129 
130  std::vector < chrono_t > m_sampleTimes;
131 
132 private:
133  // sanity checks the data coming in
134  void init();
135 };
136 
137 typedef Alembic::Util::shared_ptr<TimeSampling> TimeSamplingPtr;
138 
139 } // End namespace ALEMBIC_VERSION_NS
140 
141 using namespace ALEMBIC_VERSION_NS;
142 
143 } // End namespace AbcCoreAbstract
144 } // End namespace Alembic
145 
146 #endif
147 
bool operator==(const TimeSampling &iRhs) const
Definition: TimeSampling.h:77
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
const std::vector< chrono_t > & getStoredTimes() const
Definition: TimeSampling.h:92
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105