Skip to content

iceoryx_posh/internal/popo/sample.inl🔗

Namespaces🔗

Name
iox
iox::popo
iox::popo::internal

Defines🔗

Name
IOX_POSH_POPO_SAMPLE_INL

Macro Documentation🔗

define IOX_POSH_POPO_SAMPLE_INL🔗

#define IOX_POSH_POPO_SAMPLE_INL

Source code🔗

// Copyright (c) 2020 by Robert Bosch GmbH. All rights reserved.
// Copyright (c) 2021 by Apex.AI Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0

#ifndef IOX_POSH_POPO_SAMPLE_INL
#define IOX_POSH_POPO_SAMPLE_INL

namespace iox
{
namespace popo
{
namespace internal
{
template <typename T, typename H>
inline SamplePrivateData<T, H>::SamplePrivateData(cxx::unique_ptr<T>&& sampleUniquePtr,
                                                  PublisherInterface<T, H>& publisher) noexcept
    : sampleUniquePtr(std::move(sampleUniquePtr))
    , publisherRef(publisher)
{
}

template <typename T, typename H>
inline SamplePrivateData<const T, H>::SamplePrivateData(cxx::unique_ptr<const T>&& sampleUniquePtr) noexcept
    : sampleUniquePtr(std::move(sampleUniquePtr))
{
}
} // namespace internal

template <typename T, typename H>
template <typename S, typename>
inline Sample<T, H>::Sample(cxx::unique_ptr<T>&& sampleUniquePtr, PublisherInterface<T, H>& publisher) noexcept
    : m_members({std::move(sampleUniquePtr), publisher})
{
}

template <typename T, typename H>
template <typename S, typename>
inline Sample<T, H>::Sample(cxx::unique_ptr<T>&& sampleUniquePtr) noexcept
    : m_members(std::move(sampleUniquePtr))
{
}

template <typename T, typename H>
inline T* Sample<T, H>::operator->() noexcept
{
    return get();
}

template <typename T, typename H>
inline const T* Sample<T, H>::operator->() const noexcept
{
    return get();
}

template <typename T, typename H>
inline T& Sample<T, H>::operator*() noexcept
{
    return *get();
}

template <typename T, typename H>
inline const T& Sample<T, H>::operator*() const noexcept
{
    return *get();
}

template <typename T, typename H>
inline Sample<T, H>::operator bool() const noexcept
{
    return get() != nullptr;
}

template <typename T, typename H>
inline T* Sample<T, H>::get() noexcept
{
    return m_members.sampleUniquePtr.get();
}

template <typename T, typename H>
inline const T* Sample<T, H>::get() const noexcept
{
    return m_members.sampleUniquePtr.get();
}

template <typename T, typename H>
inline typename Sample<T, H>::ConditionalConstChunkHeader_t* Sample<T, H>::getChunkHeader() noexcept
{
    return mepoo::ChunkHeader::fromUserPayload(m_members.sampleUniquePtr.get());
}

template <typename T, typename H>
inline const mepoo::ChunkHeader* Sample<T, H>::getChunkHeader() const noexcept
{
    return mepoo::ChunkHeader::fromUserPayload(m_members.sampleUniquePtr.get());
}

template <typename T, typename H>
template <typename R, typename>
inline R& Sample<T, H>::getUserHeader() noexcept
{
    return *static_cast<R*>(mepoo::ChunkHeader::fromUserPayload(m_members.sampleUniquePtr.get())->userHeader());
}

template <typename T, typename H>
template <typename R, typename>
inline const R& Sample<T, H>::getUserHeader() const noexcept
{
    return const_cast<Sample<T, H>*>(this)->getUserHeader();
}

template <typename T, typename H>
template <typename S, typename>
inline void Sample<T, H>::publish() noexcept
{
    if (m_members.sampleUniquePtr)
    {
        m_members.publisherRef.get().publish(std::move(*this));
    }
    else
    {
        LogError() << "Tried to publish empty Sample! Might be an already published or moved Sample!";
        errorHandler(Error::kPOSH__PUBLISHING_EMPTY_SAMPLE, nullptr, ErrorLevel::MODERATE);
    }
}

template <typename T, typename H>
inline T* Sample<T, H>::release() noexcept
{
    return m_members.sampleUniquePtr.release();
}

} // namespace popo
} // namespace iox

#endif // IOX_POSH_POPO_SAMPLE_INL

Updated on 31 May 2022 at 15:29:16 CEST