51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData Interface Reference

Detailed Description

Meta data relating to a profile within the data set.

Inheritance diagram for FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData:

[legend]

Public Member Functions

IEnumerable< IValueMetaData >  GetValues ()
The values which are defined in the profile (for some Engines multiple profiles are required to build a full set of results). More...
IEnumerable< IValueMetaData >  GetValues (string propertyName)
Gets the values associated with the profile and the property name. More...
IValueMetaData  GetValue (string propertyName, string valueName)
If there is a value for the profile with the property name and value then return an instance of it. More...

Properties

uint  ProfileId [get]
Unique id of the profile. More...
IComponentMetaData  Component [get]
The component which the profile belongs to. More...
string  Name [get]
The name of the profile. More...

Member Function Documentation

◆ GetValue()

IValueMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData.GetValue ( string   propertyName,
string   valueName  
)

If there is a value for the profile with the property name and value then return an instance of it.

Parameters
propertyName -
valueName -
Returns
Value instance for property and value, or null if doesn't exist

◆ GetValues() [1/2]

IEnumerable<IValueMetaData> FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData.GetValues ( )

The values which are defined in the profile (for some Engines multiple profiles are required to build a full set of results).

◆ GetValues() [2/2]

IEnumerable<IValueMetaData> FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData.GetValues ( string   propertyName )

Gets the values associated with the profile and the property name.

Parameters
propertyName -
Returns
Enumerable of values matching the property

Property Documentation

◆ Component

IComponentMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData.Component
get

The component which the profile belongs to.

◆ Name

string FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData.Name
get

The name of the profile.

Usually indicates the type of device.

◆ ProfileId

uint FiftyOne.Pipeline.Engines.FiftyOne.Data.IProfileMetaData.ProfileId
get

Unique id of the profile.