Alembic: AbcCoreAbstract/ReadArraySampleCache.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
ReadArraySampleCache.h
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>
41#include <Alembic/AbcCoreAbstract/Foundation.h>
42#include <Alembic/AbcCoreAbstract/ArraySample.h>
43
44namespace Alembic {
45namespace AbcCoreAbstract {
46namespace ALEMBIC_VERSION_NS {
47
48//-*****************************************************************************
51 class ReadArraySampleID
52{
53public:
56 typedef ReadArraySampleID this_type;
57
60 ReadArraySampleID() {}
61
63 ReadArraySampleID( const ArraySample::Key &iSampleKey,
64 ArraySamplePtr iSample )
65 : m_sampleKey( iSampleKey ),
66 m_sample( iSample ) {}
67
70
73 const ArraySample::Key &getKey() const
74 { return m_sampleKey; }
75
78 ArraySamplePtr getSample() const
79 { return m_sample; }
80
83 bool valid() const
84 {
85 return ( m_sample && m_sample->valid() );
86 }
87
90 ALEMBIC_OPERATOR_BOOL( valid() );
91
92private:
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//-*****************************************************************************
110 class ALEMBIC_EXPORT ReadArraySampleCache
111 : private Alembic::Util::noncopyable
112 , public Alembic::Util::enable_shared_from_this<ReadArraySampleCache>
113{
114public:
117 virtual ~ReadArraySampleCache();
118
122 virtual ReadArraySampleID find( const ArraySample::Key &iKey ) = 0;
123
133 virtual ReadArraySampleID store( const ArraySample::Key &iKey,
134 ArraySamplePtr iSamp ) = 0;
135};
136
137//-*****************************************************************************
138typedef Alembic::Util::shared_ptr<ReadArraySampleCache> ReadArraySampleCachePtr;
139
140} // End namespace ALEMBIC_VERSION_NS
141
142using namespace ALEMBIC_VERSION_NS;
143
144} // End namespace AbcCoreAbstract
145} // End namespace Alembic
146
147#endif
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleCache
Definition ReadArraySampleCache.h:113
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleCache::find
virtual ReadArraySampleID find(const ArraySample::Key &iKey)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleCache::store
virtual ReadArraySampleID store(const ArraySample::Key &iKey, ArraySamplePtr iSamp)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID
Definition ReadArraySampleCache.h:52
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::this_type
ReadArraySampleID this_type
Definition ReadArraySampleCache.h:56
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::ReadArraySampleID
ReadArraySampleID()
Definition ReadArraySampleCache.h:60
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::getSample
ArraySamplePtr getSample() const
Definition ReadArraySampleCache.h:78
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::ALEMBIC_OPERATOR_BOOL
ALEMBIC_OPERATOR_BOOL(valid())
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::ReadArraySampleID
ReadArraySampleID(const ArraySample::Key &iSampleKey, ArraySamplePtr iSample)
Explicit constructor creates ID with key and sample.
Definition ReadArraySampleCache.h:63
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::valid
bool valid() const
Definition ReadArraySampleCache.h:83
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::getKey
const ArraySample::Key & getKey() const
Definition ReadArraySampleCache.h:73
Alembic::Util::ALEMBIC_VERSION_NS::noncopyable
Definition Foundation.h:98
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39