Class FlowFieldBoundary
A class to represent a flow field boundary
Namespace: Scripting
Syntax
public class FlowFieldBoundary
Constructors
FlowFieldBoundary(Location, Double, Double)
Creates an instance of the FlowFieldBoundary class.
Declaration
public FlowFieldBoundary(Location northWestLocation, double width, double height)
Parameters
Type | Name | Description |
---|---|---|
Location | northWestLocation | The north west corner coordinate. |
System.Double | width | The width. |
System.Double | height | The height. |
FlowFieldBoundary(Location, Double, Double, Double)
Creates an instance of the FlowFieldBoundary class.
Declaration
public FlowFieldBoundary(Location northWestLocation, double width, double height, double resolution)
Parameters
Type | Name | Description |
---|---|---|
Location | northWestLocation | The north west corner coordinate. |
System.Double | width | The width. |
System.Double | height | The height. |
System.Double | resolution | The grid resolution. |
FlowFieldBoundary(IList<IReadable2DLocation>)
Creates an instance of the FlowFieldBoundary class.
Declaration
public FlowFieldBoundary(IList<IReadable2DLocation> locations)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<IReadable2DLocation> | locations | A list of point locations. |
FlowFieldBoundary(IList<IReadable2DLocation>, Double)
Creates an instance of the FlowFieldBoundary class.
Declaration
public FlowFieldBoundary(IList<IReadable2DLocation> locations, double resolution)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<IReadable2DLocation> | locations | A list of point locations. |
System.Double | resolution | The grid resolution. |
FlowFieldBoundary(String, Location, Double, Double)
Creates an instance of the FlowFieldBoundary class.
Declaration
public FlowFieldBoundary(string name, Location northWestLocation, double width, double height)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the boundary. |
Location | northWestLocation | The north west corner coordinate. |
System.Double | width | The width. |
System.Double | height | The height. |
FlowFieldBoundary(String, Location, Double, Double, Double)
Creates an instance of the FlowFieldBoundary class.
Declaration
public FlowFieldBoundary(string name, Location northWestLocation, double width, double height, double resolution)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the boundary. |
Location | northWestLocation | The north west corner coordinate. |
System.Double | width | The width. |
System.Double | height | The height. |
System.Double | resolution | The grid resolution. |
FlowFieldBoundary(String, IList<IReadable2DLocation>)
Creates an instance of the FlowFieldBoundary class.
Declaration
public FlowFieldBoundary(string name, IList<IReadable2DLocation> locations)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the boundary. |
System.Collections.Generic.IList<IReadable2DLocation> | locations | A list of point locations. |
FlowFieldBoundary(String, IList<IReadable2DLocation>, Double)
Creates an instance of the FlowFieldBoundary class.
Declaration
public FlowFieldBoundary(string name, IList<IReadable2DLocation> locations, double resolution)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the boundary. |
System.Collections.Generic.IList<IReadable2DLocation> | locations | A list of point locations. |
System.Double | resolution | The grid resolution. |
Properties
Height
Declaration
public double Height { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Name
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
NorthWestCoordinates
Gets and sets the location of the mast
Declaration
public I2DLocation NorthWestCoordinates { get; set; }
Property Value
Type | Description |
---|---|
I2DLocation |
Resolution
Declaration
public double Resolution { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Width
Declaration
public double Width { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Methods
Equals(FlowFieldBoundary)
Tests a FlowFieldBoundary against this current FlowFieldBoundary for equality.
Declaration
public bool Equals(FlowFieldBoundary val)
Parameters
Type | Name | Description |
---|---|---|
FlowFieldBoundary | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current FlowFieldBoundary for equality.
Declaration
public override bool Equals(object toCompare)
Parameters
Type | Name | Description |
---|---|---|
System.Object | toCompare |
Returns
Type | Description |
---|---|
System.Boolean | True if object is equal otherwise false is returned. |
Overrides
GetHashCode()
Gets the hash code for this object.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | The hash code for this object. |
Overrides
Operators
Equality(FlowFieldBoundary, FlowFieldBoundary)
Tests a FlowFieldBoundary against this current FlowFieldBoundary for equality.
Declaration
public static bool operator ==(FlowFieldBoundary a, FlowFieldBoundary b)
Parameters
Type | Name | Description |
---|---|---|
FlowFieldBoundary | a | |
FlowFieldBoundary | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(FlowFieldBoundary, FlowFieldBoundary)
Tests a FlowFieldBoundary against this current FlowFieldBoundary for inequality.
Declaration
public static bool operator !=(FlowFieldBoundary a, FlowFieldBoundary b)
Parameters
Type | Name | Description |
---|---|---|
FlowFieldBoundary | a | |
FlowFieldBoundary | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |