WsfZoneTypes Class Reference

#include <WsfZoneTypes.hpp>

Inheritance diagram for WsfZoneTypes:

Collaboration diagram for WsfZoneTypes:

Static methods to return a reference to the type list associated with a scenario.
static WSF_EXPORT WsfZoneTypes &	Get (WsfScenario &aScenario)
	Return a modifiable reference to the type list associated with the specified scenario.
static WSF_EXPORT const WsfZoneTypes &	Get (const WsfScenario &aScenario)
	Return a const reference to the type list associated with the specified scenario.
	WsfZoneTypes (WsfScenario &aScenario)
WsfZone *	ProcessZoneSetInput (UtInput &aInput)
WsfZone *	ProcessZoneInput (UtInput &aInput)
bool	LoadInstance (UtInput &aInput, WsfPlatform *aPlatformPtr)
void	InitializeZones (WsfScenario &aScenario)
LoadResult	LoadType (UtInput &aInput) override

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

WsfZoneTypes()

WsfZoneTypes::WsfZoneTypes

(

WsfScenario &

aScenario

)

References WsfObjectTypeList< WsfZone >::AddCoreType(), WsfObjectTypeListBase::cREDEFINITION_ALLOWED, WsfScenario::RegisterComponentFactory(), WsfObjectTypeList< WsfZone >::WsfObjectTypeList(), and WsfObjectTypeListBase::WsfObjectTypeListBase().

Referenced by Get(), and Get().

Member Function Documentation

Get() [1/2]

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

static

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

References WsfScenario::GetZoneTypes(), and WsfZoneTypes().

Get() [2/2]

WsfZoneTypes & WsfZoneTypes::Get ( WsfScenario & aScenario )

static

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

References WsfScenario::GetZoneTypes(), and WsfZoneTypes().

Referenced by WsfZoneAttenuation::Initialize(), WsfZoneReference::Initialize(), WsfPlatformAvailability::PlatformIsAvailable(), WsfPathFinder::ProcessInput(), and UT_DEFINE_SCRIPT_METHOD().

InitializeZones()

void WsfZoneTypes::InitializeZones

(

WsfScenario &

aScenario

)

References WsfObjectTypeList< WsfZone >::GetCurrentTypes().

Referenced by WsfScenario::CompleteLoad().

LoadInstance()

bool WsfZoneTypes::LoadInstance	(	UtInput &	aInput,
		WsfPlatform *	aPlatformPtr )

References WsfComponentListT< COMPONENT_TYPE >::AddComponent(), WsfComponentList::DeleteComponent(), WsfObjectTypeList< WsfZone >::Find(), WsfObject::GetName(), ProcessZoneInput(), and ProcessZoneSetInput().

LoadType()

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

overridevirtual

Load a new 'type object' from an input stream. Process the current command if it is one that defines a new 'type object' of this class.

Parameters

aInput

The input stream.

Returns

'true' if the command was processed or 'false' if not.

Exceptions

UtInput::ExceptionBase

(or derived class) if an error was encountered.

Reimplemented from WsfObjectTypeList< WsfZone >.

References WsfObjectTypeList< WsfZone >::Add(), WsfObject::GetName(), ProcessZoneInput(), and ProcessZoneSetInput().

ProcessZoneInput()

WsfZone * WsfZoneTypes::ProcessZoneInput

(

UtInput &

aInput

)

Referenced by LoadInstance(), and LoadType().

ProcessZoneSetInput()

WsfZone * WsfZoneTypes::ProcessZoneSetInput

(

UtInput &

aInput

)

Referenced by LoadInstance(), and LoadType().

---

The documentation for this class was generated from the following files:

• WsfZoneTypes.hpp
• WsfZoneTypes.cpp