Class Receptor
Implements
Namespace: Scripting
Syntax
public class Receptor : INamedItem
Constructors
Receptor()
Creates an instance of the Receptor class.
Declaration
public Receptor()
Receptor(String, IReadable2DLocation, Double, Double, Double)
Initializes a new instance of the Receptor class.
Declaration
public Receptor(string name, IReadable2DLocation location, double bearing, double heightAboutGround, double tilt)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the receptor. |
IReadable2DLocation | location | The location of the receptor (in local coordinate system). |
System.Double | bearing | The bearing (in degrees clockwise from North). |
System.Double | heightAboutGround | The height about ground (in metres). |
System.Double | tilt | The tilt (in degrees - angle above the horizon). |
Properties
Bearing
Declaration
public double Bearing { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
HeightAboveGround
Declaration
public double HeightAboveGround { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Location
Gets and sets the location of the receptor
Declaration
public I2DLocation Location { get; set; }
Property Value
Type | Description |
---|---|
I2DLocation |
Name
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Tilt
Declaration
public double Tilt { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Methods
Equals(Receptor)
Declaration
public bool Equals(Receptor val)
Parameters
Type | Name | Description |
---|---|---|
Receptor | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current Receptor 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
System.Object.Equals(System.Object)
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
System.Object.GetHashCode()
Operators
Equality(Receptor, Receptor)
Declaration
public static bool operator ==(Receptor a, Receptor b)
Parameters
Type | Name | Description |
---|---|---|
Receptor | a | |
Receptor | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(Receptor, Receptor)
Declaration
public static bool operator !=(Receptor a, Receptor b)
Parameters
Type | Name | Description |
---|---|---|
Receptor | a | |
Receptor | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |