WSF
WsfCorrelationStrategyTypes Class Reference

#include <WsfCorrelationStrategyTypes.hpp>

Inheritance diagram for WsfCorrelationStrategyTypes:
Collaboration diagram for WsfCorrelationStrategyTypes:

Static methods to return a reference to the type list associated with a scenario.

std::string mDefaultStrategyName
static WSF_EXPORT WsfCorrelationStrategyTypesGet (WsfScenario &aScenario)
 Return a modifiable reference to the type list associated with the specified scenario.
static WSF_EXPORT const WsfCorrelationStrategyTypesGet (const WsfScenario &aScenario)
 Return a const reference to the type list associated with the specified scenario.
 WsfCorrelationStrategyTypes (WsfScenario &aScenario)
WSF_EXPORT WsfCorrelationStrategyCreate (const std::string &aName) const
WSF_EXPORT bool LoadInstance (UtInput &aInput, WsfCorrelationStrategy *&aStrategyPtr) const
WSF_EXPORT const std::string & GetDefaultStrategyName () const
WSF_EXPORT void SetDefaultStrategyName (const std::string &aName)
bool ProcessInput (UtInput &aInput) override

Additional Inherited Members

Public Types inherited from WsfObjectTypeList< WsfCorrelationStrategy >
typedef WsfCorrelationStrategy ObjectType
typedef std::vector< WsfCorrelationStrategy * > ObjectPtrList
Public Types inherited from WsfObjectTypeListBase
enum  Flags {
  cREDEFINITION_ALLOWED = 1 , cSINGULAR_BASE_TYPE = 2 , cOBJECT_FACTORY_BASE = 4 , cNO_DELAY_LOAD = 8 ,
  cSIGNATURE_FLAGS = cREDEFINITION_ALLOWED | cNO_DELAY_LOAD
}
Public Types inherited from WsfObjectTypeListBaseI
typedef std::vector< WsfStringIdTypeIdList
Public Member Functions inherited from WsfObjectTypeList< WsfCorrelationStrategy >
 WsfObjectTypeList (WsfScenario &aScenario, unsigned int aFlags, const std::string &aBlockName)
 WsfObjectTypeList (WsfScenario &aScenario, const std::string &aBlockName)
bool Add (WsfStringId aId, std::unique_ptr< WsfCorrelationStrategy > aDefinitionPtr)
bool AddCoreType (WsfStringId aId, std::unique_ptr< WsfCorrelationStrategy > aDefinitionPtr)
WsfCorrelationStrategyClone (WsfStringId aId) const override
WsfCorrelationStrategyFind (WsfStringId aId) const override
ObjectPtrList GetCoreTypes () const
 Returns a list of core types, i.e. types added via AddCoreType.
void GetCurrentTypes (ObjectPtrList &aListOfPtrs) const
void GetCurrentUserTypes (ObjectPtrList &aListOfPtrs) const
 Returns the list of types defined by the user (no core / builtin types).
bool IsType (WsfStringId aTypeName) const
void SetSingularBaseType ()
void SetObjectFactory (const FACTORY_LIST *aFactoryListPtr)
void SetObjectFactoryDefault ()
virtual LoadResult LoadType (UtInput &aInput)
bool ProcessInput (UtInput &aInput) override
virtual bool InitializeType (ObjectType *aTypePtr)
bool LoadNamedComponent (UtInput &aInput, WsfPlatform &aPlatform, bool aIsAdding, int aRole)
bool LoadUnnamedComponent (UtInput &aInput, WsfPlatform &aPlatform, bool aIsAdding, int aRole)
bool LoadUnnamedComponentWithoutEdit (UtInput &aInput, WsfPlatform &aPlatform, bool aIsAdding, int aRole)
bool DeleteNamedComponent (UtInput &aInput, WsfPlatform &aPlatform, int aRole)
bool DeleteUnnamedComponent (UtInput &aInput, WsfPlatform &aPlatform, int aRole)
Public Member Functions inherited from WsfObjectTypeListBase
 WsfObjectTypeListBase (const WsfObjectTypeListBase &)=delete
WsfObjectTypeListBaseoperator= (const WsfObjectTypeListBase &)=delete
 WsfObjectTypeListBase (unsigned int aFlags, const std::string &aBlockName=std::string(), WsfScenario *aScenarioPtr=nullptr)
 ~WsfObjectTypeListBase () override
void Clear () override
 Clear (Erase) all type entries.
void GetTypeIds (TypeIdList &aListOfIds) const override
 Return a vector of the type identifiers currently being controlled by this list.
bool ProcessInput (UtInput &aInput) override
int Size () const
 Return the current number of types being maintained by the list.
const std::string & GetBlockName () const override
WsfScenarioGetScenario () const
Public Member Functions inherited from WsfObjectTypeListBaseI
virtual ~WsfObjectTypeListBaseI ()=default
virtual void CompleteLoad ()
Protected Types inherited from WsfObjectTypeListBase
typedef std::map< WsfStringId, std::unique_ptr< WsfObject > > TypeMap
bool InitializeTypeP (WsfObject *aObjectPtr) override
Protected Member Functions inherited from WsfObjectTypeListBase
WsfDeferredInputGetDeferredInput () const
bool CanDelayLoad () const
bool AddP (WsfStringId aId, std::unique_ptr< WsfObject > aDefinitionPtr)
WsfObjectCloneP (WsfStringId aId) const
virtual WsfObjectFindP (WsfStringId aId) const
bool LoadTypeP (UtInput &aInput, WsfObject *&aLoadedObjectPtr)
virtual bool DeferredLoadTypeP (UtInput &aInput, WsfObject *&aLoadedObjectPtr)
bool DeleteComponentP (UtInput &aInput, WsfPlatform &aPlatform, int aRole, bool aIsNamed)
bool LoadComponentP (UtInput &aInput, WsfPlatform &aPlatform, bool aIsAdding, int aRole, bool aIsNamed, bool aIsEditable)
Static Protected Member Functions inherited from WsfObjectTypeList< WsfCorrelationStrategy >
static WsfObjectCreateDefaultFunction ()
static WsfObjectCreateFunction ()
static WsfObjectFactoryCreateFunction (void *aListPtr, const std::string &aTypeName)
Protected Attributes inherited from WsfObjectTypeListBase
TypeMap mTypeMap
std::vector< std::unique_ptr< WsfObject > > mRedefinedTypes
 A list of type objects that have been redefined.
std::set< WsfStringIdmCoreTypes
unsigned int mFlags
const std::string mBlockName
WsfObject *(* mCreateSingularTypeFunction )()
WsfObject *(* mFactoryCreateFunction )(void *aListPtr, const std::string &aTypeName)
WsfObject *(* mFactoryCreateDefault )()
void * mFactoryPtr
WsfScenariomScenarioPtr

Constructor & Destructor Documentation

◆ WsfCorrelationStrategyTypes()

WsfCorrelationStrategyTypes::WsfCorrelationStrategyTypes ( WsfScenario & aScenario)

Member Function Documentation

◆ Create()

WsfCorrelationStrategy * WsfCorrelationStrategyTypes::Create ( const std::string & aName) const

(Factory Method) Create a new instance of a strategy with the given name.

Parameters
aNameThe name of the desired strategy.
Returns
A new instance of the desired strategy, or 0 if the strategy is not registered.

References WsfCorrelationStrategy::Clone(), and WsfObjectTypeList< WsfCorrelationStrategy >::Find().

Referenced by LoadInstance(), and WsfTrackManager::ProcessInput().

◆ Get() [1/2]

const WsfCorrelationStrategyTypes & WsfCorrelationStrategyTypes::Get ( const WsfScenario & aScenario)
static

Return a const reference to the type list associated with the specified scenario.

References WsfScenario::GetCorrelationTypes(), and WsfCorrelationStrategyTypes().

◆ Get() [2/2]

WsfCorrelationStrategyTypes & WsfCorrelationStrategyTypes::Get ( WsfScenario & aScenario)
static

◆ GetDefaultStrategyName()

const std::string & WsfCorrelationStrategyTypes::GetDefaultStrategyName ( ) const

Return the name of the default strategy (used when the strategy_method input is missing in a track_manager input block).

References mDefaultStrategyName.

◆ LoadInstance()

bool WsfCorrelationStrategyTypes::LoadInstance ( UtInput & aInput,
WsfCorrelationStrategy *& aStrategyPtr ) const

◆ ProcessInput()

bool WsfCorrelationStrategyTypes::ProcessInput ( UtInput & aInput)
overridevirtual

Configure the global default fusion strategy using the default_fusion_method keyword. If no default strategy exists, "replacement" will be used as the default.

Implements WsfObjectTypeListBaseI.

References WsfObjectTypeList< WsfCorrelationStrategy >::Find(), mDefaultStrategyName, and WsfObjectTypeList< T >::ProcessInput().

◆ SetDefaultStrategyName()

void WsfCorrelationStrategyTypes::SetDefaultStrategyName ( const std::string & aName)

Set the default strategy name. If the name does not correspond to a known strategy type, an exception will be thrown.

References WsfObjectTypeList< WsfCorrelationStrategy >::Find(), and mDefaultStrategyName.

Member Data Documentation

◆ mDefaultStrategyName

std::string WsfCorrelationStrategyTypes::mDefaultStrategyName

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved