WSF
WsfTrackReportingStrategyTypes Class Reference

#include <WsfTrackReportingStrategyTypes.hpp>

Inheritance diagram for WsfTrackReportingStrategyTypes:
Collaboration diagram for WsfTrackReportingStrategyTypes:

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

static WSF_EXPORT WsfTrackReportingStrategyTypesGet (WsfScenario &aScenario)
 Return a modifiable reference to the type list associated with the specified scenario.
static WSF_EXPORT const WsfTrackReportingStrategyTypesGet (const WsfScenario &aScenario)
 Return a const reference to the type list associated with the specified scenario.
 WsfTrackReportingStrategyTypes (WsfScenario &aScenario)
WSF_EXPORT WsfTrackReportingStrategyCreate (WsfStringId aName, WsfTrackProcessor &aTrackProcessor) const

Additional Inherited Members

Public Types inherited from WsfObjectTypeList< WsfTrackReportingStrategy >
typedef WsfTrackReportingStrategy ObjectType
typedef std::vector< WsfTrackReportingStrategy * > 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< WsfTrackReportingStrategy >
 WsfObjectTypeList (WsfScenario &aScenario, unsigned int aFlags, const std::string &aBlockName)
bool Add (WsfStringId aId, std::unique_ptr< WsfTrackReportingStrategy > aDefinitionPtr)
bool AddCoreType (WsfStringId aId, std::unique_ptr< WsfTrackReportingStrategy > aDefinitionPtr)
WsfTrackReportingStrategyClone (WsfStringId aId) const override
WsfTrackReportingStrategyFind (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< WsfTrackReportingStrategy >
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

◆ WsfTrackReportingStrategyTypes()

WsfTrackReportingStrategyTypes::WsfTrackReportingStrategyTypes ( WsfScenario & aScenario)
explicit

Member Function Documentation

◆ Create()

WsfTrackReportingStrategy * WsfTrackReportingStrategyTypes::Create ( WsfStringId aName,
WsfTrackProcessor & aTrackProcessor ) const

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

Parameters
aNameThe name of the desired strategy.
aTrackProcessorThe instance of WsfTrackProcessor that will be used by this strategy internally.
Returns
A new instance of the desired strategy, or 0 if the strategy is not registered.

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

Referenced by WsfTrackProcessor::InitializeMemberData().

◆ Get() [1/2]

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

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

References WsfScenario::GetTrackReportingStrategyTypes(), and WsfTrackReportingStrategyTypes().

◆ Get() [2/2]

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

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

References WsfScenario::GetTrackReportingStrategyTypes(), and WsfTrackReportingStrategyTypes().

Referenced by WsfTrackProcessor::InitializeMemberData(), and WsfTrackProcessor::ProcessInput().


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