FAnalytics::ConfigFromIni Struct Reference

#include <Analytics.h>

Public Member Functions
	ConfigFromIni ()
	ConfigFromIni (EAnalyticsBuildType InBuildType)
	ConfigFromIni (const FString &InIniName, const FString &InSectionName)
	ConfigFromIni (const FString &InIniName, const FString &SectionNameDevelopment, const FString &SectionNameDebug, const FString &SectionNameTest, const FString &SectionNameRelease)
FString	GetValue (const FString &KeyName, bool bIsRequired) const
void	SetSectionNameByBuildType (EAnalyticsBuildType InBuildType)

Static Public Member Functions
static FName	GetDefaultProviderModuleName ()

Public Attributes
FString	IniName
FString	SectionName

Detailed Description

A common way of configuring is from Inis, so this class supports that notion directly by providing a configuration class with a method suitable to be used as an FAnalyticsProviderConfigurationDelegate that reads values from the specified ini and section (based on the BuildType). Also provides a default location to store a provider name, accessed via GetDefaultProviderModuleName().

Constructor & Destructor Documentation

ConfigFromIni() [1/4]

FAnalytics::ConfigFromIni::ConfigFromIni ( )

inline

Create a config using the default values: IniName - GEngineIni SectionName (Development) = AnalyticsDevelopment SectionName (Debug) = AnalyticsDebug SectionName (Test) = AnalyticsTest SectionName (Release) = Analytics

ConfigFromIni() [2/4]

FAnalytics::ConfigFromIni::ConfigFromIni ( EAnalyticsBuildType  InBuildType )

inlineexplicit

Create a config AS IF the BuildType matches the one passed in.

ConfigFromIni() [3/4]

FAnalytics::ConfigFromIni::ConfigFromIni ( const FString &  InIniName, const FString &  InSectionName  )

inline

Create a config, specifying the Ini name and a single section name for all build types.

ConfigFromIni() [4/4]

FAnalytics::ConfigFromIni::ConfigFromIni ( const FString &  InIniName, const FString &  SectionNameDevelopment, const FString &  SectionNameDebug, const FString &  SectionNameTest, const FString &  SectionNameRelease  )

inline

Create a config, specifying the Ini name and the section name for each build type.

Member Function Documentation

GetDefaultProviderModuleName()

static FName FAnalytics::ConfigFromIni::GetDefaultProviderModuleName ( )

inlinestatic

Reads the ProviderModuleName key from the Analytics section of GEngineIni, which is the default, preferred location to look for the analytics provider name. This is purely optional, and you can store that information anywhere you want or merely hardcode the provider module.

GetValue()

FString FAnalytics::ConfigFromIni::GetValue ( const FString &  KeyName, bool  bIsRequired  ) const

inline

Method that can be bound to an FAnalyticsProviderConfigurationDelegate.

SetSectionNameByBuildType()

void FAnalytics::ConfigFromIni::SetSectionNameByBuildType ( EAnalyticsBuildType  InBuildType )

inline

Allows setting the INI section name based on the build type passed in. Allows access to the default section values when the application chooses the build type itself.

Member Data Documentation

IniName

FString FAnalytics::ConfigFromIni::IniName

Ini file name to find the config values.

SectionName

FString FAnalytics::ConfigFromIni::SectionName

Section name in the Ini file in which to find the keys. The KeyNames should match the field name in the Config object.

---

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

• Engine/Source/Runtime/Analytics/Analytics/Public/Analytics.h