HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyModuleNotice.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_PY_MODULE_NOTICE_H
25 #define PXR_BASE_TF_PY_MODULE_NOTICE_H
26 
27 #include "pxr/pxr.h"
28 
29 #include "pxr/base/tf/api.h"
30 #include "pxr/base/tf/notice.h"
31 
32 #include <string>
33 
35 
36 /// \class TfPyModuleWasLoaded
37 ///
38 /// A \a TfNotice that is sent when a script module is loaded. Since many
39 /// modules may be loaded at once, listeners are encouraged to defer work
40 /// triggered by this notice to the end of an application iteration. This, of
41 /// course, is good practice in general.
42 ///
43 class TfPyModuleWasLoaded : public TfNotice {
44 public:
45  explicit TfPyModuleWasLoaded(std::string const &name) : _name(name) {}
46 
47  TF_API
48  virtual ~TfPyModuleWasLoaded();
49 
50  /// Return the name of the module that was loaded.
51  std::string const &GetName() { return _name; }
52 
53 private:
54  std::string _name;
55 };
56 
58 
59 #endif // PXR_BASE_TF_PY_MODULE_NOTICE_H
GLuint const GLchar * name
Definition: glew.h:1814
#define TF_API
Definition: api.h:40
std::string const & GetName()
Return the name of the module that was loaded.
virtual TF_API ~TfPyModuleWasLoaded()
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
TfPyModuleWasLoaded(std::string const &name)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91