HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ReadArraySampleCache.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_ReadArraySampleCache_h_
38 #define _Alembic_AbcCoreAbstract_ReadArraySampleCache_h_
39 
40 #include <Alembic/Util/Export.h>
43 
44 namespace Alembic {
45 namespace AbcCoreAbstract {
46 namespace ALEMBIC_VERSION_NS {
47 
48 //-*****************************************************************************
49 //! A ReadArraySampleID is a bundle that contains a pointer to the
50 //! \ref ArraySample itself, along with the sample's key.
52 {
53 public:
54  //! By convention, we define the typedef this_type. This
55  //! is used by the unspecified-bool-type cast below.
57 
58  //! Default constructor creates empty ID
59  //! ...
61 
62  //! Explicit constructor creates ID with key and sample
63  ReadArraySampleID( const ArraySample::Key &iSampleKey,
64  ArraySamplePtr iSample )
65  : m_sampleKey( iSampleKey ),
66  m_sample( iSample ) {}
67 
68  //! Default copy constructor
69  //! Default assignment operator.
70 
71  //! Return the sample key
72  //! ...
73  const ArraySample::Key &getKey() const
74  { return m_sampleKey; }
75 
76  //! Return the sample itself.
77  //! ...
79  { return m_sample; }
80 
81  //! Return whether or not this read sample is valid
82  //! ...
83  bool valid() const
84  {
85  return ( m_sample && m_sample->valid() );
86  }
87 
88  //! Unspecified bool type cast
89  //! ...
91 
92 private:
93  ArraySample::Key m_sampleKey;
94  ArraySamplePtr m_sample;
95 };
96 
97 
98 //-*****************************************************************************
99 //-*****************************************************************************
100 //-*****************************************************************************
101 // READ ARRAY SAMPLE CACHE
102 //-*****************************************************************************
103 //-*****************************************************************************
104 //-*****************************************************************************
105 
106 //-*****************************************************************************
107 //! Alembic caches array samples based on a Murmur3 128bit checksum key.
108 //! This is an abstract interface to these caches, which can be implemented
109 //! in any number of ways.
112  , public Alembic::Util::enable_shared_from_this<ReadArraySampleCache>
113 {
114 public:
115  //! Virtual destructor
116  //! ...
117  virtual ~ReadArraySampleCache();
118 
119  //! If it finds the entry, return a valid pointer to it which
120  //! is expected to lock the entry in the cache until the pointer
121  //! is dereferenced.
122  virtual ReadArraySampleID find( const ArraySample::Key &iKey ) = 0;
123 
124  //! Store an entry given an explicit set of storage.
125  //! The magnificent flexibility of the shared_ptr class makes
126  //! it possible for an ArraySamplePtr to contain its own destructor
127  //! as a custom deleter, and thus we can use ArraySamplePtrs for
128  //! both reference and ownership, depending on the deleter.
129  //! In this case, it is assumed that iSamp represents
130  //! "owned" data, rather than a reference. The data will not
131  //! be copied, but rather this sample will be stored directly
132  //! using the passed shared_ptr.
133  virtual ReadArraySampleID store( const ArraySample::Key &iKey,
134  ArraySamplePtr iSamp ) = 0;
135 };
136 
137 //-*****************************************************************************
138 typedef Alembic::Util::shared_ptr<ReadArraySampleCache> ReadArraySampleCachePtr;
139 
140 } // End namespace ALEMBIC_VERSION_NS
141 
142 using namespace ALEMBIC_VERSION_NS;
143 
144 } // End namespace AbcCoreAbstract
145 } // End namespace Alembic
146 
147 #endif
Alembic::Util::shared_ptr< ArraySample > ArraySamplePtr
Definition: ArraySample.h:138
Alembic::Util::shared_ptr< ReadArraySampleCache > ReadArraySampleCachePtr
ReadArraySampleID(const ArraySample::Key &iSampleKey, ArraySamplePtr iSample)
Explicit constructor creates ID with key and sample.
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104