Alembic Version 1.1

ObjectReader.h
Go to the documentation of this file.
1//-*****************************************************************************
2//
3// Copyright (c) 2009-2013,
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_ObjectReader_h
38#define Alembic_AbcCoreAbstract_ObjectReader_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/AbcCoreAbstract/Foundation.h>
42#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
43#include <Alembic/AbcCoreAbstract/ObjectHeader.h>
44
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
55 class ALEMBIC_EXPORT ObjectReader
56 : private Alembic::Util::noncopyable
57{
58 public:
61 virtual ~ObjectReader();
62
63 //-*************************************************************************
64 // NEW FUNCTIONS
65 //-*************************************************************************
66
70 virtual const ObjectHeader &getHeader() const = 0;
71
76 const std::string &getName() const
77 { return getHeader().getName(); }
78
83 const std::string &getFullName() const
84 { return getHeader().getFullName(); }
85
92 const MetaData &getMetaData() const
93 { return getHeader().getMetaData(); }
94
107 virtual ArchiveReaderPtr getArchive() = 0;
108
118 virtual ObjectReaderPtr getParent() = 0;
119
124 virtual CompoundPropertyReaderPtr getProperties() = 0;
125
126 //-*************************************************************************
127 // Children!
128 //-*************************************************************************
129
132 virtual size_t getNumChildren() = 0;
133
136 virtual const ObjectHeader & getChildHeader( size_t i ) = 0;
137
140 virtual const ObjectHeader *
141 getChildHeader( const std::string &iName ) = 0;
142
146 virtual ObjectReaderPtr getChild( const std::string &iName ) = 0;
147
152 virtual ObjectReaderPtr getChild( size_t i ) = 0;
153
154 //-*************************************************************************
155 // Hierarchical hash stuff
156 //-*************************************************************************
157
160 virtual bool getPropertiesHash( Util::Digest & oDigest );
161
164 virtual bool getChildrenHash( Util::Digest & oDigest );
165
166 //-*************************************************************************
167 // YUP
168 //-*************************************************************************
169
172 virtual ObjectReaderPtr asObjectPtr() = 0;
173};
174
175} // End namespace ALEMBIC_VERSION_NS
176
177 using namespace ALEMBIC_VERSION_NS;
178
179} // End namespace AbcCoreAbstract
180} // End namespace Alembic
181
182#endif
183
184
Foundation.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition: Export.h:51
ForwardDeclarations.h
ObjectHeader.h
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::MetaData
Definition: MetaData.h:60
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectHeader
Definition: ObjectHeader.h:52
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader
Definition: ObjectReader.h:57
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getHeader
virtual const ObjectHeader & getHeader() const =0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getFullName
const std::string & getFullName() const
Definition: ObjectReader.h:83
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getName
const std::string & getName() const
Definition: ObjectReader.h:76
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getChild
virtual ObjectReaderPtr getChild(size_t i)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getPropertiesHash
virtual bool getPropertiesHash(Util::Digest &oDigest)
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getChildHeader
virtual const ObjectHeader * getChildHeader(const std::string &iName)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getChildrenHash
virtual bool getChildrenHash(Util::Digest &oDigest)
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getProperties
virtual CompoundPropertyReaderPtr getProperties()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::asObjectPtr
virtual ObjectReaderPtr asObjectPtr()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getParent
virtual ObjectReaderPtr getParent()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getChild
virtual ObjectReaderPtr getChild(const std::string &iName)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getMetaData
const MetaData & getMetaData() const
Definition: ObjectReader.h:92
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getChildHeader
virtual const ObjectHeader & getChildHeader(size_t i)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getArchive
virtual ArchiveReaderPtr getArchive()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::~ObjectReader
virtual ~ObjectReader()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReader::getNumChildren
virtual size_t getNumChildren()=0
Alembic::Util::ALEMBIC_VERSION_NS::noncopyable
Definition: Foundation.h:115
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReaderPtr
Alembic::Util::shared_ptr< ObjectReader > ObjectReaderPtr
Definition: ForwardDeclarations.h:91
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyReaderPtr
Alembic::Util::shared_ptr< CompoundPropertyReader > CompoundPropertyReaderPtr
Definition: ForwardDeclarations.h:92
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReaderPtr
Alembic::Util::shared_ptr< ArchiveReader > ArchiveReaderPtr
Smart Ptrs to Readers.
Definition: ForwardDeclarations.h:90
Alembic
Alembic namespace ...
Definition: ArchiveInfo.h:46
Alembic::Util::ALEMBIC_VERSION_NS::Digest
Definition: Digest.h:51