wsf::comm::ProtocolTypes Class Reference
#include <WsfCommProtocolTypes.hpp>
Inheritance diagram for wsf::comm::ProtocolTypes:
Collaboration diagram for wsf::comm::ProtocolTypes:
Public Member Functions | |
| ProtocolTypes (WsfScenario &aScenario) | |
| bool | LoadProtocolComponent (UtInput &aInput, Comm &aComm, bool aIsAdding, int aRole, bool aIsEditable) const |
| Public Member Functions inherited from WsfObjectTypeList< ProtocolInterface > | |
| WsfObjectTypeList (WsfScenario &aScenario, unsigned int aFlags, const std::string &aBlockName) | |
| bool | Add (WsfStringId aId, std::unique_ptr< ProtocolInterface > aDefinitionPtr) |
| bool | AddCoreType (WsfStringId aId, std::unique_ptr< ProtocolInterface > aDefinitionPtr) |
| ProtocolInterface * | Clone (WsfStringId aId) const override |
| ProtocolInterface * | 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 () |
| virtual LoadResult | LoadType (UtInput &aInput) |
| 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 () |
Static Public Member Functions | |
| static WSF_EXPORT ProtocolTypes & | Get (WsfScenario &aScenario) |
| static WSF_EXPORT const ProtocolTypes & | Get (const WsfScenario &aScenario) |
Additional Inherited Members | |
| Public Types inherited from WsfObjectTypeList< ProtocolInterface > | |
| typedef ProtocolInterface | ObjectType |
| typedef std::vector< ProtocolInterface * > | 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 |
| 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< ProtocolInterface > | |
| 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
◆ ProtocolTypes()
|
explicit |
Register all built-in protocol types.
References WsfObjectTypeList< ProtocolInterface >::AddCoreType(), WsfScenario::RegisterComponentFactory(), and WsfObjectTypeList< ProtocolInterface >::WsfObjectTypeList().
Member Function Documentation
◆ Get() [1/2]
|
static |
References WsfScenario::GetProtocolTypes(), and ProtocolTypes().
◆ Get() [2/2]
|
static |
References WsfScenario::GetProtocolTypes(), and ProtocolTypes().
◆ LoadProtocolComponent()
| bool wsf::comm::ProtocolTypes::LoadProtocolComponent | ( | UtInput & | aInput, |
| Comm & | aComm, | ||
| bool | aIsAdding, | ||
| int | aRole, | ||
| bool | aIsEditable ) const |
The base load/unload component methods always assume usage of WsfPlatform, so we have to redefine our own.
References WsfComponentListT< COMPONENT_TYPE >::AddComponent(), WsfObjectTypeListBase::CloneP(), WsfComponentListT< COMPONENT_TYPE >::FindComponent(), wsf::comm::Comm::GetComponents(), WsfObjectTypeListBase::GetDeferredInput(), WsfDeferredInput::Requires(), and WsfObject::SetName().
The documentation for this class was generated from the following files: