ISchemaObject.h

Go to the documentation of this file.

//-*****************************************************************************
//
// Copyright (c) 2009-2011,
//  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_Abc_ISchemaObject_h
#define Alembic_Abc_ISchemaObject_h

#include <Alembic/Abc/Foundation.h>
#include <Alembic/Abc/IObject.h>
#include <Alembic/Abc/ISchema.h>
#include <Alembic/Abc/Argument.h>
#include <Alembic/Abc/Base.h>

namespace Alembic {
namespace Abc {
namespace ALEMBIC_VERSION_NS {

//-*****************************************************************************
//! An ISchemaObject is an object with a single schema. This is just
//! a convenience class, really, but it also deals with setting up and
//! validating metadata
template <class SCHEMA>
class ISchemaObject : public IObject
{
public:
    //-*************************************************************************
    // TYPEDEFS AND IDENTIFIERS
    //-*************************************************************************
    typedef SCHEMA schema_type;
    typedef ISchemaObject<SCHEMA> this_type;

    //! Our schema title contains the schema title of the underlying
    //! compound property, along with the default name of that compound
    //! property. So, for example - most AbcGeom types put their
    //! data in ".geom", so, "AbcGeom_PolyMesh_v1:.geom"
    //! Sometimes schema titles from underlying schemas are "", but
    //! ours never are.
    static std::string getSchemaObjTitle()
    {
        return SCHEMA::getSchemaTitle() + std::string( ":" )
            + SCHEMA::getDefaultSchemaName();
    }

    static const char * getSchemaTitle()
    {
        return SCHEMA::getSchemaTitle();
    }

    //! This will check whether or not a given entity (as represented by
    //! a metadata) strictly matches the interpretation of this
    //! schema object
    static bool matches( const AbcA::MetaData &iMetaData,
                         SchemaInterpMatching iMatching = kStrictMatching )
    {

        if ( std::string() == getSchemaTitle() || iMatching == kNoMatching )
        {
            return true;
        }


        if ( iMatching == kStrictMatching )
        {
            return iMetaData.get( "schemaObjTitle" ) == getSchemaObjTitle() ||
                iMetaData.get( "schema" ) == getSchemaObjTitle();
        }

        if ( iMatching == kSchemaTitleMatching )
        {
            return iMetaData.get( "schema" ) == getSchemaTitle();
        }

        return false;
    }

    //! This will check whether or not a given object (as represented by
    //! an object header) strictly matches the interpretation of this
    //! schema object, as well as the data type.
    static bool matches( const AbcA::ObjectHeader &iHeader,
                         SchemaInterpMatching iMatching = kStrictMatching )
    {
        return matches( iHeader.getMetaData(), iMatching );
    }


    //-*************************************************************************
    // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
    //-*************************************************************************

    //! The default constructor creates an empty ISchemaObject function set.
    //! ...
    ISchemaObject() {}

    //! The primary constructor creates an ISchemaObject as a child of iParent
    ISchemaObject( const IObject & iParent,
                   const std::string &iName,
                   const Argument &iArg0 = Argument(),
                   const Argument &iArg1 = Argument() )
    : IObject( iParent, iName, GetErrorHandlerPolicyFromArgs( iArg0, iArg1 ) )
    {
        Arguments args;
        iArg0.setInto( args );
        iArg1.setInto( args );

        ALEMBIC_ABC_SAFE_CALL_BEGIN(
            "ISchemaObject::ISchemaObject( IObject )" );

        const AbcA::ObjectHeader &oheader = this->getHeader();

        ABCA_ASSERT( matches( oheader, args.getSchemaInterpMatching() ),
            "Incorrect match of schema: "
            << oheader.getMetaData().get( "schema" )
            << " to expected: "
            << getSchemaTitle() );

        ABCA_ASSERT(m_object, "Bad child: " << iName);
        // Make the schema.
        m_schema = SCHEMA( m_object->getProperties(),
                           SCHEMA::getDefaultSchemaName(),
                           this->getErrorHandlerPolicy(),
                           args.getSchemaInterpMatching() );

        ALEMBIC_ABC_SAFE_CALL_END_RESET();
    }

    //! Wrap an existing schema object.
    //! ...
    ISchemaObject( const IObject & iObject,
                   const Argument &iArg0 = Argument(),
                   const Argument &iArg1 = Argument() )
    : IObject( iObject )
    {
        getErrorHandler().setPolicy(
            GetErrorHandlerPolicy( iObject, iArg0, iArg1 ) );

        ALEMBIC_ABC_SAFE_CALL_BEGIN(
            "ISchemaObject::ISchemaObject( wrap )" );

        const AbcA::ObjectHeader &oheader = this->getHeader();

        ABCA_ASSERT( matches( oheader.getMetaData(),
                     GetSchemaInterpMatching( iArg0, iArg1 ) ),
                     "Incorrect match of schema: "
                     << oheader.getMetaData().get( "schemaObjTitle" )
                     << " to expected: "
                     << getSchemaObjTitle() );

        m_schema = SCHEMA( this->getProperties(),
                           SCHEMA::getDefaultSchemaName(),
                           this->getErrorHandlerPolicy(),
                           GetSchemaInterpMatching( iArg0, iArg1 ) );

        ALEMBIC_ABC_SAFE_CALL_END_RESET();
    }

    // Deprecated in favor of the constructor above
    ISchemaObject( const IObject & iObject,
                   WrapExistingFlag iFlag,
                   const Argument &iArg0 = Argument(),
                   const Argument &iArg1 = Argument() )
    : IObject( iObject )
    {
        getErrorHandler().setPolicy(
            GetErrorHandlerPolicy( iObject, iArg0, iArg1 ) );

        ALEMBIC_ABC_SAFE_CALL_BEGIN(
            "ISchemaObject::ISchemaObject( wrapflag )" );

        const AbcA::ObjectHeader &oheader = this->getHeader();

        ABCA_ASSERT( matches( oheader.getMetaData(),
                     GetSchemaInterpMatching( iArg0, iArg1 ) ),
                     "Incorrect match of schema: "
                     << oheader.getMetaData().get( "schemaObjTitle" )
                     << " to expected: "
                     << getSchemaObjTitle() );

        m_schema = SCHEMA( this->getProperties(),
                           SCHEMA::getDefaultSchemaName(),
                           this->getErrorHandlerPolicy(),
                           GetSchemaInterpMatching( iArg0, iArg1 ) );

        ALEMBIC_ABC_SAFE_CALL_END_RESET();
    }

    //-*************************************************************************
    // ABC BASE MECHANISMS
    // These functions are used by Abc to deal with errors, rewrapping,
    // and so on.
    //-*************************************************************************

    //! Schemas are not necessarily cheap to copy, so we return by reference
    //! rather than by value.
    SCHEMA &getSchema() { return m_schema; }
    const SCHEMA &getSchema() const { return m_schema; }

    //! Reset returns this function set to an empty, default
    //! state.
    void reset() { m_schema.reset(); IObject::reset(); }

    //! Valid returns whether this function set is
    //! valid.
    bool valid() const
    {
        return ( IObject::valid() && m_schema.valid() );
    }

    //! The unspecified-bool-type operator casts the object to "true"
    //! if it is valid, and "false" otherwise.
    ALEMBIC_OVERRIDE_OPERATOR_BOOL( this_type::valid() );

protected:
    SCHEMA m_schema;
};

//-*****************************************************************************
// TEMPLATE AND INLINE FUNCTIONS
//-*****************************************************************************

inline ErrorHandler::Policy GetErrorHandlerPolicy( const Argument &iArg0,
                                                   const Argument &iArg1 )
{
    Arguments args;
    iArg0.setInto( args );
    iArg1.setInto( args );
    return args.getErrorHandlerPolicy();
}

} // End namespace ALEMBIC_VERSION_NS

using namespace ALEMBIC_VERSION_NS;

} // End namespace Abc
} // End namespace Alembic

#endif