OpaqueConvertions.hpp

Go to the documentation of this file.

/* Generated from orogen/lib/orogen/templates/typekit/OpaqueConvertions.hpp */

#ifndef __OROGEN_GENERATED_<%= typekit.name %>_OPAQUE_CONVERTIONS_HH
#define __OROGEN_GENERATED_<%= typekit.name %>_OPAQUE_CONVERTIONS_HH

#include <boost/cstdint.hpp>
#include <<%= typekit.name %>/Types.hpp>
<% if typekit.has_opaques_with_templates? %>
#include <<%= typekit.name %>/Opaques.hpp>
<% end %>

namespace orogen_typekits
{
<%
type_sets.opaque_types.find_all { |op| !op.generate_templates? }.each do |opaque_def|
    from = opaque_def.type
    into = typekit.intermediate_type_for(from)

    if opaque_def.needs_copy? %>
    void toIntermediate(<%= into.ref_type %> intermediate, <%= from.arg_type %> real_type);
    void fromIntermediate(<%= from.ref_type %> real_type, <%= into.arg_type %> intermediate);
    <%
    else
    %>
    <%= into.arg_type %> toIntermediate(<%= from.arg_type %> real_type);
    bool fromIntermediate(<%= from.ref_type %> real_type, <%= into.cxx_name %>* intermediate);
    <%
    end
end
%>

<%
# Types that do not need copies require the intermediate to be a non-const
# pointer. In case only a const-pointer is available, it is needed to create a
# copy first, and then assign it to the real type (usually, a smart pointer).
#
# This generates the overloaded from_intermediate function that does just that.
type_sets.opaque_types.find_all { |opdef| !opdef.needs_copy? }.each do |opdef|
    type = opdef.type
    intermediate_type = typekit.intermediate_type_for(type)
%>
    void fromIntermediate(<%= type.ref_type %> value, <%= intermediate_type.arg_type %> _intermediate);
<% end %>

<%
# This handles the types that contain opaques, but are not opaque themselves. For those,
# orogen generates so-called m-types, that are a mapping from the original (opaque-containing)
# type into a one where opaque fields have been converted to their intermediate counterparts
type_sets.types.
    find_all { |t| t.contains_opaques? && !t.opaque? }.
    each do |type|
        m_type = typekit.intermediate_type_for(type)
        if !m_type
            raise RuntimeError, "no intermediate marshalling type for #{type.name}"
        end
%>
    void toIntermediate(<%= m_type.ref_type %> intermediate, <%= type.arg_type %> value<%= ", int length" if type < Typelib::ArrayType %>);
    void fromIntermediate(<%= type.ref_type %> value<%= ", int length" if type < Typelib::ArrayType %>, <%= m_type.arg_type %> intermediate);
<% end %>
}

#endif