Ignition Physics

API Reference

2.0.0

ReadOptions provides customization for the ReadRequiredData and ReadExpectedData functions provided by CanReadRequiredData and CanReadExpectedData. More...

#include <CanReadData.hh>

Public Member Functions

 ReadOptions (const bool _onlyUnqueried=true)
 Default constructor. More...
 

Public Attributes

bool onlyReadUnqueriedData
 If a type has already been queried, do not perform the read operation on it. More...
 

Detailed Description

ReadOptions provides customization for the ReadRequiredData and ReadExpectedData functions provided by CanReadRequiredData and CanReadExpectedData.

See also
CanReadExpectedData::ReadExpectedData()
CanReadRequiredData::ReadRequiredData()

Constructor & Destructor Documentation

◆ ReadOptions()

ReadOptions ( const bool  _onlyUnqueried = true)
explicit

Default constructor.

Parameters
[in]_onlyUnqueriedWhether only unqueried data will be read, default to true.

Member Data Documentation

◆ onlyReadUnqueriedData

bool onlyReadUnqueriedData

If a type has already been queried, do not perform the read operation on it.


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