Ignition Physics

API Reference

1.2.0
List of all members | Public Member Functions | Public Attributes
WriteOptions Struct Reference

A struct that defines options for writing data to a CompositeData object. More...

#include <CanWriteData.hh>

Public Member Functions

 WriteOptions (const bool _skipMissing=false, const bool _onlyUnqueried=true)
 Default constructor. More...
 

Public Attributes

bool onlyWriteUnqueriedData
 If a data type has already been queried, do not perform the write operation on it. More...
 
bool skipMissingData
 If a data type is not already part of the CompositeData, then skip it instead of writing to it when this is true. When this is false, create a new instance using the default constructor for any data type that is missing, and then hand it over for writing. More...
 

Detailed Description

A struct that defines options for writing data to a CompositeData object.

See also
CanWriteExpectedData::WriteExpectedData()
CanWriteRequiredData::WriteRequiredData()

Constructor & Destructor Documentation

◆ WriteOptions()

WriteOptions ( const bool  _skipMissing = false,
const bool  _onlyUnqueried = true 
)
explicit

Default constructor.

Parameters
[in]_skipMissingWhether to skip writing fields that aren't already present in the output CompositeData object, default to false.
[in]_onlyUnqueriedWhether only unqueried data will be written, default to true.

Member Data Documentation

◆ onlyWriteUnqueriedData

bool onlyWriteUnqueriedData

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

Referenced by CanWriteExpectedData< Derived, Specification >::WriteExpectedData(), and CanWriteRequiredData< Derived, Specification >::WriteRequiredData().

◆ skipMissingData

bool skipMissingData

If a data type is not already part of the CompositeData, then skip it instead of writing to it when this is true. When this is false, create a new instance using the default constructor for any data type that is missing, and then hand it over for writing.

Referenced by CanWriteExpectedData< Derived, Specification >::WriteExpectedData(), and CanWriteRequiredData< Derived, Specification >::WriteRequiredData().

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