51Degrees Device Detection .NET  4.1

Device detection services for 51Degrees Pipeline

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

Detailed Description

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

This implementation of the IValueMetaData 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.ValueMetaData:

[legend]

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

[legend]

Public Member Functions

IFiftyOneAspectPropertyMetaData  GetProperty ()
Get the property that this value instance is associated with. More...
void  Dispose ()
Dispose More...
override int  GetHashCode ()
Get a hash code for this instance. More...
bool  Equals (IValueMetaData other)
Check if this instance is equal to another object that implements IValueMetaData. More...
int  CompareTo (IValueMetaData other)
Compare this instance with another object that implements IValueMetaData More...
override string  ToString ()
Returns a string representation of this value. More...

Public Attributes

IFiftyOneAspectPropertyMetaData  Property => GetProperty()
Get the meta-data for the property associated with this value instance. More...
string  Name => _source.getName()
The value More...
string  Description => _source.getDescription()
A description of this value. More...
string  Url => _source.getUrl()
A URL to get more information on this value. More...

Protected Member Functions

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

Member Function Documentation

◆ CompareTo()

int FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ValueMetaData.CompareTo ( IValueMetaData   other )

Compare this instance with another object that implements IValueMetaData

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

Dispose

Parameters
disposing - False if called from finalizer

◆ Dispose() [2/2]

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

Dispose

◆ Equals()

bool FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ValueMetaData.Equals ( IValueMetaData   other )

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

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

◆ GetHashCode()

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

Get a hash code for this instance.

The value-space is greater than the key-space so hash collisions are possible and may need to be accounted for, depending on your use-case.

Returns
A hash code.

◆ GetProperty()

IFiftyOneAspectPropertyMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ValueMetaData.GetProperty ( )

Get the property that this value instance is associated with.

Returns
The meta-data for the property this value is associated with.

◆ ToString()

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

Returns a string representation of this value.

Returns
A string representation of this value.

Member Data Documentation

◆ Description

string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ValueMetaData.Description => _source.getDescription()

A description of this value.

◆ Name

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

The value

◆ Property

IFiftyOneAspectPropertyMetaData FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ValueMetaData.Property => GetProperty()

Get the meta-data for the property associated with this value instance.

◆ Url

string FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Data.ValueMetaData.Url => _source.getUrl()

A URL to get more information on this value.