Detailed Description

Encapsulates the results of a Hash device detection engine's processing.

The class is constructed using an instance of a C fiftyoneDegreesResultsHash structure which are then referenced to return associated values and metrics.

Additional get methods are included on top of the device detection methods to return Hash specific metrics.

The key used to get the value for a property can be either the name of the property, or the index of the property in the required properties structure.

Results instances should only be created by an Engine.

Usage Example

using namespace FiftyoneDegrees::DeviceDetection::Hash;

ResultsHash *results;

// Get the maximum drift used to arrive at the result

int drift = results->getDrift();

// Delete the results

delete results;

Examples: Hash/GettingStarted.cpp, Hash/MatchMetrics.cpp, and Hash/StronglyTyped.cpp.

Inheritance diagram for FiftyoneDegrees::DeviceDetection::Hash::ResultsHash:

[legend]

Collaboration diagram for FiftyoneDegrees::DeviceDetection::Hash::ResultsHash:

[legend]

Public Member Functions

Constructors and Destructors
	ResultsHash (fiftyoneDegreesResultsHash *results, shared_ptr< fiftyoneDegreesResourceManager > manager) Create a new instance of Results from the results structure provided. More...
virtual	~ResultsHash () Release the reference to the underlying results and and associated data set.
Metric Getters
string	getDeviceId (uint32_t resultIndex) Returns the unique device id if the Id property was included in the required list of properties when the Provider was constructed. More...
int	getIterations () Get the number of iterations carried out in order to find a match. More...
int	getDrift () Returns the maximum drift for a matched substring from the character position where it was expected to be found. More...
int	getDrift (uint32_t resultIndex) Returns the drift for a matched substring from the character position where it was expected to be found. More...
int	getMatchedNodes () Returns the number of hash nodes matched within the evidence. More...
int	getDifference () Returns the total difference between the results returned and the target User-Agents. More...
int	getDifference (uint32_t resultIndex) Returns the difference between the result returned and the target User-Agent. More...
int	getMethod () Returns the method used to determine the match result. More...
int	getMethod (uint32_t resultIndex) Returns the method used to determine the match result. More...
string	getTrace () Get the trace route in a readable format showing the hash nodes which were visited during processing. More...
string	getTrace (uint32_t resultIndex) Get the trace route in a readable format for the result index specified showing the hash nodes which were visited during processing. More...
DeviceDetection::ResultsDeviceDetection Implementation
string	getDeviceId () Returns the unique device id if the Id property was included in the required list of properties when the Provider was constructed. More...
int	getUserAgents () Returns the number of different User-Agents that were used in the results. More...
string	getUserAgent (int resultIndex) Returns relevant parts of the User-Agent which most closely matched the target User-Agent if the ConfigDeviceDetection::setUpdateMatchedUserAgent flag was set to true in the configuration. More...
Public Member Functions inherited from FiftyoneDegrees::DeviceDetection::ResultsDeviceDetection
	ResultsDeviceDetection (fiftyoneDegreesResultsDeviceDetection *results, shared_ptr< fiftyoneDegreesResourceManager > manager) Create a new instance of Results from the results structure provided. More...
Public Member Functions inherited from FiftyoneDegrees::Common::ResultsBase
	ResultsBase (fiftyoneDegreesResultsBase *results, shared_ptr< fiftyoneDegreesResourceManager > manager) Create a new instance of Results from the results structure provided. More...
virtual	~ResultsBase () Free any memory associated with the results and release any resource handles.
int	getAvailableProperties () Get the number of available properties contained in the Results instance. More...
bool	containsProperty (const string &propertyName) Get whether or not this results instance contains a value for the requested property. More...
vector< string >	getProperties () Get the names of the properties which are available in the Results instance. More...
string	getPropertyName (int requiredPropertyIndex) Get the name of the property at the require property index, or an empty string if the required property index is invalid. More...
Value< vector< string > >	getValues (const char *propertyName) Get a vector with all values associated with the required property name. More...
Value< vector< string > >	getValues (const string &propertyName) Get a vector with all values associated with the required property name. More...
Value< vector< string > >	getValues (const string *propertyName) Get a vector with all values associated with the required property name. More...
Value< vector< string > >	getValues (int requiredPropertyIndex) Get a vector with all values associated with the required property index. More...
Value< string >	getValueAsString (const char *propertyName) Get a string representation of the value associated with the required property name. More...
Value< string >	getValueAsString (const string &propertyName) Get a string representation of the value associated with the required property name. More...
Value< string >	getValueAsString (const string *propertyName) Get a string representation of the value associated with the required property name. More...
Value< string >	getValueAsString (int requiredPropertyIndex) Get a string representation of the value associated with the required property index. More...
Value< bool >	getValueAsBool (const char *propertyName) Get a boolean representation of the value associated with the required property name. More...
Value< bool >	getValueAsBool (const string &propertyName) Get a boolean representation of the value associated with the required property name. More...
Value< bool >	getValueAsBool (const string *propertyName) Get a boolean representation of the value associated with the required property name. More...
Value< bool >	getValueAsBool (int requiredPropertyIndex) Get a boolean representation of the value associated with the required property index. More...
Value< int >	getValueAsInteger (const char *propertyName) Get an integer representation of the value associated with the required property name. More...
Value< int >	getValueAsInteger (const string &propertyName) Get an integer representation of the value associated with the required property name. More...
Value< int >	getValueAsInteger (const string *propertyName) Get an integer representation of the value associated with the required property name. More...
Value< int >	getValueAsInteger (int requiredPropertyIndex) Get an integer representation of the value associated with the required property index. More...
Value< double >	getValueAsDouble (const char *propertyName) Get a double representation of the value associated with the required property name. More...
Value< double >	getValueAsDouble (const string &propertyName) Get a double representation of the value associated with the required property name. More...
Value< double >	getValueAsDouble (const string *propertyName) Get a double representation of the value associated with the required property name. More...
Value< double >	getValueAsDouble (int requiredPropertyIndex) Get a double representation of the value associated with the required property index. More...

Protected Member Functions

void	getValuesInternal (int requiredPropertyIndex, vector< string > &values) Get the values for the index in required properties and add them to the values vector supplied. More...
bool	hasValuesInternal (int requiredPropertyIndex) Get whether or not there are valid values available for the property identified by its index in the required properties. More...
const char *	getNoValueMessageInternal (fiftyoneDegreesResultsNoValueReason reason) Get the message explaining the reason for missing values. More...
fiftyoneDegreesResultsNoValueReason	getNoValueReasonInternal (int requiredPropertyIndex) Get the reason for values not being available. More...
Protected Member Functions inherited from FiftyoneDegrees::Common::ResultsBase
int	getRequiredPropertyIndex (const char *propertyName) Get the index in the available properties for the property name provided. More...

Friends

class ::EngineHashTests

Constructor & Destructor Documentation

◆ ResultsHash()

FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::ResultsHash	(	fiftyoneDegreesResultsHash *	results,
		shared_ptr< fiftyoneDegreesResourceManager >	manager
	)

Create a new instance of Results from the results structure provided.

This method should only be called from inside an engine's process method.

Parameters: results - pointer to the underlying results structure; manager - shared pointer to the manager which manages the data set used to create the results. This is needed for thread-safe operation, see local variable description for more info.

Member Function Documentation

◆ getDeviceId() [1/2]

string FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getDeviceId

(

uint32_t

resultIndex

)

Returns the unique device id if the Id property was included in the required list of properties when the Provider was constructed.

Parameters: resultIndex - index of the individual User-Agent in the results

Returns: device id string

Examples: Hash/MatchMetrics.cpp.

◆ getDeviceId() [2/2]

string FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getDeviceId

(

)

virtual

Returns the unique device id if the Id property was included in the required list of properties when the Provider was constructed.

Returns: profile ids separated with a '-' character

Implements FiftyoneDegrees::DeviceDetection::ResultsDeviceDetection.

◆ getDifference() [1/2]

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getDifference

(

)

Returns the total difference between the results returned and the target User-Agents.

Where multiple evidence items are used, this is the total difference.

Returns: total difference

Examples: Hash/MatchMetrics.cpp.

◆ getDifference() [2/2]

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getDifference

(

uint32_t

resultIndex

)

Returns the difference between the result returned and the target User-Agent.

Parameters: resultIndex - index of the individual User-Agent in the results

Returns: individual difference

◆ getDrift() [1/2]

ResultsDeviceDetection.

◆ getDifference() [1/2]

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getDifference

(

)

Returns the total difference between the results returned and the target User-Agents.

Where multiple evidence items are used, this is the total difference.

Returns: total difference

Examples: Hash/MatchMetrics.cpp.

◆ getDifference() [2/2]

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getDifference

(

uint32_t

resultIndex

)

Returns the difference between the result returned and the target User-Agent.

Parameters: resultIndex - index of the individual User-Agent in the results

Returns: individual difference

◆ getDrift() [1/2]

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getDrift

(

)

Returns the maximum drift for a matched substring from the character position where it was expected to be found.

The higher this value, the less accurate the results should be considered.

Returns: int maximum drift

Examples: Hash/MatchMetrics.cpp.

◆ getDrift() [2/2]

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getDrift

(

uint32_t

resultIndex

)

Returns the drift for a matched substring from the character position where it was expected to be found.

The higher this value, the lass accurate the results should be considered.

Parameters: resultIndex - index of the individual User-Agent in the results

Returns: individual drift

◆ getIterations()

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getIterations

(

)

Get the number of iterations carried out in order to find a match.

This is the number of nodes in the graph which have been visited.

Returns: number of iterations

Examples: Hash/MatchMetrics.cpp.

◆ getMatchedNodes()

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getMatchedNodes

(

)

Returns the number of hash nodes matched within the evidence.

Returns

◆ getMethod() [1/2]

int FiftyoneDegrees::DeviceDetection::Hash::ResultsHash::getMethod

(

)

Returns the method used to determine the match result.

See fiftyoneDegreesHashMatchMethod

Returns: highest method used

Examples: Hash/MatchMetrics.cpp.

51Degrees Device Detection C/C++ 4.1Newer Version 4.2

FiftyoneDegrees::DeviceDetection::Hash::ResultsHash Class Reference

Detailed Description

Usage Example

Inheritance diagram for FiftyoneDegrees::DeviceDetection::Hash::ResultsHash:

Collaboration diagram for FiftyoneDegrees::DeviceDetection::Hash::ResultsHash:

Public Member Functions

Constructors and Destructors

Metric Getters

DeviceDetection::ResultsDeviceDetection Implementation

Public Member Functions inherited from FiftyoneDegrees::DeviceDetection::ResultsDeviceDetection

Public Member Functions inherited from FiftyoneDegrees::Common::ResultsBase

Protected Member Functions

Protected Member Functions inherited from FiftyoneDegrees::Common::ResultsBase

Friends

Constructor & Destructor Documentation

◆ ResultsHash()

Member Function Documentation

◆ getDeviceId() [1/2]

◆ getDeviceId() [2/2]

◆ getDifference() [1/2]

◆ getDifference() [2/2]

◆ getDrift() [1/2]

◆ getDifference() [1/2]

◆ getDifference() [2/2]

◆ getDrift() [1/2]

◆ getDrift() [2/2]

◆ getIterations()

◆ getMatchedNodes()

◆ getMethod() [1/2]

◆ getMethod() [2/2]