Class StacPropertiesContainerExtension

Abstract class for a generic extension based on a STAC object that implements IStacPropertiesContainer This is a base for building an extension based on new fields for an object having a properties

Inheritance

System.Object

StacPropertiesContainerExtension

AlternateStacExtension

DatacubeStacExtension

DisastersCharterStacExtension

EoStacExtension

FileStacExtension

ProcessingStacExtension

ProjectionStacExtension

RasterStacExtension

SarStacExtension

SatStacExtension

SchemaBasedStacExtension

StorageStacExtension

VersionStacExtension

ViewStacExtension

VirtualAssetsStacExtension

Implements

IStacExtension

Namespace: Stac.Extensions

Assembly: DotNetStac.dll

Syntax

public abstract class StacPropertiesContainerExtension : object, IStacExtension

Constructors

StacPropertiesContainerExtension(String, IStacPropertiesContainer)

Initializes a new instance of the StacPropertiesContainerExtension class.

Declaration

protected StacPropertiesContainerExtension(string identifier, IStacPropertiesContainer stacPropertiesContainer)

Parameters

Type	Name	Description
System.String	identifier	Identifier of the extension
IStacPropertiesContainer	stacPropertiesContainer	STAC object

Properties

Identifier

Gets identifier of the extension

Declaration

public virtual string Identifier { get; }

Property Value

Type	Description
System.String	Identifier of the extension

IsDeclared

Gets a value indicating whether indicate if the extension is already declared

Declaration

public bool IsDeclared { get; }

Property Value

Type	Description
System.Boolean	Indicate if the extension is already declared

ItemFields

Gets get the potential fields of the extensions and their type

Declaration

public abstract IDictionary<string, Type> ItemFields { get; }

Property Value

Type	Description
IDictionary<System.String, Type>	Get the potential fields of the extensions and their type

StacPropertiesContainer

Gets stac Object extended by the extension

Declaration

public IStacPropertiesContainer StacPropertiesContainer { get; }

Property Value

Type	Description
IStacPropertiesContainer	Stac Object extended by the extension

Methods

CreateRangeSummaryObject<T>(IEnumerable<T>)

Generic method to summarize in a range any ordinal object

Declaration

public static IStacSummaryItem CreateRangeSummaryObject<T>(IEnumerable<T> arg)

Parameters

Type	Name	Description
IEnumerable<T>	arg	ordinal object

Returns

Type	Description
IStacSummaryItem	Range summary object

Type Parameters

Name	Description
T	Type of the object

CreateSummaryValueSet<T>(IEnumerable<T>)

Generic method to summarize in a value set an array of object

Declaration

public static StacSummaryValueSet<T> CreateSummaryValueSet<T>(IEnumerable<T> arg)

Parameters

Type	Name	Description
IEnumerable<T>	arg	array of object

Returns

Type	Description
StacSummaryValueSet<T>	Value set summary object

Type Parameters

Name	Description
T	Type of the object

DeclareStacExtension()

Declares the extension in the STAC object

Declaration

protected void DeclareStacExtension()

GetSummaryFunctions()

Get he potential summary functions for each field that can be summarized

Declaration

public virtual IDictionary<string, ISummaryFunction> GetSummaryFunctions()

Returns

Type	Description
IDictionary<System.String, ISummaryFunction>	Dictionary of summary functions

RemoveProperty(String)

Remove a property in the container

Declaration

public void RemoveProperty(string key)

Parameters

Type	Name	Description
System.String	key	Key of the property

RemoveStacExtension()

Remove the extension in the STAC object

Declaration

protected void RemoveStacExtension()

SetProperty(String, Object)

Set a property in the container

Declaration

public void SetProperty(string key, object value)

Parameters

Type	Name	Description
System.String	key	Key of the property
System.Object	value	Value of the property

Implements

IStacExtension

Extension Methods

StacAccessorsHelpers.ToStringByAttributes(Object)