// Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
// --------- Warning: This is a build system generated file. ----------
//

//! @file
//!
//! @brief This file was generated by <i>omni.bind</i>.

#include <omni/core/Interface.h>
#include <omni/core/OmniAttr.h>
#include <omni/core/ResultError.h>

#include <functional>
#include <type_traits>
#include <utility>

#ifndef OMNI_BIND_INCLUDE_INTERFACE_IMPL


//! Base class for object inspection requests.
template <>
class omni::core::Generated<omni::inspect::IInspector_abi> : public omni::inspect::IInspector_abi
{
public:
    OMNI_PLUGIN_INTERFACE("omni::inspect::IInspector")

    /** Set the help information for the current invocation of the inspector. For when behavior == eHelp
     * @param[in] helpString The help information, describing the configuration of the inspector
     */
    void setHelp(const char* helpString) noexcept;

    /** Returns the help information currently available on the inspector. Note that this could change
     * from one invocation to the next so it's important to read it immediately after requesting it.
     * @returns String containing the help information describing the current configuration of the inspector
     */
    const char* helpInformation() noexcept;

    /** Returns the common flag used to tell the inspection process to put the help information into the
     * inspector using the setHelp_abi function. Using this approach avoids having every inspector/object
     * combination add an extra ABI function just for retrieving the help information, as well as providing a
     * consistent method for requesting it.
     * @returns String containing the name of the common flag used for help information
     */
    const char* helpFlag() noexcept;

    /** Enable or disable an inspection flag. It's up to the individual inspection operations or the derived
     * inspector interfaces to interpret the flag.
     * @param[in] flagName Name of the flag to set
     * @param[in] flagState New state for the flag
     */
    void setFlag(const char* flagName, bool flagState) noexcept;

    /** Checks whether a particular flag is currently set or not.
     * @param[in] flagName Name of the flag to check
     * @returns True if the named flag is set, false if not
     */
    bool isFlagSet(const char* flagName) noexcept;
};

#endif

#ifndef OMNI_BIND_INCLUDE_INTERFACE_DECL

inline void omni::core::Generated<omni::inspect::IInspector_abi>::setHelp(const char* helpString) noexcept
{
    setHelp_abi(helpString);
}

inline const char* omni::core::Generated<omni::inspect::IInspector_abi>::helpInformation() noexcept
{
    return helpInformation_abi();
}

inline const char* omni::core::Generated<omni::inspect::IInspector_abi>::helpFlag() noexcept
{
    return helpFlag_abi();
}

inline void omni::core::Generated<omni::inspect::IInspector_abi>::setFlag(const char* flagName, bool flagState) noexcept
{
    setFlag_abi(flagName, flagState);
}

inline bool omni::core::Generated<omni::inspect::IInspector_abi>::isFlagSet(const char* flagName) noexcept
{
    return isFlagSet_abi(flagName);
}

#endif

#undef OMNI_BIND_INCLUDE_INTERFACE_DECL
#undef OMNI_BIND_INCLUDE_INTERFACE_IMPL
