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.
AZ::Metrics::EventLoggerFactoryImpl Class Referencefinal

Inherits AZ::Metrics::IEventLoggerFactory.

Classes

struct  EventLoggerDeleter
 

Public Member Functions

 AZ_RTTI (EventLoggerFactoryImpl, "{7F44BCD5-D4B9-464C-A54C-ECDF3C2E3802}", IEventLoggerFactory)
 
 AZ_CLASS_ALLOCATOR (EventLoggerFactoryImpl, AZ::SystemAllocator)
 
void VisitEventLoggers (const VisitEventLoggerInterfaceCallback &) const override
 Invokes the supplied visitor for each non-nullptr event logger.
 
AZ::Outcome< void, AZStd::unique_ptr< IEventLogger > > RegisterEventLogger (EventLoggerId loggerId, AZStd::unique_ptr< IEventLogger > eventLogger) override
 Registers an event logger with a standard deleter.
 
bool RegisterEventLogger (EventLoggerId loggerId, IEventLogger &eventLogger) override
 Registers an event logger with a null deleter.
 
bool UnregisterEventLogger (EventLoggerId loggerId) override
 
IEventLoggerFindEventLogger (EventLoggerId loggerId) const override
 
bool IsRegistered (EventLoggerId loggerId) const override
 
- Public Member Functions inherited from AZ::Metrics::IEventLoggerFactory
 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 IEventLoggerFindEventLogger (EventLoggerId) const =0
 
virtual bool IsRegistered (EventLoggerId) const =0
 

Additional Inherited Members

- Public Types inherited from AZ::Metrics::IEventLoggerFactory
using VisitEventLoggerInterfaceCallback = AZStd::function< bool(IEventLogger &)>
 

Member Function Documentation

◆ FindEventLogger()

IEventLogger * AZ::Metrics::EventLoggerFactoryImpl::FindEventLogger ( EventLoggerId  ) const
overridevirtual

Find event logger registered with the specified id

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

Implements AZ::Metrics::IEventLoggerFactory.

◆ IsRegistered()

bool AZ::Metrics::EventLoggerFactoryImpl::IsRegistered ( EventLoggerId  ) const
overridevirtual

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

Implements AZ::Metrics::IEventLoggerFactory.

◆ RegisterEventLogger() [1/2]

AZ::Outcome< void, AZStd::unique_ptr< IEventLogger > > AZ::Metrics::EventLoggerFactoryImpl::RegisterEventLogger ( EventLoggerId  loggerId,
AZStd::unique_ptr< IEventLogger eventLogger 
)
overridevirtual

Registers an event logger with a standard deleter.

Implements AZ::Metrics::IEventLoggerFactory.

◆ RegisterEventLogger() [2/2]

bool AZ::Metrics::EventLoggerFactoryImpl::RegisterEventLogger ( EventLoggerId  loggerId,
IEventLogger eventLogger 
)
overridevirtual

Registers an event logger with a null deleter.

Implements AZ::Metrics::IEventLoggerFactory.

◆ UnregisterEventLogger()

bool AZ::Metrics::EventLoggerFactoryImpl::UnregisterEventLogger ( EventLoggerId  loggerId)
overridevirtual

Unregisters the EventLogger Interface with the specified id

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

Implements AZ::Metrics::IEventLoggerFactory.

◆ VisitEventLoggers()

void AZ::Metrics::EventLoggerFactoryImpl::VisitEventLoggers ( const VisitEventLoggerInterfaceCallback ) const
overridevirtual

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

Implements AZ::Metrics::IEventLoggerFactory.


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