HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ObjectHeader.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2011,
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_ObjectHeader_h_
38 #define _Alembic_AbcCoreAbstract_ObjectHeader_h_
39 
42 
43 namespace Alembic {
44 namespace AbcCoreAbstract {
45 namespace ALEMBIC_VERSION_NS {
46 
47 //-*****************************************************************************
48 //! The ObjectHeader is a collection of MetaData which helps define a
49 //! Property. It also acts as a key for getting an instance of a property
50 //! from a CompoundProperty.
52 {
53 public:
54  //! Default constructor creates an unspecified object header.
55  //! ...
57  : m_name()
58  , m_fullName()
59  , m_metaData() {}
60 
61  //! Explicit constructor, ignoring full name.
62  //! ...
63  ObjectHeader( const std::string &iName,
64  const MetaData &iMetaData )
65  : m_name( iName )
66  , m_fullName( "" )
67  , m_metaData( iMetaData ) {}
68 
69  //! Explicit constructor with full name.
70  //! ...
71  ObjectHeader( const std::string &iName,
72  const std::string &iFullName,
73  const MetaData &iMetaData )
74  : m_name( iName )
75  , m_fullName( iFullName )
76  , m_metaData( iMetaData ) {}
77 
78  //! Default Copy constructor
79  //! Default Assignment operator
80 
81  //! All objects have a name, which is unique amongst its siblings.
82  //! ...
83  const std::string &getName() const { return m_name; }
84  void setName ( const std::string &iName ) { m_name = iName; }
85 
86  //! All objects have a full name, which is unique in the whole file.
87  //! ...
88  const std::string &getFullName() const { return m_fullName; }
89  void setFullName( const std::string &iFullName ) { m_fullName = iFullName; }
90 
91  //! All objects have metadata.
92  //! It is manipulated directly.
93  const MetaData &getMetaData() const { return m_metaData; }
94  MetaData &getMetaData() { return m_metaData; }
95 
96 private:
97  std::string m_name;
98  std::string m_fullName;
99  MetaData m_metaData;
100 };
101 
102 } // End namespace ALEMBIC_VERSION_NS
103 
104 using namespace ALEMBIC_VERSION_NS;
105 
106 } // End namespace AbcCoreAbstract
107 } // End namespace Alembic
108 
109 #endif
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
ObjectHeader(const std::string &iName, const MetaData &iMetaData)
Definition: ObjectHeader.h:63
ObjectHeader(const std::string &iName, const std::string &iFullName, const MetaData &iMetaData)
Definition: ObjectHeader.h:71
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104