Ignition Physics

API Reference

1.2.0
FeatureWithRequirements< Features > Struct Template Reference

The FeatureWithRequirements class simply wraps up its required features in a FeatureList and then sets the RequiredFeatures type. More...

#include <FeatureList.hh>

Public Types

using RequiredFeatures = FeatureList< Features... >
 
- Public Types inherited from Feature
using RequiredFeatures = void
 By default, a blank feature will not require any other features. If your feature does require some other set of features, then you should inherit the FeatureWithRequirements class, and provide it with a list of the Features that you require. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Feature
template<typename SomeFeatureList , bool = false>
static constexpr bool ConflictsWith ()
 By default, a blank feature will not conflict with any other features. If your feature does conflict with some other set of features, then you should inherit the FeatureWithConflicts<...> class, and provide it a list of those conflicting features. More...
 

Detailed Description

template<typename... Features>
struct ignition::physics::FeatureWithRequirements< Features >

The FeatureWithRequirements class simply wraps up its required features in a FeatureList and then sets the RequiredFeatures type.

If your feature is known to require any other features, then you should have your feature class inherit FeatureWithRequirements<...>, and pass it a list of the features that it requires.

Member Typedef Documentation

◆ RequiredFeatures

using RequiredFeatures = FeatureList<Features...>

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