Class ReadOnlyWindClimateCollection<T>
A read-only collection of IWindClimate objects.
Implements
Namespace: Scripting
Syntax
public class ReadOnlyWindClimateCollection<T> : IEnumerable<T>, IEnumerable where T : IWindClimate
Type Parameters
Name | Description |
---|---|
T | The type of object in the collection (implements IWindClimate). |
Constructors
ReadOnlyWindClimateCollection(IEnumerable<T>)
Initializes a new instance of the ReadOnlyWindClimateCollection<T> class.
Declaration
public ReadOnlyWindClimateCollection(IEnumerable<T> enumeration)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<T> | enumeration | The enumeration of objects to initialise the collection with. |
Methods
GetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
public IEnumerator<T> GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerator<T> | A System.Collections.Generic.IEnumerator<T> that can be used to iterate through the collection. |
GetForHeightAboveGround(Double)
Gets an enumeration of the objects in the collection for the given height above ground.
Declaration
public IEnumerable<T> GetForHeightAboveGround(double heightAboveGround)
Parameters
Type | Name | Description |
---|---|---|
System.Double | heightAboveGround | The height above ground. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T> | An enumeration of the objects in the collection for the given height above ground. |
GetForMeasurementSite(String)
Gets an enumeration of the objects in the collection for the measurement site with the given name.
Declaration
public IEnumerable<T> GetForMeasurementSite(string measurementSiteName)
Parameters
Type | Name | Description |
---|---|---|
System.String | measurementSiteName | Name of the measurement site. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T> | An enumeration of the objects in the collection for the measurement site with the given name. |
GetSpecific(String, Double)
Gets the specific item in the collection with the given measurement name and height above ground.
Declaration
public T GetSpecific(string measurementSiteName, double heightAboveGround)
Parameters
Type | Name | Description |
---|---|---|
System.String | measurementSiteName | Name of the measurement site. |
System.Double | heightAboveGround | The height above ground. |
Returns
Type | Description |
---|---|
T | The specific item in the collection with the given measurement name and height above ground, or null if an object cannot be found with those specfications. |
Explicit Interface Implementations
IEnumerable.GetEnumerator()
Returns an enumerator that iterates through a collection.
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | An System.Collections.IEnumerator object that can be used to iterate through the collection. |