attributeDef.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.11-windows/ufe/include/attributeDef.h"
#ifndef _ufe_attributeDef
#define _ufe_attributeDef
 
// =======================================================================
// Copyright 2022 Autodesk, Inc. All rights reserved.
//
// This computer source code and related instructions and comments are the
// unpublished confidential  and proprietary information of Autodesk, Inc.
// and are protected under applicable copyright and trade secret law. They 
// may not be disclosed to, copied  or used by any third party without the 
// prior written consent of Autodesk, Inc.
// =======================================================================
 
#include "common/ufeExport.h"
#include "value.h"
 
#include <memory>
#include <string>
 
UFE_NS_DEF {
 
class UFE_SDK_DECL AttributeDef
{
public:
    typedef std::shared_ptr<const AttributeDef> ConstPtr;
    enum IOType { INPUT_ATTR, OUTPUT_ATTR };
 
    virtual ~AttributeDef();
 
    virtual std::string name() const = 0;
 
    virtual std::string type() const = 0;
 
    virtual std::string defaultValue() const = 0;
 
    virtual IOType ioType() const = 0;
 
    virtual Value getMetadata(const std::string& key) const = 0;
 
    virtual bool hasMetadata(const std::string& key) const = 0;
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    static constexpr char kNativeType[] = "NativeType";
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
}; // end class AttributeDef
 
} // end namespace
 
#endif /* _ufe_attributeDef */