OArchive.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_Abc_OArchive_h
#define Alembic_Abc_OArchive_h
 
#include <Alembic/Util/Export.h>
#include <Alembic/Abc/Foundation.h>
#include <Alembic/Abc/Base.h>
#include <Alembic/Abc/Argument.h>
 
namespace Alembic {
namespace Abc {
namespace ALEMBIC_VERSION_NS {
 
class OObject;
 
//-*****************************************************************************
class ALEMBIC_EXPORT OArchive : public Base
{
public:
    typedef OArchive this_type;
 
    //-*************************************************************************
    // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
    //-*************************************************************************

    OArchive() {}

    template <class ARCHIVE_CTOR>
    OArchive(
        ARCHIVE_CTOR iCtor,

        const std::string &iFileName,

        const Argument &iArg0 = Argument(),

        const Argument &iArg1 = Argument() );

    OArchive(

        AbcA::ArchiveWriterPtr iPtr,

        ErrorHandler::Policy iPolicy = ErrorHandler::kThrowPolicy )
      : m_archive( iPtr )
    {
        // Set the error handling policy.
        getErrorHandler().setPolicy( iPolicy );
    }
 
    // Deprecated in favor of the constructor above
    OArchive(
        AbcA::ArchiveWriterPtr iPtr,
        WrapExistingFlag /* iWrap */,
        ErrorHandler::Policy iPolicy = ErrorHandler::kThrowPolicy )
      : m_archive( iPtr )
    {
        // Set the error handling policy.
        getErrorHandler().setPolicy( iPolicy );
    }

    ~OArchive();

 
    //-*************************************************************************
    // ARCHIVE WRITER FUNCTIONALITY
    //-*************************************************************************

    std::string getName() const;

    OObject getTop();

    int8_t getCompressionHint() const;

    void setCompressionHint( int8_t iCh );

    uint32_t addTimeSampling( const AbcA::TimeSampling & iTs );

    AbcA::TimeSamplingPtr getTimeSampling( uint32_t iIndex );

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

    AbcA::ArchiveWriterPtr getPtr() { return m_archive; }

    void reset() { m_archive.reset(); Base::reset(); }

    bool valid() const
    {
        return ( Base::valid() && m_archive );
    }

    ALEMBIC_OPERATOR_BOOL( valid() );
 
private:
    AbcA::ArchiveWriterPtr m_archive;
};
 
//-*****************************************************************************
inline AbcA::ArchiveWriterPtr GetArchiveWriterPtr( OArchive &iArch )
{
    return iArch.getPtr();
}
 
//-*****************************************************************************
//-*****************************************************************************
template <class ARCHIVE_CTOR>
OArchive::OArchive( ARCHIVE_CTOR iCtor,
                    const std::string &iFileName,
                    const Argument &iArg0,
                    const Argument &iArg1 )
{
    // Create arguments
    Arguments args( ErrorHandler::kThrowPolicy );
    iArg0.setInto( args );
    iArg1.setInto( args );
 
    // Set the error handling policy.
    getErrorHandler().setPolicy( args.getErrorHandlerPolicy() );
 
    ALEMBIC_ABC_SAFE_CALL_BEGIN( "OArchive::OArchive( iFileName )" );
 
    m_archive = iCtor( iFileName, args.getMetaData() );
 
    ALEMBIC_ABC_SAFE_CALL_END_RESET();
}
 
} // End namespace ALEMBIC_VERSION_NS
 
using namespace ALEMBIC_VERSION_NS;
 
} // End namespace Abc
} // End namespace Alembic
 
#endif