All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nodeDiscoveryResult.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 NDR_NODEDISCOVERYRESULT_H
26 #define NDR_NODEDISCOVERYRESULT_H
27 
28 #include "pxr/usd/ndr/declare.h"
29 
30 PXR_NAMESPACE_OPEN_SCOPE
31 
38  const NdrVersion& version,
39  const std::string& name,
40  const TfToken& family,
41  const TfToken& discoveryType,
42  const TfToken& sourceType,
43  const std::string& uri,
44  const std::string& resolvedUri,
45  const std::string &sourceCode=std::string(),
46  const NdrTokenMap &metadata=NdrTokenMap(),
47  const std::string& blindData = std::string()
48  ) : identifier(identifier),
49  version(version),
50  name(name),
51  family(family),
52  discoveryType(discoveryType),
53  sourceType(sourceType),
54  uri(uri),
55  resolvedUri(resolvedUri),
59  { }
60 
68 
72  NdrVersion version;
73 
80  std::string name;
81 
88 
96 
103 
108  std::string uri;
109 
116  std::string resolvedUri;
117 
122  std::string sourceCode;
123 
130  NdrTokenMap metadata;
131 
135  std::string blindData;
136 };
137 
138 typedef std::vector<NdrNodeDiscoveryResult> NdrNodeDiscoveryResultVec;
139 
140 PXR_NAMESPACE_CLOSE_SCOPE
141 
142 #endif // NDR_NODEDISCOVERYRESULT_H
std::string name
The node&#39;s name.
std::string uri
The node&#39;s origin.
NdrVersion version
The node&#39;s version.
NdrTokenMap metadata
The node&#39;s metadata collected during the discovery process.
NdrNodeDiscoveryResult(const NdrIdentifier &identifier, const NdrVersion &version, const std::string &name, const TfToken &family, const TfToken &discoveryType, const TfToken &sourceType, const std::string &uri, const std::string &resolvedUri, const std::string &sourceCode=std::string(), const NdrTokenMap &metadata=NdrTokenMap(), const std::string &blindData=std::string())
Constructor.
std::string blindData
An optional detail for the parser plugin.
std::string sourceCode
The node&#39;s entire source code.
std::string resolvedUri
The node&#39;s fully-resolved URI.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
TfToken sourceType
The node&#39;s source type.
Represents the raw data of a node, and some other bits of metadata, that were determined via a NdrDis...
TfToken family
The node&#39;s family.
TfToken discoveryType
The node&#39;s discovery type.
NdrIdentifier identifier
The node&#39;s identifier.