WsfDeferredInput Class Reference

#include <WsfDeferredInput.hpp>

Classes
struct	Loader

Public Types
using	UniqueId = std::pair<std::string, std::string>
using	ProcessInputFunction = std::function<bool(UtInput&)>

Public Member Functions
	WsfDeferredInput ()
bool	IsDelayLoading ()
void	DelayLoad (const std::string &aKind, const std::string &aName, const UtInput::StoredLocation &aPosition, const ProcessInputFunction &aInputFunction)
void	Requires (const std::string &aKind, const std::string &aName)
void	MaybeRequires (const std::string &aKind, const std::string &aName)
void	Resolve (UtInput &aInput)
void	Clear ()
void	ResetDelays ()

Protected Types
using	LoaderMap = std::multimap<UniqueId, Loader>

Protected Member Functions
bool	IsDelayLoadingP ()
void	DelayLoadP (const std::string &aKind, const std::string &aName, const UtInput::StoredLocation &aPosition, const ProcessInputFunction &aInputFunction)
void	RequiresP (const std::string &aKind, const std::string &aName)
void	ResolveP (UtInput &aInput)
void	ResetDelaysP ()
void	ClearP ()

Protected Attributes
bool	mIsDelayLoading
UtInput *	mRootInputPtr
LoaderMap	mDelayLoaders
std::set< UniqueId >	mCurrentlyLoading
std::vector< UtInput * >	mInputStack
std::set< UniqueId >	mCompleted
std::vector< UniqueId >	mDelayLoadOrder

Detailed Description

Contains input utilities for WSF.

WSF does 'delayed' loading for many types of objects. When delay loading, an object's kind and name are scanned, remembered, and bypassed until a later time.

For instance: sensor MySensor MySensorTYPE ... end_sensor Here, 'sensor MySensor' is saved using WsfDeferredInput::DelayLoad(), and then the entire block is skipped until all initial input processing has been completed. Finally, WsfDeferredInput::Resolve() finishes reading the delay load blocks. If an object depends on another object at input-time, a call to WsfDeferredInput::Requires() ensures that dependency is met before input processing continues.

Any object which has input-time dependencies should use the delay load feature.

Member Typedef Documentation

LoaderMap

using WsfDeferredInput::LoaderMap = std::multimap<UniqueId, Loader>

protected

ProcessInputFunction

using WsfDeferredInput::ProcessInputFunction = std::function<bool(UtInput&)>

UniqueId

using WsfDeferredInput::UniqueId = std::pair<std::string, std::string>

Constructor & Destructor Documentation

WsfDeferredInput()

WsfDeferredInput::WsfDeferredInput

(

)

References mCompleted, mCurrentlyLoading, mDelayLoaders, mDelayLoadOrder, mInputStack, mIsDelayLoading, and mRootInputPtr.

Member Function Documentation

Clear()

void WsfDeferredInput::Clear ( )

inline

References ClearP().

ClearP()

void WsfDeferredInput::ClearP ( )

protected

References mCompleted, mCurrentlyLoading, mDelayLoaders, mDelayLoadOrder, mInputStack, mIsDelayLoading, and mRootInputPtr.

Referenced by Clear().

DelayLoad()

void WsfDeferredInput::DelayLoad ( const std::string & aKind, const std::string & aName, const UtInput::StoredLocation & aPosition, const ProcessInputFunction & aInputFunction )

inline

References DelayLoadP().

Referenced by WsfScenario::LoadPlatformInstance(), WsfPlatformTypes::LoadType(), and WsfObjectTypeListBase::LoadTypeP().

DelayLoadP()

void WsfDeferredInput::DelayLoadP ( const std::string & aKind, const std::string & aName, const UtInput::StoredLocation & aPosition, const ProcessInputFunction & aInputFunction )

protected

References mDelayLoaders, mDelayLoadOrder, WsfDeferredInput::Loader::mInputFunction, and WsfDeferredInput::Loader::mLocation.

Referenced by DelayLoad().

IsDelayLoading()

bool WsfDeferredInput::IsDelayLoading ( )

inline

Returns true if the delay load phase is active. In this phase, types that were skipped during the first pass are finally processed.

References IsDelayLoadingP().

IsDelayLoadingP()

bool WsfDeferredInput::IsDelayLoadingP ( )

protected

References mIsDelayLoading.

Referenced by IsDelayLoading().

MaybeRequires()

void WsfDeferredInput::MaybeRequires	(	const std::string &	aKind,
		const std::string &	aName )

References mDelayLoaders, and Requires().

Referenced by WsfEW_EffectTypes::LoadInstance(), WsfEW_TechniqueTypes::LoadInstance(), WsfFilterTypes::LoadInstance(), and WsfEW_FalseTargetEffect::FT_Data::ProcessInput().

Requires()

void WsfDeferredInput::Requires ( const std::string & aKind, const std::string & aName )

inline

References RequiresP().

Referenced by WsfObjectTypeListBase::CloneP(), WsfObjectTypeListBase::LoadComponentP(), WsfRouteTypes::LoadInstance(), wsf::comm::medium::Types::LoadMedium(), WsfScenario::LoadPlatformInstance(), wsf::comm::ProtocolTypes::LoadProtocolComponent(), wsf::comm::router::ProtocolTypes::LoadProtocolComponent(), WsfPlatformTypes::LoadType(), WsfObjectTypeListBase::LoadTypeP(), MaybeRequires(), wsf::altloc::Component::ProcessInput(), WsfRoute::ProcessNavigationInput(), and ResolveP().

RequiresP()

void WsfDeferredInput::RequiresP ( const std::string & aKind, const std::string & aName )

protected

References mCompleted, mCurrentlyLoading, mDelayLoaders, mInputStack, mIsDelayLoading, and mRootInputPtr.

Referenced by Requires().

ResetDelays()

void WsfDeferredInput::ResetDelays ( )

inline

References ResetDelaysP().

ResetDelaysP()

void WsfDeferredInput::ResetDelaysP ( )

protected

References mCompleted, mDelayLoaders, and mDelayLoadOrder.

Referenced by ResetDelays().

Resolve()

void WsfDeferredInput::Resolve ( UtInput & aInput )

inline

References ResolveP().

ResolveP()

void WsfDeferredInput::ResolveP ( UtInput & aInput )

protected

References mDelayLoadOrder, mIsDelayLoading, mRootInputPtr, and Requires().

Referenced by Resolve().

Member Data Documentation

mCompleted

std::set<UniqueId> WsfDeferredInput::mCompleted

protected

Referenced by ClearP(), RequiresP(), ResetDelaysP(), and WsfDeferredInput().

mCurrentlyLoading

std::set<UniqueId> WsfDeferredInput::mCurrentlyLoading

protected

Referenced by ClearP(), RequiresP(), and WsfDeferredInput().

mDelayLoaders

LoaderMap WsfDeferredInput::mDelayLoaders

protected

Referenced by ClearP(), DelayLoadP(), MaybeRequires(), RequiresP(), ResetDelaysP(), and WsfDeferredInput().

mDelayLoadOrder

std::vector<UniqueId> WsfDeferredInput::mDelayLoadOrder

protected

Referenced by ClearP(), DelayLoadP(), ResetDelaysP(), ResolveP(), and WsfDeferredInput().

mInputStack

std::vector<UtInput*> WsfDeferredInput::mInputStack

protected

Referenced by ClearP(), RequiresP(), and WsfDeferredInput().

mIsDelayLoading

bool WsfDeferredInput::mIsDelayLoading

protected

Referenced by ClearP(), IsDelayLoadingP(), RequiresP(), ResolveP(), and WsfDeferredInput().

mRootInputPtr

UtInput* WsfDeferredInput::mRootInputPtr

protected

Referenced by ClearP(), RequiresP(), ResolveP(), and WsfDeferredInput().

---

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

• WsfDeferredInput.hpp
• WsfDeferredInput.cpp