AzFramework::DeviceAttributeRegistrarInterface Class Reference

Inherited by AzFramework::DeviceAttributesSystemComponent.

Public Types
using	VisitInterfaceCallback = AZStd::function< bool(DeviceAttribute &)>
	The callback function should return true to continue enumaration or false to stop.

Public Member Functions
	AZ_RTTI (DeviceAttributeRegistrarInterface, "{D6B65DF8-8275-42F8-B84D-4F9ACBECC7C2}")
virtual DeviceAttribute *	FindDeviceAttribute (AZStd::string_view deviceAttribute) const =0
	Find a device attribute by name.
virtual bool	RegisterDeviceAttribute (AZStd::shared_ptr< DeviceAttribute > deviceAttributeInterface)=0
	Register a device attribute interface, deviceAttribute must have a unique name, returns true on success.
virtual bool	UnregisterDeviceAttribute (AZStd::string_view deviceAttribute)=0
	Unregister an existing device attribute, returns true on success, false if not found.
virtual void	VisitDeviceAttributes (const VisitInterfaceCallback &) const =0

Member Function Documentation

FindDeviceAttribute()

virtual DeviceAttribute * AzFramework::DeviceAttributeRegistrarInterface::FindDeviceAttribute ( AZStd::string_view  deviceAttribute ) const

pure virtual

Find a device attribute by name.

Implemented in AzFramework::DeviceAttributesSystemComponent.

RegisterDeviceAttribute()

virtual bool AzFramework::DeviceAttributeRegistrarInterface::RegisterDeviceAttribute ( AZStd::shared_ptr< DeviceAttribute >  deviceAttributeInterface )

pure virtual

Register a device attribute interface, deviceAttribute must have a unique name, returns true on success.

Implemented in AzFramework::DeviceAttributesSystemComponent.

UnregisterDeviceAttribute()

virtual bool AzFramework::DeviceAttributeRegistrarInterface::UnregisterDeviceAttribute ( AZStd::string_view  deviceAttribute )

pure virtual

Unregister an existing device attribute, returns true on success, false if not found.

Implemented in AzFramework::DeviceAttributesSystemComponent.

VisitDeviceAttributes()

virtual void AzFramework::DeviceAttributeRegistrarInterface::VisitDeviceAttributes ( const VisitInterfaceCallback &  ) const

pure virtual

Visit device attribute interfaces with a callback function The visiting callback can be useful to enumerate over multiple attributes for display or rule evaluation.

Implemented in AzFramework::DeviceAttributesSystemComponent.

---

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

• Code/Framework/AzFramework/AzFramework/Device/DeviceAttributeInterface.h