Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | List of all members
AZ::Metrics::IEventLoggerFactory Class Referenceabstract

Inherited by AZ::Metrics::EventLoggerFactoryImpl.

Public Types

using VisitEventLoggerInterfaceCallback = AZStd::function< bool(IEventLogger &)>
 

Public Member Functions

 AZ_RTTI (IEventLoggerFactory, "{3E98C565-3A1E-460E-B692-4FAE783952CC}")
 
virtual void VisitEventLoggers (const VisitEventLoggerInterfaceCallback &) const =0
 Invokes the supplied visitor for each non-nullptr event logger.
 
virtual AZ::Outcome< void, AZStd::unique_ptr< IEventLogger > > RegisterEventLogger (EventLoggerId loggerId, AZStd::unique_ptr< IEventLogger >)=0
 
virtual bool RegisterEventLogger (EventLoggerId loggerId, IEventLogger &)=0
 
virtual bool UnregisterEventLogger (EventLoggerId loggerId)=0
 
virtual IEventLogger * FindEventLogger (EventLoggerId) const =0
 
virtual bool IsRegistered (EventLoggerId) const =0
 

Member Typedef Documentation

◆ VisitEventLoggerInterfaceCallback

using AZ::Metrics::IEventLoggerFactory::VisitEventLoggerInterfaceCallback = AZStd::function<bool(IEventLogger&)>

Callback function that is invoked for every registered event logger return true to continue visiting

Member Function Documentation

◆ FindEventLogger()

virtual IEventLogger * AZ::Metrics::IEventLoggerFactory::FindEventLogger ( EventLoggerId  ) const
pure virtual

Find event logger registered with the specified id

Parameters
loggerIdEventLoggerId to locate a registered event logger
Returns
pointer to the EventLogger

Implemented in AZ::Metrics::EventLoggerFactoryImpl.

◆ IsRegistered()

virtual bool AZ::Metrics::IEventLoggerFactory::IsRegistered ( EventLoggerId  ) const
pure virtual

Return true if there is an event logger registered with the specified id

Parameters
loggerIdEventLoggerId to determine if an event logger is registered
Returns
bool indicating if there is an event logger with the id registered

Implemented in AZ::Metrics::EventLoggerFactoryImpl.

◆ RegisterEventLogger() [1/2]

virtual AZ::Outcome< void, AZStd::unique_ptr< IEventLogger > > AZ::Metrics::IEventLoggerFactory::RegisterEventLogger ( EventLoggerId  loggerId,
AZStd::unique_ptr< IEventLogger >   
)
pure virtual

Registers event logger and takes ownership of it if registration is successful

Parameters
loggerIdUnique id to associate with EventLogger
eventLoggerEvent logger to register
Returns
Success outcome if the Event logger was successfully registered If the logger could not be registered, a failure outcome with the event logger is returned

Implemented in AZ::Metrics::EventLoggerFactoryImpl.

◆ RegisterEventLogger() [2/2]

virtual bool AZ::Metrics::IEventLoggerFactory::RegisterEventLogger ( EventLoggerId  loggerId,
IEventLogger &   
)
pure virtual

Registers event logger, but does not take ownership of it

Parameters
loggerIdUnique id to associate with EventLogger
eventLoggerEvent logger to register
Returns
true if the IEventLogger was successfully registered

Implemented in AZ::Metrics::EventLoggerFactoryImpl.

◆ UnregisterEventLogger()

virtual bool AZ::Metrics::IEventLoggerFactory::UnregisterEventLogger ( EventLoggerId  loggerId)
pure virtual

Unregisters the EventLogger Interface with the specified id

Parameters
loggerIdId to lookup the event logger
Returns
true if the unregistration is successful

Implemented in AZ::Metrics::EventLoggerFactoryImpl.

◆ VisitEventLoggers()

virtual void AZ::Metrics::IEventLoggerFactory::VisitEventLoggers ( const VisitEventLoggerInterfaceCallback &  ) const
pure virtual

Invokes the supplied visitor for each non-nullptr event logger.

Implemented in AZ::Metrics::EventLoggerFactoryImpl.

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