All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
serialization.h
1 //
2 // Copyright 2018 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 
25 #ifndef TRACE_SERIALIZATION_H
26 #define TRACE_SERIALIZATION_H
27 
28 #include "pxr/pxr.h"
29 #include "pxr/base/trace/api.h"
30 #include "pxr/base/trace/collection.h"
31 
32 #include <istream>
33 #include <ostream>
34 #include <memory>
35 #include <vector>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
45 public:
48  TRACE_API static bool Write(std::ostream& ostr,
49  const std::shared_ptr<TraceCollection>& col);
50 
53  TRACE_API static bool Write(
54  std::ostream& ostr,
55  const std::vector<std::shared_ptr<TraceCollection>>& collections);
56 
61  TRACE_API static std::unique_ptr<TraceCollection> Read(std::istream& istr,
62  std::string* error = nullptr);
63 };
64 
65 PXR_NAMESPACE_CLOSE_SCOPE
66 
67 #endif // TRACE_SERIALIZATION_H
static TRACE_API std::unique_ptr< TraceCollection > Read(std::istream &istr, std::string *error=nullptr)
Tries to create a TraceCollection from the contexts of istr.
This class contains methods to read and write TraceCollection.
Definition: serialization.h:44
static TRACE_API bool Write(std::ostream &ostr, const std::shared_ptr< TraceCollection > &col)
Writes col to ostr.