ObjectReader.h

//-*****************************************************************************
//
// Copyright (c) 2009-2013,
//  Sony Pictures Imageworks Inc. and
//  Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// *       Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// *       Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// *       Neither the name of Sony Pictures Imageworks, nor
// Industrial Light & Magic, nor the names of their contributors may be used
// to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//-*****************************************************************************
 
#ifndef Alembic_AbcCoreAbstract_ObjectReader_h
#define Alembic_AbcCoreAbstract_ObjectReader_h
 
#include <Alembic/Util/Export.h>
#include <Alembic/AbcCoreAbstract/Foundation.h>
#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
#include <Alembic/AbcCoreAbstract/ObjectHeader.h>
 
namespace Alembic {
namespace AbcCoreAbstract {
namespace ALEMBIC_VERSION_NS {
 
//-*****************************************************************************
class ALEMBIC_EXPORT ObjectReader
    : private Alembic::Util::noncopyable
{
public:
    virtual ~ObjectReader();
 
    //-*************************************************************************
    // NEW FUNCTIONS
    //-*************************************************************************

    virtual const ObjectHeader &getHeader() const = 0;

    const std::string &getName() const
    { return getHeader().getName(); }

    const std::string &getFullName() const
    { return getHeader().getFullName(); }

    const MetaData &getMetaData() const
    { return getHeader().getMetaData(); }

    virtual ArchiveReaderPtr getArchive() = 0;

    virtual ObjectReaderPtr getParent() = 0;

    virtual CompoundPropertyReaderPtr getProperties() = 0;
 
    //-*************************************************************************
    // Children!
    //-*************************************************************************

    virtual size_t getNumChildren() = 0;

    virtual const ObjectHeader & getChildHeader( size_t i ) = 0;

    virtual const ObjectHeader *
    getChildHeader( const std::string &iName ) = 0;

    virtual ObjectReaderPtr getChild( const std::string &iName ) = 0;

    virtual ObjectReaderPtr getChild( size_t i ) = 0;
 
    //-*************************************************************************
    // Hierarchical hash stuff
    //-*************************************************************************

    virtual bool getPropertiesHash( Util::Digest & oDigest );

    virtual bool getChildrenHash( Util::Digest & oDigest );
 
    //-*************************************************************************
    // YUP
    //-*************************************************************************

    virtual ObjectReaderPtr asObjectPtr() = 0;
};
 
} // End namespace ALEMBIC_VERSION_NS
 
using namespace ALEMBIC_VERSION_NS;
 
} // End namespace AbcCoreAbstract
} // End namespace Alembic
 
#endif