WSF
wsf::multiresolution Namespace Reference

Namespaces

namespace  detail

Classes

struct  ComponentName
 Helper struct for assigning names to platform components. More...
struct  PlatformComponentName
 A wrapper for identifying a platform component within a simulation, which may consist of three names: platform name, component type, and component name (optional, depending on whether or not a component is unique). More...
struct  ComponentName< WsfMover >
struct  ComponentName< WsfSensor >
struct  ComponentName< WsfFuel >
struct  ComponentName< wsf::comm::Comm >
struct  ComponentName< WsfProcessor >
struct  ComponentName< WsfAcousticSignature >
struct  ComponentName< WsfInfraredSignature >
struct  ComponentName< WsfOpticalSignature >
struct  ComponentName< WsfRadarSignature >
struct  FidelityRange
 A range of fidelity values defined by a lower bound and upper bound. More...

Functions

std::unordered_map< std::string, bool > ComponentTypeRequiresNameMap ()
 Generates a map of each supported multiresolution type name to its required user input flag.
template<typename DerivedComponent>
std::string CommandName ()
 This name, associated with DerivedComponent, is for use in the multiresolution framework. It is set as the name of the platform component instantiated with DerivedComponent.
template<typename DerivedComponent>
std::string BaseTypeName ()
 This name, associated with DerivedComponent, is used as the base input type for scenario input.
template<typename DerivedComponent>
constexpr bool RequiresUserInputName ()
template<typename DerivedComponent>
constexpr const char * BaseComponentName ()
FidelityRange ProcessFidelityRange (UtInput &aInput)
 Reads a fidelity range, which is two values in [0, 1], that are sorted in increasing order.
template<typename DerivedComponent>
WsfObjectTypeList< DerivedComponent > & GetObjectTypeList (UtInput &aInput)

Variables

constexpr auto cEXTENSION_NAME = "wsf_multiresolution"
constexpr auto cFEATURE_NAME = "multiresolution"

Function Documentation

◆ BaseComponentName()

template<typename DerivedComponent>
const char * wsf::multiresolution::BaseComponentName ( )
constexpr

Referenced by GetObjectTypeList().

◆ BaseTypeName()

template<typename DerivedComponent>
std::string wsf::multiresolution::BaseTypeName ( )

This name, associated with DerivedComponent, is used as the base input type for scenario input.

Referenced by WsfMultiresolutionTypes< DerivedComponent >::WsfMultiresolutionTypes().

◆ CommandName()

template<typename DerivedComponent>
std::string wsf::multiresolution::CommandName ( )

This name, associated with DerivedComponent, is for use in the multiresolution framework. It is set as the name of the platform component instantiated with DerivedComponent.

Referenced by WsfMultiresolutionPlatformComponent< DerivedComponent >::PreInitialize(), WsfMultiresolutionPlatformComponent< DerivedComponent >::ProcessInput(), and WsfMultiresolutionPlatformComponent< DerivedComponent >::WsfMultiresolutionPlatformComponent().

◆ ComponentTypeRequiresNameMap()

WSF_MULTIRESOLUTION_EXPORT std::unordered_map< std::string, bool > wsf::multiresolution::ComponentTypeRequiresNameMap ( )

Generates a map of each supported multiresolution type name to its required user input flag.

References wsf::multiresolution::detail::AppendComponentTypeMap().

Referenced by WsfMultiresolutionMultirunTable::ProcessInput().

◆ GetObjectTypeList()

template<typename DerivedComponent>
WsfObjectTypeList< DerivedComponent > & wsf::multiresolution::GetObjectTypeList ( UtInput & aInput)
Returns
The WsfObjectTypeList list for the DerivedComponent from the WsfScenario stored in aInput.

References BaseComponentName(), WsfScenario::FromInput(), and WsfScenario::GetTypes().

◆ ProcessFidelityRange()

FidelityRange wsf::multiresolution::ProcessFidelityRange ( UtInput & aInput)

Reads a fidelity range, which is two values in [0, 1], that are sorted in increasing order.

Exceptions
Ut::BadValueThrows for either of the following reasons: Either value is not in [0, 1] or the lower bound is greater than the upper bound.

References wsf::multiresolution::FidelityRange::mLowerBound, and wsf::multiresolution::FidelityRange::mUpperBound.

◆ RequiresUserInputName()

template<typename DerivedComponent>
bool wsf::multiresolution::RequiresUserInputName ( )
constexpr

Variable Documentation

◆ cEXTENSION_NAME

auto wsf::multiresolution::cEXTENSION_NAME = "wsf_multiresolution"
constexpr

◆ cFEATURE_NAME

auto wsf::multiresolution::cFEATURE_NAME = "multiresolution"
constexpr

Referenced by WsfPluginSetup().

Copyrights Multiple, All Rights Reserved