Class BoreHole

Namespace

FemDesign.Soil

Assembly

FemDesign.Core.dll

public class BoreHole : NamedEntityBase, IFemDesignEntity, INamedEntity

Inheritance

object

EntityBase

NamedEntityBase

BoreHole

Implements

IFemDesignEntity

INamedEntity

Inherited Members

NamedEntityBase._xmlName

NamedEntityBase._namePattern

NamedEntityBase.Name

NamedEntityBase.Instance

NamedEntityBase.Identifier

NamedEntityBase.LockedIdentifier

EntityBase._lastChange

EntityBase.EntityCreated()

EntityBase.EntityModified()

EntityBase.Guid

EntityBase.LastChange

EntityBase.Action

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ObjectExtensions.DeepClone<T>(T)

XmlSerialization.SerializeObjectToXml<T>(T)

XmlSerialization.SerializeObject<T>(T)

Extension.ToXElement<T>(object)

ObjectExtensions.DeepClone(object)

Constructors

BoreHole(double, double, double, AllLevels, string)

public BoreHole(double x, double y, double finalGroundLevel = 0, AllLevels allLevels = null, string identifier = "BH")

Parameters

x double

y double

finalGroundLevel double

allLevels AllLevels

identifier string

Properties

Colouring

public EntityColor Colouring { get; set; }

Property Value

EntityColor

FinalGroundLevel

public double FinalGroundLevel { get; set; }

Property Value

double

StrataLevels

public List<double> StrataLevels { get; set; }

Property Value

List<double>

WholeLevelData

public AllLevels WholeLevelData { get; set; }

Property Value

AllLevels

X

public double X { get; set; }

Property Value

double

Y

public double Y { get; set; }

Property Value

double

_finalGroundLevel

public double _finalGroundLevel { get; set; }

Property Value

double

Methods

GetUniqueInstanceCount()

This value will be used to set number (like ".1") part of the entity name (like "B.1"). Typically this is a counter starting at 1 and incrementing for each new instance of this class that has been created.

protected override int GetUniqueInstanceCount()

Returns

int

A unique number.

GroundLevel(double, double, double, string)

public static BoreHole GroundLevel(double x, double y, double finalGroundLevel, string identifier = "BH")

Parameters

x double

y double

finalGroundLevel double

identifier string

Returns

BoreHole

ResetInstanceCount()

public static void ResetInstanceCount()

ToString()

public override string ToString()

Returns

string