Usd Notice Framework  0.7.0
transaction.h
Go to the documentation of this file.
1 #ifndef USD_NOTICE_FRAMEWORK_TRANSACTION_H
2 #define USD_NOTICE_FRAMEWORK_TRANSACTION_H
3 
5 
6 #include "unf/api.h"
7 #include "unf/broker.h"
8 #include "unf/capturePredicate.h"
9 
10 #include <pxr/pxr.h>
11 #include <pxr/usd/usd/common.h>
12 
13 namespace unf {
14 
21 class NoticeTransaction {
22  public:
33  UNF_API NoticeTransaction(
34  const BrokerPtr &,
35  CapturePredicate predicate = CapturePredicate::Default());
36 
48  UNF_API NoticeTransaction(const BrokerPtr &, const CapturePredicateFunc &);
49 
58  UNF_API NoticeTransaction(
59  const PXR_NS::UsdStageRefPtr &,
60  CapturePredicate predicate = CapturePredicate::Default());
61 
69 
70  UNF_API NoticeTransaction(
71  const PXR_NS::UsdStageRefPtr &, const CapturePredicateFunc &);
72 
74  UNF_API virtual ~NoticeTransaction();
75 
77  UNF_API NoticeTransaction(const NoticeTransaction &) = delete;
78 
80  UNF_API NoticeTransaction &operator=(const NoticeTransaction &) = delete;
81 
83  UNF_API BrokerPtr GetBroker() { return _broker; }
84 
85  private:
87  BrokerPtr _broker;
88 };
89 
90 } // namespace unf
91 
92 #endif // USD_NOTICE_FRAMEWORK_TRANSACTION_H
unf::CapturePredicate
Predicate functor which indicates whether a notice can be captured during a transaction.
Definition: capturePredicate.h:29
unf::CapturePredicate::Default
static UNF_API CapturePredicate Default()
Create a predicate which return true for each notice type.
unf::NoticeTransaction
Convenient RAII object to consolidate and filter notices derived from UnfNotice::StageNotice within a...
Definition: transaction.h:21
unf::NoticeTransaction::NoticeTransaction
UNF_API NoticeTransaction(const PXR_NS::UsdStageRefPtr &, CapturePredicate predicate=CapturePredicate::Default())
Create transaction from a UsdStage.
unf::NoticeTransaction::GetBroker
UNF_API BrokerPtr GetBroker()
Return associated Broker instance.
Definition: transaction.h:83
unf::NoticeTransaction::NoticeTransaction
UNF_API NoticeTransaction(const BrokerPtr &, const CapturePredicateFunc &)
Create transaction from a Broker with a capture predicate function.
unf::NoticeTransaction::NoticeTransaction
UNF_API NoticeTransaction(const PXR_NS::UsdStageRefPtr &, const CapturePredicateFunc &)
Create transaction from a UsdStage with a capture predicate function.
unf::NoticeTransaction::NoticeTransaction
UNF_API NoticeTransaction(const NoticeTransaction &)=delete
Remove default copy constructor.
unf::NoticeTransaction::operator=
UNF_API NoticeTransaction & operator=(const NoticeTransaction &)=delete
Remove default assignment operator.
unf::NoticeTransaction::NoticeTransaction
UNF_API NoticeTransaction(const BrokerPtr &, CapturePredicate predicate=CapturePredicate::Default())
Create transaction from a Broker.
unf::NoticeTransaction::~NoticeTransaction
virtual UNF_API ~NoticeTransaction()
Delete object and end transaction.
unf::CapturePredicateFunc
std::function< bool(const UnfNotice::StageNotice &)> CapturePredicateFunc
Convenient alias for function defining whether notice can be captured.
Definition: capturePredicate.h:16