Class BoltMatchSpecification

This is a spec of options you can change when matching bolts, on the resulting bolts. Options you find on Bolt, but not here, are options we don't support changing during bolt match.

         Once you've got the options set, pass this to the Fasten function to create bolts
         which fasten 2 or more pieces of material.

         All options default to null.  If an option is null, then you will get the default
         value which is generally inherited from the holes that are bolted, or from setup.

Inheritance

object

BoltMatchSpecification

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: DesignData.SDS2.Model

Assembly: DesignData.SDS2.Model.dll

Syntax

public sealed class BoltMatchSpecification

Constructors

BoltMatchSpecification()

Create an default BoltMatchSpecification

Declaration

public BoltMatchSpecification()

Properties

BoltType

Bolt setup information currently used on bolt

Declaration

public BoltType BoltType { get; set; }

Property Value

Type	Description
BoltType

Exceptions

Type	Condition
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of a bolt that was added to a transaction but is unlocked

BreakoutNutAndWasherOnBill

If true, then nuts and washers are broken out into their own lines on the bill of material.

Declaration

public bool? BreakoutNutAndWasherOnBill { get; set; }

Property Value

Type	Description
bool?

Exceptions

Type	Condition
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of a bolt that was added to a transaction but is unlocked

CombineMaterialPlateWashers

If true, then washers will be combined based on the PlateWasherCombinationMethod setting. If false, then each bolt will get its own plate washer.

Declaration

public bool? CombineMaterialPlateWashers { get; set; }

Property Value

Type	Description
bool?

Exceptions

Type	Condition
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of a bolt that was added to a transaction but is unlocked

Diameter

The diameter of the bolt shaft.

Declaration

public double? Diameter { get; set; }

Property Value

Type	Description
double?

Exceptions

Type	Condition
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of a bolt that was added to a transaction but is unlocked

Finish

The finish type of the bolt

Declaration

public BoltFinish? Finish { get; set; }

Property Value

Type	Description
BoltFinish?

Exceptions

Type	Condition
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of a bolt that was added to a transaction but is unlocked

IsFieldBolt

True if this is a bolt to be installed in the field, false if it's to be installed in the shop

Declaration

public bool? IsFieldBolt { get; set; }

Property Value

Type	Description
bool?

Exceptions

Type	Condition
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of a bolt that was added to a transaction but is unlocked

IsFirstMaterialUnderHead

Decide whether the bolt head or nut should be on the first material passed into Fasten. If true, then the head will be on the side fastening the first material in the list. If false, then the nut will be.

         If the first material is not one either side (for example, the
         middle plate of 3 plates bolted together), then this field has no
         meaning and will not have any effect.  And the bolt direction
         will be consistent among all the bolts returned, but which
         direction that will be is undefined.

Declaration

public bool IsFirstMaterialUnderHead { get; set; }

Property Value

Type	Description
bool

IsTensionControl

True if this is a tension control bolt

Declaration

public bool? IsTensionControl { get; set; }

Property Value

Type	Description
bool?

Exceptions

Type	Condition
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of a bolt that was added to a transaction but is unlocked

Methods

Fasten(BoltMatchSpecification, MaterialList)

Given a bolt spec, and a list of materials (with at least 2 materials in it) this will search for holes between any pairing of materials that match up, and fasten those material using those matched holes with bolts of the correct calculated length, and diameters based on the hole settings.

         This must be called with an existing Transaction.  This will
         call Transaction.Lock().

         The bolts will be added to the member that the first material in
         matchHolesOn is on.

Declaration

public static BoltList Fasten(BoltMatchSpecification specification, MaterialList matchHolesOn)

Parameters

Type	Name	Description
BoltMatchSpecification	specification
MaterialList	matchHolesOn

Returns

Type	Description
BoltList

Exceptions

Type	Condition
InvalidOperationException	Thrown if this is called outside of a writable Transaction.

Fasten(BoltMatchSpecification, MaterialList, HoleList)

Same as the other overload of Fasten, except here you list the holes you want to be matched, no other holes are bolted through. These holes MUST BE ON THE FIRST MATERIAL IN matchHolesOn.

Declaration

public static BoltList Fasten(BoltMatchSpecification specification, MaterialList matchHolesOn, HoleList onlyMatchTheseHoles)

Parameters

Type	Name	Description
BoltMatchSpecification	specification
MaterialList	matchHolesOn
HoleList	onlyMatchTheseHoles

Returns

Type	Description
BoltList

Exceptions

Type	Condition
InvalidOperationException	Thrown if this is called outside of a writable Transaction.

~BoltMatchSpecification()

This is a spec of options you can change when matching bolts, on the resulting bolts. Options you find on Bolt, but not here, are options we don't support changing during bolt match.

         Once you've got the options set, pass this to the Fasten function to create bolts
         which fasten 2 or more pieces of material.

         All options default to null.  If an option is null, then you will get the default
         value which is generally inherited from the holes that are bolted, or from setup.

Declaration

protected ~BoltMatchSpecification()