WSF
wsf::comm::medium::FactoryInterface Class Reference

#include <WsfCommMediumFactory.hpp>

Inheritance diagram for wsf::comm::medium::FactoryInterface:

Public Types

using FactoryMap = std::unordered_map<int, std::unique_ptr<FactoryInterface>>

Public Member Functions

 FactoryInterface (int aMediumIdentifier)
virtual ~FactoryInterface ()=default
int GetMediumIdentifier () const
virtual void PreInput (Container &aParent)
virtual bool ProcessInput (UtInput &aInput, Container &aParent)
virtual bool ProcessAddOrEditCommand (UtInput &aInput, Container &aParent, bool aIsAdding)
virtual bool ProcessDeleteCommand (UtInput &aInput, Container &aParent)
virtual bool PreInitialize (double aSimTime, Container &aParent)

Protected Member Functions

WsfScenarioGetScenario () const

Friends

class FactoryManager
 Required for SetScenario().

Detailed Description

The base factory interface for medium usage. Provides basic required interface for medium factories. Users must use the derived template Factory class for defining a factory for medium implementations.

Member Typedef Documentation

◆ FactoryMap

using wsf::comm::medium::FactoryInterface::FactoryMap = std::unordered_map<int, std::unique_ptr<FactoryInterface>>

Constructor & Destructor Documentation

◆ FactoryInterface()

wsf::comm::medium::FactoryInterface::FactoryInterface ( int aMediumIdentifier)
inline

◆ ~FactoryInterface()

virtual wsf::comm::medium::FactoryInterface::~FactoryInterface ( )
virtualdefault

Member Function Documentation

◆ GetMediumIdentifier()

int wsf::comm::medium::FactoryInterface::GetMediumIdentifier ( ) const
inline

◆ GetScenario()

WsfScenario & wsf::comm::medium::FactoryInterface::GetScenario ( ) const
inlineprotected

◆ PreInitialize()

virtual bool wsf::comm::medium::FactoryInterface::PreInitialize ( double aSimTime,
Container & aParent )
inlinevirtual

◆ PreInput()

virtual void wsf::comm::medium::FactoryInterface::PreInput ( Container & aParent)
inlinevirtual

◆ ProcessAddOrEditCommand()

virtual bool wsf::comm::medium::FactoryInterface::ProcessAddOrEditCommand ( UtInput & aInput,
Container & aParent,
bool aIsAdding )
inlinevirtual

◆ ProcessDeleteCommand()

virtual bool wsf::comm::medium::FactoryInterface::ProcessDeleteCommand ( UtInput & aInput,
Container & aParent )
inlinevirtual

◆ ProcessInput()

virtual bool wsf::comm::medium::FactoryInterface::ProcessInput ( UtInput & aInput,
Container & aParent )
inlinevirtual

◆ FactoryManager

friend class FactoryManager
friend

Required for SetScenario().

References FactoryManager.

Referenced by FactoryManager.


The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved