HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
declarePtrs.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_BASE_TF_DECLARE_PTRS_H
25 #define PXR_BASE_TF_DECLARE_PTRS_H
26 
27 /// \file tf/declarePtrs.h
28 /// Standard pointer typedefs.
29 ///
30 /// This file provides typedefs for standard pointer types.
31 
32 #include "pxr/pxr.h"
33 #include "pxr/base/tf/weakPtr.h"
34 #include "pxr/base/tf/refPtr.h"
35 
36 #include <vector>
37 
39 
40 /// \struct TfDeclarePtrs
41 /// Templated struct used for type definition macros.
42 template<typename T> struct TfDeclarePtrs {
45  typedef std::vector< Ptr > PtrVector;
46  typedef std::vector< ConstPtr > ConstPtrVector;
47 
50  typedef std::vector< RefPtr > RefPtrVector;
51  typedef std::vector< ConstRefPtr > ConstRefPtrVector;
52 };
53 
54 /// Define standard weak pointer types.
55 ///
56 /// \param type is a class name.
57 ///
58 /// \c TF_DECLARE_WEAK_PTRS(Class) declares ClassPtr, ClassConstPtr,
59 /// ClassPtrVector and ClassConstPtrVector.
60 ///
61 /// \hideinitializer
62 #define TF_DECLARE_WEAK_PTRS(type) \
63  typedef TfDeclarePtrs< class type >::Ptr type##Ptr; \
64  typedef TfDeclarePtrs< class type >::ConstPtr type##ConstPtr; \
65  typedef TfDeclarePtrs< class type >::PtrVector type##PtrVector; \
66  typedef TfDeclarePtrs< class type >::ConstPtrVector type##ConstPtrVector
67 
68 /// Define standard ref pointer types.
69 ///
70 /// \param type is a class name.
71 ///
72 /// \c TF_DECLARE_REF_PTRS(Class) declares ClassRefPtr and ClassConstRefPtr.
73 ///
74 /// \hideinitializer
75 #define TF_DECLARE_REF_PTRS(type) \
76  typedef TfDeclarePtrs< class type >::RefPtr type##RefPtr; \
77  typedef TfDeclarePtrs< class type >::ConstRefPtr type##ConstRefPtr; \
78  typedef TfDeclarePtrs< class type >::RefPtrVector type##RefPtrVector; \
79  typedef TfDeclarePtrs< class type >::ConstRefPtrVector type##ConstRefPtrVector
80 
81 /// Define standard weak, ref, and vector pointer types.
82 ///
83 /// \param type is a class name.
84 ///
85 /// \c TF_DECLARE_WEAK_AND_REF_PTRS(Class) declares ClassPtr, ClassConstPtr,
86 /// ClassPtrVector, ClassConstPtrVector, ClassRefPtr and ClassConstRefPtr.
87 ///
88 /// \hideinitializer
89 #define TF_DECLARE_WEAK_AND_REF_PTRS(type) \
90  TF_DECLARE_WEAK_PTRS(type); \
91  TF_DECLARE_REF_PTRS(type)
92 
94 
95 #endif
std::vector< Ptr > PtrVector
Definition: declarePtrs.h:45
TfWeakPtr< const T > ConstPtr
Definition: declarePtrs.h:44
TfRefPtr< T > RefPtr
Definition: declarePtrs.h:48
std::vector< RefPtr > RefPtrVector
Definition: declarePtrs.h:50
std::vector< ConstPtr > ConstPtrVector
Definition: declarePtrs.h:46
TfRefPtr< const T > ConstRefPtr
Definition: declarePtrs.h:49
std::vector< ConstRefPtr > ConstRefPtrVector
Definition: declarePtrs.h:51
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
TfWeakPtr< T > Ptr
Definition: declarePtrs.h:43