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 PXR_USD_NDR_NODE_DISCOVERY_RESULT_H
26 #define PXR_USD_NDR_NODE_DISCOVERY_RESULT_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  const TfToken& subIdentifier=TfToken(),
49  const NdrTokenVec& aliases=NdrTokenVec()
52  name(name),
53  family(family),
56  uri(uri),
63  { }
64 
72 
76  NdrVersion version;
77 
84  std::string name;
85 
92 
100 
107 
112  std::string uri;
113 
120  std::string resolvedUri;
121 
126  std::string sourceCode;
127 
134  NdrTokenMap metadata;
135 
139  std::string blindData;
140 
149 
155  NdrTokenVec aliases;
156 };
157 
158 typedef std::vector<NdrNodeDiscoveryResult> NdrNodeDiscoveryResultVec;
159 
160 PXR_NAMESPACE_CLOSE_SCOPE
161 
162 #endif // PXR_USD_NDR_NODE_DISCOVERY_RESULT_H
std::string name
The node's name.
std::string uri
The node's origin.
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(), const TfToken &subIdentifier=TfToken(), const NdrTokenVec &aliases=NdrTokenVec())
Constructor.
NdrVersion version
The node's version.
NdrTokenMap metadata
The node's metadata collected during the discovery process.
std::string blindData
An optional detail for the parser plugin.
std::string sourceCode
The node's entire source code.
std::string resolvedUri
The node's fully-resolved URI.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
NdrTokenVec aliases
A list of aliases that can be used when looking up the node by identifier in the NdrRegistry.
TfToken sourceType
The node'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's family.
TfToken discoveryType
The node's discovery type.
NdrIdentifier identifier
The node's identifier.
TfToken subIdentifier
The subIdentifier is associated with a particular asset and refers to a specific definition within th...