Class Hole

A single hole on a material

Inheritance

object

Hole

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: DesignData.SDS2.Model

Assembly: DesignData.SDS2.Model.dll

Syntax

public class Hole

Properties

CombineOnDetail

Indicates if this hole should be combined with others, when possible, on details.

Declaration

public bool CombineOnDetail { get; }

Property Value

Type	Description
bool

CustomPropertyMapHandle

A handle to the custom properties for this hole.

Declaration

public CustomPropertyMapHandle CustomPropertyMapHandle { get; }

Property Value

Type	Description
CustomPropertyMapHandle

Group

The group object for this hole, with properties shared by all holes in this group.

Declaration

public HoleGroup Group { get; }

Property Value

Type	Description
HoleGroup

Handle

The database handle for this object

Declaration

public HoleHandle Handle { get; }

Property Value

Type	Description
HoleHandle

HoleType

The kind of hole to drill

Declaration

public HoleType HoleType { get; set; }

Property Value

Type	Description
HoleType

IsBlind

A hole which is blind is one what isn't drilled all the way through the material.

Declaration

public bool IsBlind { get; set; }

Property Value

Type	Description
bool

IsMatchable

Indicates if this hole can be used to "match" against other material, which would create a corresponding hole on that material in line with this hole. If this is false, then this hole will be ignored during hole matching.

Declaration

public bool IsMatchable { get; }

Property Value

Type	Description
bool

IsSystemGenerated

Indicates if a hole was added by the system, during process, or if it was added by an interactive tool. Holes created by custom members and components are considered system.

Declaration

public bool IsSystemGenerated { get; }

Property Value

Type	Description
bool	True if this hole was created by the system.

Length

The drill length of the hole

Declaration

public double Length { get; set; }

Property Value

Type	Description
double

PlugType

The plug type for this hole

Declaration

public PlugType PlugType { get; set; }

Property Value

Type	Description
PlugType

Point1

The starting point where this hole is drilled, in material coordinates

Declaration

public Point3D Point1 { get; }

Property Value

Type	Description
Point3D

Remarks

This is the same as ReferenceLocation

Point2

The ending point where this hole is drilled, in material coordinates

Declaration

public Point3D Point2 { get; }

Property Value

Type	Description
Point3D

ReferenceLocation

The reference location, in material coordinates, of the hole

Declaration

public Point3D ReferenceLocation { get; set; }

Property Value

Type	Description
Point3D

ToGlobalCoordinates

The relative location and orientation of the hole in global coordinates

Declaration

public Matrix ToGlobalCoordinates { get; }

Property Value

Type	Description
Matrix

Exceptions

Type	Condition
InvalidHandleException	Thrown if the hole transform cannot be retrieved. This typically indicates data corruption.

Methods

Dispose(bool)

A single hole on a material

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Equals(object)

A single hole on a material

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool

Overrides

object.Equals(object)

~Hole()

A single hole on a material

Declaration

protected ~Hole()

Get(HoleHandle)

Returns a Hole object from a HoleHandle if it exists in the job. Otherwise, returns null.

Declaration

public static Hole Get(HoleHandle handle)

Parameters

Type	Name	Description
HoleHandle	handle

Returns

Type	Description
Hole

GetHashCode()

A single hole on a material

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

GetOperations()

A deep copy of the the machine/tool operations for the hole

Declaration

public HoleMachineOperations GetOperations()

Returns

Type	Description
HoleMachineOperations

GetSurface()

This gives a faceted solid Surface representing the shape of the hole in the material in hole local coordinates. The ends of the hole are lifted 0.005" off the surface of the material (this aids with display).

         This is also true for blind holes (holes that don't go all the way
         through).  The end of this hole Surface will be 0.005" past where the
         blind hole is detailed to drill to.

Declaration

public Surface GetSurface()

Returns

Type	Description
Surface

SetNominalHoleDimensions(HoleType, BoltType, double)

Set the hole diameter and slot length based on the hole type, bolt type and bolt diameter. Also, sets the hole type, bolt type, and bolt diameter to the specified values.

Declaration

public void SetNominalHoleDimensions(HoleType holeType, BoltType boltType, double boltDiameter)

Parameters

Type	Name	Description
HoleType	holeType
BoltType	boltType
double	boltDiameter

SetOperations(HoleMachineOperations)

A deep copy of the the machine/tool operations for the hole

Declaration

public void SetOperations(HoleMachineOperations operations)

Parameters

Type	Name	Description
HoleMachineOperations	operations