WsfP6DOF_TypeManager Class Reference

#include <WsfP6DOF_TypeManager.hpp>

Inheritance diagram for WsfP6DOF_TypeManager:

Collaboration diagram for WsfP6DOF_TypeManager:

Public Member Functions
	WsfP6DOF_TypeManager ()
	~WsfP6DOF_TypeManager () override
void	AddedToScenario () override
bool	ProcessInput (UtInput &aInput) override
void	SimulationCreated (WsfSimulation &aSimulation) override
std::string	GetP6DofVehiclePlatformTypeMatch (const std::string &aNameP6DofVehicleType) const
Public Member Functions inherited from WsfScenarioExtension
	WsfScenarioExtension ()
	~WsfScenarioExtension () override
WsfScenario &	GetScenario () const
WsfApplication &	GetApplication () const
virtual void	FileLoaded (const std::string &aFileName)
virtual bool	Complete ()
virtual bool	Complete2 ()
virtual bool	AlwaysCreate ()
Public Member Functions inherited from WsfExtension
virtual	~WsfExtension ()=default
const std::string &	GetExtensionName () const
Public Member Functions inherited from P6DofTypeManager
	P6DofTypeManager ()
	~P6DofTypeManager ()
P6DofTypeManager &	operator= (const P6DofTypeManager &other)=delete
P6DofTypeManager *	Clone () const
P6DofScenario *	GetP6DofScenario () const
bool	ProcessInput (UtInput &aInput)
void	SetIntegrators (const std::string &aFilename)
bool	RegisterObjectType (const std::string &aTypeName, P6DofVehicleType *aObjectTypePtr)
void	UnregisterObjectType (const std::string &aTypeName)
const P6DofVehicleType *	GetObjectTypeByName (const std::string &aTypeName) const
P6DofThrustProducerObject *	GetThrustProducerObjectType (const std::string &aTypeName) const
bool	RegisterThrustProducerObjectType (P6DofThrustProducerObject *aObjectType)
bool	ObjectTypeExists (const std::string &aTypeName) const
bool	ObjectTypeNameIsUnique (const std::string &aTypeName) const
std::string	GetEngineBaseType (const std::string &aTypeName) const
bool	ThrustProducerObjectTypeExists (const std::string &aTypeName) const
size_t	GetNumberOfObjectTypesInList () const
const P6DofIntegrator *	GetIntegratorByName (const std::string &aTypeName) const
std::string	GetDefaultIntegratorName () const

Additional Inherited Members
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)
Protected Member Functions inherited from P6DofTypeManager
	P6DofTypeManager (const P6DofTypeManager &)
bool	ProcessIntegratorsInput (UtInput &aInput)
Protected Attributes inherited from P6DofTypeManager
std::unordered_map< std::string, P6DofVehicleType * >	mObjectTypeMap
std::unordered_map< std::string, P6DofThrustProducerObject * >	mThrustProducerTypeMap
P6DofScenario *	mScenario
std::unordered_map< std::string, P6DofIntegrator * >	mIntegratorMap
Static Protected Attributes inherited from P6DofTypeManager
static const std::string	mDefaultIntegratorName = "STANDARD_P6DOF_INTEGRATOR"

Constructor & Destructor Documentation

WsfP6DOF_TypeManager()

WsfP6DOF_TypeManager::WsfP6DOF_TypeManager

(

)

References P6DofTypeManager::P6DofTypeManager(), and WsfScenarioExtension::WsfScenarioExtension().

~WsfP6DOF_TypeManager()

WsfP6DOF_TypeManager::~WsfP6DOF_TypeManager ( )

override

Member Function Documentation

AddedToScenario()

void WsfP6DOF_TypeManager::AddedToScenario ( )

overridevirtual

Called when the extension has been added to the scenario. This is typically used to register new component type objects and object factories, e.g.:

WsfScenario& scenario(GetScenario());
WsfMoverTypes::Get(scenario).AddCoreType("MY_MOVER", new MyMover(scenario));
WsfAntennaPatterTypes::Get(scenario).AddObjectFactor(MyAntennaPattern::ObjectFactory);

Script classes must NOT be registered here because they are global to the entire application. They should be registered in WsfApplication::AddedToApplication.

Note

GetScenario() and GetApplication() are now valid.

Reimplemented from WsfScenarioExtension.

References WsfObjectTypeList< T >::Add(), WsfEventPipeExtension::Find(), WsfFuelTypes::Get(), WsfMoverTypes::Get(), WsfProcessorTypes::Get(), WsfWeaponTypes::Get(), WsfScenarioExtension::GetScenario(), wsf::p6dof::EventPipe::RegisterEvents(), and WsfScenarioExtension::WsfScenario.

GetP6DofVehiclePlatformTypeMatch()

std::string WsfP6DOF_TypeManager::GetP6DofVehiclePlatformTypeMatch

(

const std::string &

aNameP6DofVehicleType

)

const

Referenced by WsfP6DOF_Mover::CommonSubobjectJettisonTasks(), and WsfP6DOF_Mover::InitializeSubobject().

ProcessInput()

bool WsfP6DOF_TypeManager::ProcessInput ( UtInput & aInput )

overridevirtual

Process potential input for the extension. This method examines the current input command to determine if it is one that is recognized by the extension. If it is one recognized by the extension then it processes the command and returns 'true', otherwise it returns 'false'.

Parameters

aInput

a reference to a UtInput object.

Returns

'true' if the command was one recognized by the extension or 'false' if not.

Exceptions

UtInput::ExceptionBase

(or an object derived from it) if the command was recognized but contains some sort of error.

Reimplemented from WsfScenarioExtension.

References P6DofTypeManager::ProcessInput().

SimulationCreated()

void WsfP6DOF_TypeManager::SimulationCreated ( WsfSimulation & aSimulation )

overridevirtual

Called when a simulation has been created. (Technically this is called upon entry to WsfSimulation::Initialize()). This is typically used when a scenario extension also requires a simulation extension. The method would typically register the simulation extension as follows:

aSimulation.RegisterExtension("my_ext", new MySimulationExtension());

Parameters

aSimulation

The simulation that is being created. See note below!

Note

This is called upon entry to WsfSimulation::Initialize() and nothing can be assumed about the state of the simulation.

See also

WsfSimulationExtension, WsfApplicationExtension::SimulationCreated

Reimplemented from WsfScenarioExtension.

References WsfExtension::GetExtensionName(), and WsfSimulation::RegisterExtension().

---

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

• WsfP6DOF_TypeManager.hpp
• WsfP6DOF_TypeManager.cpp