IStructuredLogSettings2.h#

// SPDX-FileCopyrightText: Copyright (c) 2023-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
#pragma once

#include "StructuredLogCommon.h"
#include "IStructuredLogSettings.h"

#include "../core/IObject.h"

namespace omni
{
namespace structuredlog
{

class IStructuredLogSettings2;

using OutputFlags = uint32_t;

constexpr OutputFlags fOutputFlagNone = 0;

constexpr OutputFlags fOutputFlagPayloadOnly = 0x00000001;

constexpr OutputFlags fOutputFlagSkipLogHeaders = 0x00000002;

constexpr OutputFlags fOutputFlagEmitCloudHeartbeat = 0x00000004;

// ****************************** IStructuredLogSettings2 interface *******************************
class IStructuredLogSettings2_abi
    : public omni::core::Inherits<omni::structuredlog::IStructuredLogSettings_abi,
                                  OMNI_TYPE_ID("omni.structuredlog.IStructuredLogSettings2")>
{
protected:
    virtual uint64_t getHeartbeatPeriod_abi() noexcept = 0;

    virtual void setHeartbeatPeriod_abi(uint64_t period) noexcept = 0;

    virtual bool getNeedLogHeaders_abi() noexcept = 0;

    virtual void setNeedLogHeaders_abi(bool needHeaders) noexcept = 0;

    virtual OutputFlags getOutputFlags_abi() noexcept = 0;

    virtual void setOutputFlags_abi(OutputFlags flagsToAdd, OutputFlags flagsToRemove) noexcept = 0;
};

} // namespace structuredlog
} // namespace omni

#define OMNI_BIND_INCLUDE_INTERFACE_DECL
#include "IStructuredLogSettings2.gen.h"

// insert custom API functions here.
class omni::structuredlog::IStructuredLogSettings2
    : public omni::core::Generated<omni::structuredlog::IStructuredLogSettings2_abi>
{
};

#define OMNI_BIND_INCLUDE_INTERFACE_IMPL
#include "IStructuredLogSettings2.gen.h"