51Degrees Device Detection .NET  4.1

Device detection services for 51Degrees Pipeline

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

Detailed Description

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

A component is a logical group of properties for example, all properties relating to the hardware device or all properties relating to the web browser. This variation is used for meta-data that is generated by the native C/C++ code using the information in the data file.

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

[legend]

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

[legend]

Public Member Functions

IEnumerable< IFiftyOneAspectPropertyMetaData >  GetProperties ()
Get the meta-data for all properties that are associated with this component. More...
IFiftyOneAspectPropertyMetaData  GetProperty (string propertyName)
Get the meta-data for the specified property. More...
void  Dispose ()
Dispose More...
override int  GetHashCode ()
Get a hash code for this component More...
bool  Equals (IComponentMetaData other)
Check if this component is equal to another IComponentMetaData instance. More...
int  CompareTo (IComponentMetaData other)
Compare this instance to another object that implements IComponentMetaData. More...
override string  ToString ()
Return a string representation of this instance. More...

Public Attributes

IProfileMetaData  DefaultProfile
The default profile for this component. More...
IReadOnlyList< IFiftyOneAspectPropertyMetaData >  Properties
Get the meta-data for all properties associated with this component. More...
string  Name => _source.getName()
The name of this component. More...
byte  ComponentId => (byte)_source.getComponentIdAsInt()
The id number for this component. More...

Protected Member Functions

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

Member Function Documentation

◆ CompareTo()

int FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.CompareTo ( IComponentMetaData   other )

Compare this instance to another object that implements IComponentMetaData.

Parameters
other - The IComponentMetaData 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.ComponentMetaData.Dispose ( bool   disposing )
protected virtual

Dispose

Parameters
disposing - Will be false if called from finalizer

◆ Dispose() [2/2]

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

Dispose

◆ Equals()

bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.Equals ( IComponentMetaData   other )

Check if this component is equal to another IComponentMetaData instance.

Parameters
other - The other instance to check for equality.
Returns
True if the instances are equal. False if not.

◆ GetHashCode()

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

Get a hash code for this component

Returns

◆ GetProperties()

IEnumerable<IFiftyOneAspectPropertyMetaData> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.GetProperties ( )

Get the meta-data for all properties that are associated with this component.

Returns
Meta-data for all properties that are associated with this component.

◆ GetProperty()

IFiftyOneAspectPropertyMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.GetProperty ( string   propertyName )

Get the meta-data for the specified property.

Parameters
propertyName - The name of the property to get the meta-data for.
Returns
The meta-data for the specified property.

◆ ToString()

override string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.ToString ( )

Return a string representation of this instance.

Returns
A string representation of this instance.

Member Data Documentation

◆ ComponentId

byte FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.ComponentId => (byte)_source.getComponentIdAsInt()

The id number for this component.

◆ DefaultProfile

IProfileMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.DefaultProfile
Initial value:
=> new ProfileMetaData(
_engine,
_engine.MetaData.getDefaultProfileForComponent(_source))

The default profile for this component.

◆ Name

string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.Name => _source.getName()

The name of this component.

◆ Properties

IReadOnlyList<IFiftyOneAspectPropertyMetaData> FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ComponentMetaData.Properties
Initial value:
=>
GetProperties().ToList()

Get the meta-data for all properties associated with this component.