◆ AspectDataBase() [1/3]
| FiftyOne.Pipeline.Engines.Data.AspectDataBase.AspectDataBase | ( | ILogger< AspectDataBase > | logger, |
| IPipeline | pipeline, | ||
| IAspectEngine | engine | ||
| ) |
Constructor
- Parameters
-
- logger - Used for logging
- pipeline - The IPipeline instance this element data will be associated with.
- engine - The IAspectEngine that created this instance
◆ AspectDataBase() [2/3]
FiftyOne.Pipeline.Engines.Data.AspectDataBase.AspectDataBase ( ILogger< AspectDataBase > logger, IPipeline pipeline, IAspectEngine engine, IMissingPropertyService missingPropertyService ) Constructor
- Parameters
-
- logger - Used for logging
- pipeline - The IPipeline instance this element data will be associated with.
- engine - The IAspectEngine that created this instance
- missingPropertyService - The IMissingPropertyService to use when a requested key cannot be found.
◆ AspectDataBase() [3/3]
FiftyOne.Pipeline.Engines.Data.AspectDataBase.AspectDataBase ( ILogger< AspectDataBase > logger, IPipeline pipeline, IAspectEngine engine, IMissingPropertyService missingPropertyService, IDictionary< string, object > dictionary ) Constructor
- Parameters
-
- logger - Used for logging
- pipeline - The IPipeline instance this element data will be associated with.
- engine - The IAspectEngine that created this instance
- missingPropertyService - The IMissingPropertyService to use when a requested key cannot be found.
- dictionary - The dictionary instance to use internally when storing data values.
Member Function Documentation
◆ AsDictionary()
override IReadOnlyDictionary<string, object> FiftyOne.Pipeline.Engines.Data.AspectDataBase.AsDictionary ( ) virtualGet the data contained in this instance as an IReadOnlyDictionary<TKey, TValue>.
- Exceptions
-
- OperationCanceledException - Thrown if lazy loading is enabled and the cancellation token has been used to cancel processing before it was completed.
- Exceptions
-
- TimeoutException - Thrown if lazy loading is enabled and processing did not complete before the configured timeout expired.
- AggregateException - Thrown if lazy loading is enabled and multiple errors occurred during processing.
Reimplemented from FiftyOne.Pipeline.Core.Data.DataBase.
◆ GetAs< T >()
override T FiftyOne.Pipeline.Engines.Data.AspectDataBase.GetAs< T > ( string key ) protected virtualGet the value for the specified property as the specified type.
This overrides the default implementation to provide additional capabilities such as lazy loading and exposing a reason for
properties that are not present in the data.
- Template Parameters
-
- T - The type to return
- Parameters
-
- key - The key of the property to get
- Returns
- The value for the specified property.
- Exceptions
-
- ArgumentNullException - Thrown if key is null.
- PropertyMissingException - Thrown if there is no entry matching the specified key.
- OperationCanceledException - Thrown if lazy loading is enabled and the cancellation token has been used to cancel processing before it was completed.
- TimeoutException - Thrown if lazy loading is enabled and processing did not complete before the configured timeout expired.
- AggregateException - Thrown if lazy loading is enabled and multiple errors occurred during processing.
Reimplemented from FiftyOne.Pipeline.Core.Data.DataBase.
◆ TryGetValue< T >()
virtual bool FiftyOne.Pipeline.Engines.Data.AspectDataBase.TryGetValue< T > ( string key, out T value ) protected virtualGet the value associated with the specified key.
Inheriting classes can override this method where they access data in different ways.
- Parameters
-
- key - The string key to retrieve the value for.
- value - Will be populated with the value for the specified key.
- Returns
- True if the key is present in the data store, false if not.
Property Documentation
◆ Engines
IReadOnlyList<IAspectEngine> FiftyOne.Pipeline.Engines.Data.AspectDataBase.Engines getThe engine that generated this data instance.
◆ Logger
ILogger<AspectDataBase> FiftyOne.Pipeline.Engines.Data.AspectDataBase.Logger get protectedThe logger to be used by this instance.
◆ MissingPropertyService
IMissingPropertyService FiftyOne.Pipeline.Engines.Data.AspectDataBase.MissingPropertyService get protectedThe IMissingPropertyService instance to be queried when there is no entry for a requested key.
◆ ProcessTask
Task FiftyOne.Pipeline.Engines.Data.AspectDataBase.ProcessTask getIf the engine is configured for lazy loading, this property returns a task that will complete once the engine has finished processing.
Otherwise, it will be null.
◆ this[string key]
override object FiftyOne.Pipeline.Engines.Data.AspectDataBase.this[string key] getget or set the specified value
- Parameters
-
- key - The key/name of the property to get or set.
- Returns
- The property value.
- Exceptions
-
- PropertyMissingException - Thrown if there is no entry for the specified key.