Ignition Physics

API Reference

CanWriteExpectedData< Derived, Specification > Class Template Reference

#include <CanWriteData.hh>

Public Member Functions

 CanWriteExpectedData ()
template<typename CompositeType >
void WriteExpectedData (CompositeType &_data, const WriteOptions &_options=WriteOptions()) const

Detailed Description

template<typename Derived, typename Specification>
class ignition::physics::CanWriteExpectedData< Derived, Specification >

This class is the same as CanWriteRequiredData, except it operates on all "expected" data (which is a superset of "required" data) instead of only the "required" data.

Constructor & Destructor Documentation

◆ CanWriteExpectedData()

The ability to compile this constructor ensures that an inherited class has functions that can write each of the data types expected by the Specification.

Member Function Documentation

◆ WriteExpectedData()

void WriteExpectedData ( CompositeType &  _data,
const WriteOptions _options = WriteOptions() 
) const

Call this function to write all the types in _data that are listed as expected in the Specification. Setting _onlyWriteUnqueriedData to true will make it so that only data entries that have not been queried will be passed to the Write(~) function. If _onlyWriteUnqueriedData is false, then all data that the Specification lists as expected will be written.

[out]_dataCompositeData instance to write to.
[in]_optionsWriteOptions for customizing the write operation.

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