node.h

Go to the documentation of this file.

//
// Copyright 2018 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache 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