◆ GetProperties()
| IEnumerable<IFiftyOneAspectPropertyMetaData> FiftyOne.Pipeline.Engines.FiftyOne.Data.IComponentMetaData.GetProperties | ( | ) |
Get the properties which come under the umbrella of this component.
- Returns
- Properties enumerable
Detailed Description
Meta data relating to a component of an Engine's results e.g.
Hardware. See the Specification
Inheritance diagram for FiftyOne.Pipeline.Engines.FiftyOne.Data.IComponentMetaData:
Collaboration diagram for FiftyOne.Pipeline.Engines.FiftyOne.Data.IComponentMetaData:
Public Member Functions
| IEnumerable< IFiftyOneAspectPropertyMetaData > | GetProperties ()
Get the properties which come under the umbrella of this component. More...
|
| IFiftyOneAspectPropertyMetaData | GetProperty (string propertyName)
Get the property from the component which has the name provided. More...
|
Properties
| byte | ComponentId [get]
The unique Id of the component. More...
|
| string | Name [get]
The name of the component. More...
|
| IProfileMetaData | DefaultProfile [get]
The default profile which is used by the Engine for this component. More...
|
| IReadOnlyList< IFiftyOneAspectPropertyMetaData > | Properties [get]
List of the properties which come under the umbrella of this component. More...
|
Member Function Documentation
◆ GetProperty()
| IFiftyOneAspectPropertyMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IComponentMetaData.GetProperty | ( | string | propertyName | ) |
Get the property from the component which has the name provided.
Null is returned if the component does not contain a property with the name provided
- Parameters
-
- propertyName - Name of the property to return
- Returns
- The property or null if not in this component
Property Documentation
◆ ComponentId
| byte FiftyOne.Pipeline.Engines.FiftyOne.Data.IComponentMetaData.ComponentId |
get
The unique Id of the component.
◆ DefaultProfile
| IProfileMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IComponentMetaData.DefaultProfile |
get
The default profile which is used by the Engine for this component.
◆ Name
| string FiftyOne.Pipeline.Engines.FiftyOne.Data.IComponentMetaData.Name |
get
The name of the component.
◆ Properties
| IReadOnlyList<IFiftyOneAspectPropertyMetaData> FiftyOne.Pipeline.Engines.FiftyOne.Data.IComponentMetaData.Properties |
get
List of the properties which come under the umbrella of this component.