Compute Graph Framework SDK Reference  5.16
MetadataHelper.hpp
Go to the documentation of this file.
1
2// This code contains NVIDIA Confidential Information and is disclosed
3// under the Mutual Non-Disclosure Agreement.
4//
5// Notice
6// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
7// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
8// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
9// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
10//
11// NVIDIA Corporation assumes no responsibility for the consequences of use of such
12// information or for any infringement of patents or other rights of third parties that may
13// result from its use. No license is granted by implication or otherwise under any patent
14// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
15// expressly authorized by NVIDIA. Details are subject to change without notice.
16// This code supersedes and replaces all information previously supplied.
17// NVIDIA Corporation products are not authorized for use as critical
18// components in life support devices or systems without express written approval of
19// NVIDIA Corporation.
20//
21// Copyright (c) 2022-2023 NVIDIA Corporation. All rights reserved.
22//
23// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
24// rights in and to this software and related documentation and any modifications thereto.
25// Any use, reproduction, disclosure or distribution of this software and related
26// documentation without an express license agreement from NVIDIA Corporation is
27// strictly prohibited.
28//
30
31#ifndef DW_FRAMEWORK_METADATAHELPER_HPP_
32#define DW_FRAMEWORK_METADATAHELPER_HPP_
33
35
36#include <dwshared/dwfoundation/dw/core/language/Optional.hpp>
37
38namespace dw
39{
40namespace framework
41{
42
45
46// Sequence number helper functions
47void setSequenceNumber(ChannelMetadata& header, uint32_t const& sequenceNum);
48dw::core::Optional<uint32_t> getSequenceNumber(ChannelMetadata const& header);
49
50// Validity helper functions
51void setValidityStatus(ChannelMetadata& header, dwValidityStatus const& status);
52dw::core::Optional<dwValidityStatus> getValidityStatus(ChannelMetadata const& header);
53
54// Timestamp helper functions
55void setTimestamp(ChannelMetadata& header, dwTime_t const& timestamp);
56// coverity[autosar_cpp14_a2_10_5_violation] RFD Pending: TID-2053
57dw::core::Optional<dwTime_t> getTimestamp(ChannelMetadata const& header);
58
59} // namespace framework
60} // namespace dw
61
62#endif // DW_FRAMEWORK_METADATAHELPER_HPP_
MetadataPayload * extractMetadata(GenericData packet)
bool checkHeaderValidFlag(ChannelMetadata const &header, MetadataFlags flag)
dw::core::Optional< uint32_t > getSequenceNumber(ChannelMetadata const &header)
dw::core::Optional< dwTime_t > getTimestamp(ChannelMetadata const &header)
void setTimestamp(ChannelMetadata &header, dwTime_t const &timestamp)
dw::core::Optional< dwValidityStatus > getValidityStatus(ChannelMetadata const &header)
void setSequenceNumber(ChannelMetadata &header, uint32_t const &sequenceNum)
void setValidityStatus(ChannelMetadata &header, dwValidityStatus const &status)
Definition: Buffer.hpp:40