51Degrees Device Detection .NET  4.1

Device detection services for 51Degrees Pipeline

FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData Class Reference

Detailed Description

Data class that contains meta-data relating to a specific profile.

A profile is a set of specific property values for an individual component. For example, the Apple iPhone 8 has a profile that contains values for all the hardware component properties. This implementation of the IProfileMetaData interface is used for meta-data that is generated by the native C/C++ code from information in the data file.

Inheritance diagram for FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData:

[legend]

Collaboration diagram for FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData:

[legend]

Public Member Functions

IEnumerable< IValueMetaData >  GetValues ()
Get the meta-data for all values associated with this profile. More...
void  Dispose ()
Dispose More...
override int  GetHashCode ()
Get a hash code for this profile More...
bool  Equals (IProfileMetaData other)
Check if this instance is equal to another object that implements IProfileMetaData. More...
int  CompareTo (IProfileMetaData other)
Compare this instance to another object that implements IProfileMetaData. More...
IEnumerable< IValueMetaData >  GetValues (string propertyName)
Get the meta-data for values from this profile for the specified property. More...
IValueMetaData  GetValue (string propertyName, string valueName)
Get the meta-data for the specified property and value from this profile. More...

Public Attributes

uint  ProfileId => _source.getProfileId()
Get the id for this profile. More...
IComponentMetaData  Component
Get the meta-data for the component associated with this profile. More...

Protected Member Functions

virtual void  Dispose (bool disposing)
Dispose More...

Properties

string  Name [get]
Get the name of this profile. More...

Member Function Documentation

◆ CompareTo()

int FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.CompareTo ( IProfileMetaData   other )

Compare this instance to another object that implements IProfileMetaData.

Parameters
other - The IProfileMetaData instance to compare to.
Returns
>0 if this instance precedes other in the sort order. 0 if they are equal in the sort order. <0 if other precedes this instance in the sort order.

◆ Dispose() [1/2]

virtual void FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.Dispose ( bool   disposing )
protected virtual

Dispose

Parameters
disposing - False if called from finalizer

◆ Dispose() [2/2]

void FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.Dispose ( )

Dispose

◆ Equals()

bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.Equals ( IProfileMetaData   other )

Check if this instance is equal to another object that implements IProfileMetaData.

Parameters
other - The IProfileMetaData to check for equality
Returns
True if the two instances are equal. False otherwise

◆ GetHashCode()

override int FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.GetHashCode ( )

Get a hash code for this profile

Returns

◆ GetValue()

IValueMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.GetValue ( string   propertyName,
string   valueName  
)

Get the meta-data for the specified property and value from this profile.

Parameters
propertyName - The name of the property to get the meta-data for.
valueName - The value to get the meta-data for.
Returns
The value meta-data for the specified value if it exists on this profile.

◆ GetValues() [1/2]

IEnumerable<IValueMetaData> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.GetValues ( )

Get the meta-data for all values associated with this profile.

Returns
The meta-data for all values associated with this profile.

◆ GetValues() [2/2]

IEnumerable<IValueMetaData> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.GetValues ( string   propertyName )

Get the meta-data for values from this profile for the specified property.

Parameters
propertyName - The name of the property to get values for.
Returns
The value meta-data for the specified property on this profile.

Member Data Documentation

◆ Component

IComponentMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.Component
Initial value:
=> new ComponentMetaData(
_engine,
_engine.MetaData.getComponentForProfile(_source))

Get the meta-data for the component associated with this profile.

◆ ProfileId

uint FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.ProfileId => _source.getProfileId()

Get the id for this profile.

The id number is guaranteed to stay the same for a profile regardless of data updates and API version changes.

Property Documentation

◆ Name

string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ProfileMetaData.Name
get

Get the name of this profile.