Ignition Physics

API Reference

2.3.0
CompositeData::InsertResult< Data > Struct Template Reference

This struct is the return type of the various Insert...<T>() functions. It returns a reference to the data entry for the Data type, and it indicates whether the insertion operation actually occurred. More...

#include <CompositeData.hh>

Public Member Functions

InsertResultoperator= (const InsertResult &)=delete
 

Public Attributes

Data & data
 A reference to the Data entry within the CompositeData object. More...
 
const bool inserted
 True if the operation resulted in inserting a new data entry. More...
 

Detailed Description

template<typename Data>
struct ignition::physics::CompositeData::InsertResult< Data >

This struct is the return type of the various Insert...<T>() functions. It returns a reference to the data entry for the Data type, and it indicates whether the insertion operation actually occurred.

Member Function Documentation

◆ operator=()

InsertResult& operator= ( const InsertResult< Data > &  )
delete

Member Data Documentation

◆ data

Data& data

A reference to the Data entry within the CompositeData object.

◆ inserted

const bool inserted

True if the operation resulted in inserting a new data entry.

For Insert<Data>(), false means that nothing was inserted.

For InsertOrAssign<Data>(), false means that the Data entry which used to be in the CompositeData has been assigned the new value.


The documentation for this struct was generated from the following file: