node.h

Go to the documentation of this file.

//
// Copyright 2018 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_NDR_NODE_H
#define PXR_USD_NDR_NODE_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/ndr/api.h"
#include "pxr/base/tf/token.h"
#include "pxr/usd/ndr/declare.h"
#include "pxr/usd/ndr/nodeDiscoveryResult.h"
#include "pxr/usd/ndr/property.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class NdrNode
{
public:
    NDR_API
    NdrNode(const NdrIdentifier& identifier,
            const NdrVersion& version,
            const std::string& name,
            const TfToken& family,
            const TfToken& context,
            const TfToken& sourceType,
            const std::string& definitionURI,
            const std::string& implementationURI,
            NdrPropertyUniquePtrVec&& properties,
            const NdrTokenMap& metadata = NdrTokenMap(),
            const std::string &sourceCode = std::string());
 
    NDR_API
    virtual ~NdrNode();
 
 
    const NdrIdentifier& GetIdentifier() const { return _identifier; }
 
    NdrVersion GetVersion() const { return _version; }
 
    const std::string& GetName() const { return _name; }
 
    const TfToken& GetFamily() const { return _family; }
 
    const TfToken& GetContext() const { return _context; }
 
    const TfToken& GetSourceType() const { return _sourceType; }
 
    const std::string& GetResolvedDefinitionURI() const { return _definitionURI; }
 
    const std::string& GetResolvedImplementationURI() const { return _implementationURI; }
 
    const std::string &GetSourceCode() const { return _sourceCode; }
 
    NDR_API
    virtual bool IsValid() const { return _isValid; }
 
    NDR_API
    virtual std::string GetInfoString() const;
 
 
 
 
    NDR_API
    const NdrTokenVec& GetInputNames() const;
 
    NDR_API
    const NdrTokenVec& GetOutputNames() const;
 
    NDR_API
    NdrPropertyConstPtr GetInput(const TfToken& inputName) const;
 
    NDR_API
    NdrPropertyConstPtr GetOutput(const TfToken& outputName) const;
 
 
 
 
    NDR_API
    const NdrTokenMap& GetMetadata() const;
 
 
protected:
    NdrNode& operator=(const NdrNode&) = delete;
 
    bool _isValid;
    NdrIdentifier _identifier;
    NdrVersion _version;
    std::string _name;
    TfToken _family;
    TfToken _context;
    TfToken _sourceType;
    std::string _definitionURI;
    std::string _implementationURI;
    NdrPropertyUniquePtrVec _properties;
    NdrTokenMap _metadata;
    std::string _sourceCode;
 
    NdrPropertyPtrMap _inputs;
    NdrTokenVec _inputNames;
    NdrPropertyPtrMap _outputs;
    NdrTokenVec _outputNames;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_NDR_NODE_H