WsfEW_EffectTypes Class Reference
#include <WsfEW_EffectTypes.hpp>
Inheritance diagram for WsfEW_EffectTypes:
Collaboration diagram for WsfEW_EffectTypes:
Static methods to return a reference to the type list associated with a scenario. | |
| static WSF_MIL_EXPORT WsfEW_EffectTypes & | Get (WsfScenario &aScenario) |
| Return a modifiable reference to the type list associated with the specified scenario. | |
| static WSF_MIL_EXPORT const WsfEW_EffectTypes & | Get (const WsfScenario &aScenario) |
| Return a const reference to the type list associated with the specified scenario. | |
| WsfEW_EffectTypes (WsfScenario &aScenario) | |
| bool | LoadInstance (UtInput &aInput, WsfEW_Technique *aTechniquePtr) |
Additional Inherited Members | |
| Public Types inherited from WsfObjectTypeList< WsfEW_Effect > | |
| typedef WsfEW_Effect | ObjectType |
| typedef std::vector< WsfEW_Effect * > | 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< WsfStringId > | TypeIdList |
| Public Member Functions inherited from WsfObjectTypeList< WsfEW_Effect > | |
| WsfObjectTypeList (WsfScenario &aScenario, unsigned int aFlags, const std::string &aBlockName) | |
| bool | Add (WsfStringId aId, std::unique_ptr< WsfEW_Effect > aDefinitionPtr) |
| bool | AddCoreType (WsfStringId aId, std::unique_ptr< WsfEW_Effect > aDefinitionPtr) |
| WsfEW_Effect * | Clone (WsfStringId aId) const override |
| WsfEW_Effect * | Find (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 | |
| WsfObjectTypeListBase & | operator= (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 |
| WsfScenario * | GetScenario () 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 | |
| WsfDeferredInput & | GetDeferredInput () const |
| bool | CanDelayLoad () const |
| bool | AddP (WsfStringId aId, std::unique_ptr< WsfObject > aDefinitionPtr) |
| WsfObject * | CloneP (WsfStringId aId) const |
| virtual WsfObject * | FindP (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< WsfEW_Effect > | |
| static WsfObject * | CreateDefaultFunction () |
| static WsfObject * | CreateFunction () |
| static WsfObject * | FactoryCreateFunction (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< WsfStringId > | mCoreTypes |
| unsigned int | mFlags |
| const std::string | mBlockName |
| WsfObject *(* | mCreateSingularTypeFunction )() |
| WsfObject *(* | mFactoryCreateFunction )(void *aListPtr, const std::string &aTypeName) |
| WsfObject *(* | mFactoryCreateDefault )() |
| void * | mFactoryPtr |
| WsfScenario * | mScenarioPtr |
Constructor & Destructor Documentation
◆ WsfEW_EffectTypes()
|
explicit |
Member Function Documentation
◆ Get() [1/2]
|
static |
Return a const reference to the type list associated with the specified scenario.
References WsfMilExtension::Get(), WsfMilExtension::GetEW_EffectTypes(), and WsfEW_EffectTypes().
◆ Get() [2/2]
|
static |
Return a modifiable reference to the type list associated with the specified scenario.
References WsfMilExtension::Get(), WsfMilExtension::GetEW_EffectTypes(), and WsfEW_EffectTypes().
Referenced by WsfEW_Technique::ProcessInput().
◆ LoadInstance()
| bool WsfEW_EffectTypes::LoadInstance | ( | UtInput & | aInput, |
| WsfEW_Technique * | aTechniquePtr ) |
Load an instance of a 'type object' of this class Process the current command if it would create an instance of an 'type object' of this class.
- Parameters
-
aInput The input stream. aTechniquePtr The object into which the instance is to be attached.
- Returns
- true if the command was recognized as one for instantiating an object of this type.
- Exceptions
-
UtInput::ExceptionBase (or derived class) if an error was encountered.
References WsfEW_Technique::AddEffect(), WsfObjectTypeList< WsfEW_Effect >::Clone(), WsfEW_Technique::EffectIsAvailable(), WsfObjectTypeList< WsfEW_Effect >::Find(), WsfScenario::GetDeferredInput(), WsfEW_Technique::GetEffect(), WsfObjectTypeListBase::GetScenario(), and WsfDeferredInput::MaybeRequires().
The documentation for this class was generated from the following files: