Class InitiationRegion
Implements
Namespace: Scripting
Syntax
public class InitiationRegion : INamedItem
Constructors
InitiationRegion(String, InitiationRegion)
Construct an InitiationRegion. Sets the mast assignment mode to nearest mast.
Declaration
public InitiationRegion(string name, InitiationRegion regionToClone)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the region |
InitiationRegion | regionToClone | An Initiation Region to construct this initiation region from |
InitiationRegion(String, InitiationRegion, MeasurementSite)
Construct an InitiationRegion
Declaration
public InitiationRegion(string name, InitiationRegion regionToClone, MeasurementSite measurementSite)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the region |
InitiationRegion | regionToClone | An Initiation Region to construct this initiation region from |
MeasurementSite | measurementSite | The measurement site to assign to this region |
InitiationRegion(String, Region)
Construct an InitiationRegion. Sets the mast assignment mode to nearest mast.
Declaration
public InitiationRegion(string name, Region regionToClone)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the region |
Region | regionToClone | A Region to construct this initiation region from (copies the points) |
InitiationRegion(String, Region, MeasurementSite)
Construct an InitiationRegion
Declaration
public InitiationRegion(string name, Region regionToClone, MeasurementSite measurementSite)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the region |
Region | regionToClone | A Region to construct this initiation region from (copies the points) |
MeasurementSite | measurementSite | The measurement site to assign to this region |
InitiationRegion(String, IEnumerable<IReadable2DLocation>)
Construct an InitiationRegion. Sets the mast assignment mode to nearest mast.
Declaration
public InitiationRegion(string name, IEnumerable<IReadable2DLocation> points)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the region |
System.Collections.Generic.IEnumerable<IReadable2DLocation> | points | The list of points defining the region |
InitiationRegion(String, IEnumerable<IReadable2DLocation>, MeasurementSite)
Construct an InitiationRegion
Declaration
public InitiationRegion(string name, IEnumerable<IReadable2DLocation> points, MeasurementSite measurementSite)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the region |
System.Collections.Generic.IEnumerable<IReadable2DLocation> | points | The list of points defining the region |
MeasurementSite | measurementSite | The measurement site to assign to this region |
Properties
Name
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
Equals(InitiationRegion)
Tests a InitiationRegion against this current InitiationRegion for equality.
Declaration
public bool Equals(InitiationRegion val)
Parameters
Type | Name | Description |
---|---|---|
InitiationRegion | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current InitiationRegion 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(InitiationRegion, InitiationRegion)
Tests a InitiationRegion against this current InitiationRegion for equality.
Declaration
public static bool operator ==(InitiationRegion a, InitiationRegion b)
Parameters
Type | Name | Description |
---|---|---|
InitiationRegion | a | |
InitiationRegion | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(InitiationRegion, InitiationRegion)
Tests a InitiationRegion against this current InitiationRegion for inequality.
Declaration
public static bool operator !=(InitiationRegion a, InitiationRegion b)
Parameters
Type | Name | Description |
---|---|---|
InitiationRegion | a | |
InitiationRegion | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |