PropertyHeader.h

//-*****************************************************************************
//
// 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_AbcCoreAbstract_PropertyHeader_h
#define Alembic_AbcCoreAbstract_PropertyHeader_h
 
#include <Alembic/AbcCoreAbstract/Foundation.h>
#include <Alembic/AbcCoreAbstract/MetaData.h>
#include <Alembic/AbcCoreAbstract/DataType.h>
#include <Alembic/AbcCoreAbstract/TimeSampling.h>
 
namespace Alembic {
namespace AbcCoreAbstract {
namespace ALEMBIC_VERSION_NS {
 
//-*****************************************************************************
enum PropertyType
{

    kCompoundProperty = 0,

    kScalarProperty = 1,

    kArrayProperty = 2
};
 
//-*****************************************************************************
class PropertyHeader
{
public:
    PropertyHeader()
      : m_name(),
        m_propertyType( kScalarProperty ),
        m_metaData(),
        m_dataType(),
        m_timeSampling() {}

    explicit PropertyHeader( const std::string &iName,
                             const MetaData &iMetaData )
      : m_name( iName ),
        m_propertyType( kCompoundProperty ),
        m_metaData( iMetaData ),
        m_dataType(),
        m_timeSampling() {}

    PropertyHeader( const std::string &iName,
                    PropertyType iPropType,
                    const MetaData &iMetaData,
                    const DataType &iDataType,
                    const TimeSamplingPtr & iTsamp )
      : m_name( iName ),
        m_propertyType( iPropType ),
        m_metaData( iMetaData ),
        m_dataType( iDataType ),
        m_timeSampling( iTsamp ) {}

    PropertyHeader( const PropertyHeader &iCopy )
      : m_name( iCopy.m_name ),
        m_propertyType( iCopy.m_propertyType ),
        m_metaData( iCopy.m_metaData ),
        m_dataType( iCopy.m_dataType ),
        m_timeSampling( iCopy.m_timeSampling ) {}

    PropertyHeader& operator=( const PropertyHeader &iCopy )
    {
        m_name = iCopy.m_name;
        m_propertyType = iCopy.m_propertyType;
        m_metaData = iCopy.m_metaData;
        m_dataType = iCopy.m_dataType;
        m_timeSampling = iCopy.m_timeSampling;
        return *this;
    }

    const std::string &getName() const { return m_name; }
    
    void setName( const std::string &iName ) { m_name = iName; }

    PropertyType getPropertyType() const { return m_propertyType; }
    
    void setPropertyType( PropertyType iPtyp ) { m_propertyType = iPtyp; }

    bool isScalar() const { return m_propertyType == kScalarProperty; }

    bool isArray() const { return m_propertyType == kArrayProperty; }

    bool isCompound() const { return m_propertyType == kCompoundProperty; }

    bool isSimple() const { return !isCompound(); }

    const MetaData &getMetaData() const { return m_metaData; }
    
    void setMetaData( const MetaData &iMetaData ) { m_metaData = iMetaData; }

    const DataType &getDataType() const { return m_dataType; }
    
    void setDataType( const DataType &iDataType ) { m_dataType = iDataType; }

    TimeSamplingPtr getTimeSampling() const
    { return m_timeSampling; }
    
    void setTimeSampling( const TimeSamplingPtr &iTsamp )
    { m_timeSampling = iTsamp; }
 
private:
    std::string m_name;
    PropertyType m_propertyType;
    MetaData m_metaData;
    DataType m_dataType;
    TimeSamplingPtr m_timeSampling;
};
 
} // End namespace ALEMBIC_VERSION_NS
 
using namespace ALEMBIC_VERSION_NS;
 
} // End namespace AbcCoreAbstract
} // End namespace Alembic
 
#endif