#include <WsfEM_PropagationTypes.hpp>

Inheritance diagram for WsfEM_PropagationTypes:

[legend]

Collaboration diagram for WsfEM_PropagationTypes:

[legend]

Static methods to return a reference to the type list associated with a scenario.
typedef WsfEM_Propagation (	FactoryPtr) (const std::string &)
static WSF_EXPORT WsfEM_PropagationTypes &	Get (WsfScenario &aScenario)
	Return a modifiable reference to the type list associated with the specified scenario.
static WSF_EXPORT const WsfEM_PropagationTypes &	Get (const WsfScenario &aScenario)
	Return a const reference to the type list associated with the specified scenario.
	WsfEM_PropagationTypes (WsfScenario &aScenario)
LoadResult	LoadType (UtInput &aInput) override
WSF_EXPORT void	AddObjectFactory (FactoryPtr aFactoryPtr)
WSF_EXPORT bool	LoadReference (UtInput &aInput, WsfStringId &aTypeName)

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

Member Typedef Documentation

◆ FactoryPtr

typedef WsfEM_Propagation *(* WsfEM_PropagationTypes::FactoryPtr) (const std::string &)

Constructor & Destructor Documentation

◆ WsfEM_PropagationTypes()

WsfEM_PropagationTypes::WsfEM_PropagationTypes ( WsfScenario & aScenario )

References AddObjectFactory(), WsfObjectTypeListBase::cREDEFINITION_ALLOWED, WsfEM_FastMultipath::ObjectFactory(), WsfEM_GroundWavePropagation::ObjectFactory(), and WsfObjectTypeList< WsfEM_Propagation >::WsfObjectTypeList().

Referenced by Get(), and Get().

Member Function Documentation

◆ AddObjectFactory()

void WsfEM_PropagationTypes::AddObjectFactory ( FactoryPtr aFactoryPtr )

Add an object factory for creating an instance from a fundamental type. The factory should be a static method and should be added only once.

Referenced by WsfEM_PropagationTypes().

◆ Get() [1/2]

const WsfEM_PropagationTypes & WsfEM_PropagationTypes::Get ( const WsfScenario & aScenario )

static

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

References WsfScenario::GetEM_PropagationTypes(), and WsfEM_PropagationTypes().

◆ Get() [2/2]

WsfEM_PropagationTypes & WsfEM_PropagationTypes::Get ( WsfScenario & aScenario )

static

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

References WsfScenario::GetEM_PropagationTypes(), and WsfEM_PropagationTypes().

Referenced by WsfEM_XmtrRcvr::Initialize(), and WsfEM_XmtrRcvr::ProcessInput().

◆ LoadReference()

bool WsfEM_PropagationTypes::LoadReference	(	UtInput &	aInput,
		WsfStringId &	aTypeName )

Process a possible reference to a propagation model type.

Parameters

aInput	[input] The input stream.
aTypeName	[output] The name of the referenced propagation model type (valid only if the function return value is true).

Returns: true if the command was a reference to a propagation model or false if not.

References WsfObjectTypeList< WsfEM_Propagation >::Add().

◆ LoadType()

WsfEM_PropagationTypes::LoadResult WsfEM_PropagationTypes::LoadType ( UtInput & aInput )

overridevirtual

Process propagation_model type input.