Class GroupMember

A GroupMember associates submembers that will be detailed as a single member with one piecemark.

Inheritance

object

GroupMember

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 GroupMember

Properties

CustomPropertyMapHandle

A handle to the custom properties for this group member.

Declaration

public CustomPropertyMapHandle CustomPropertyMapHandle { get; }

Property Value

Type	Description
CustomPropertyMapHandle

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.

Description

Description in the bill of material

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when setting description with a string that is too long or if the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

Guid

The uuid or guid representing this group member

Declaration

public Guid? Guid { get; }

Property Value

Type	Description
Guid?

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.

Handle

A handle for this group member

Declaration

public GroupMemberHandle Handle { get; }

Property Value

Type	Description
GroupMemberHandle

IsGalvanized

True iff the group members is marked as galvanized

Declaration

public bool IsGalvanized { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.

IsMainViewLockedToMainMember

True iff the group's main member view should be used as the group's main view

Declaration

public bool IsMainViewLockedToMainMember { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

IsMarkedForDetailing

True iff the group member is marked for detailing. This can always be set to true, but in some cases setting it to false will fail. The underlying flag will be set, but since it would still appear on the list of groups to detail this flag will still show as true.

Declaration

public bool IsMarkedForDetailing { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

MainMemberHandle

A handle to the main member of this group member

Declaration

public MemberHandle MainMemberHandle { get; set; }

Property Value

Type	Description
MemberHandle

Exceptions

Type	Condition
InvalidValueException	InvalidValueException will be thrown when setting the main member to a member that is not currently in the group's submembers or if the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

Piecemark

The piecemark of the group member.

Declaration

public string Piecemark { get; }

Property Value

Type	Description
string	A UTF-8 encoded string.

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.

PiecemarkMemberHandle

A handle to the member that displays the piecemark in erection views for this group member

Declaration

public MemberHandle PiecemarkMemberHandle { get; set; }

Property Value

Type	Description
MemberHandle

Exceptions

Type	Condition
InvalidValueException	InvalidValueException will be thrown when setting the main member to a member that is not currently in the group's submembers or if the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

ShouldMaterialMarksBeOnDetail

True iff all material marks should be shown on the detail

Declaration

public bool ShouldMaterialMarksBeOnDetail { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

ShouldOrganizeBOMBySubmember

True iff the bill of material should be organized by submember, with submaterials, shop bolts, and field bolts listed together with their associated submember.

Declaration

public bool ShouldOrganizeBOMBySubmember { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

ShouldSectionSizesBeOnDetail

True iff all section sizes should be shown on the detail

Declaration

public bool ShouldSectionSizesBeOnDetail { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

ShouldSubmemberMarksBeOnDetail

True iff submember marks should be shown on the detail

Declaration

public bool ShouldSubmemberMarksBeOnDetail { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.
NotAddedException	Thrown when setting data on the group member without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

Methods

Dispose(bool)

A GroupMember associates submembers that will be detailed as a single member with one piecemark.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Equals(object)

A GroupMember associates submembers that will be detailed as a single member with one piecemark.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool

Overrides

object.Equals(object)

~GroupMember()

A GroupMember associates submembers that will be detailed as a single member with one piecemark.

Declaration

protected ~GroupMember()

Get(GroupMemberHandle)

Get a GroupMember object for the GroupMemberHandle passed in.

Declaration

public static GroupMember Get(GroupMemberHandle handle)

Parameters

Type	Name	Description
GroupMemberHandle	handle

Returns

Type	Description
GroupMember

GetHashCode()

A GroupMember associates submembers that will be detailed as a single member with one piecemark.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Remarks

This hash (and Equals) does not include submembers. It does include the piecemark and all other group member properties.

GetSubmemberHandles()

Handles to all the submembers of the group member

Declaration

public MemberHandleList GetSubmemberHandles()

Returns

Type	Description
MemberHandleList

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.

IsSubmember(MemberHandle)

True iff the member is a submember of the group

Declaration

public bool IsSubmember(MemberHandle arg0)

Parameters

Type	Name	Description
MemberHandle	arg0

Returns

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the group member handle is invalid.

RefreshDatabaseTable()

Refresh the the primary table for objects of this type.

Declaration

public static void RefreshDatabaseTable()

SetPiecemark(string)

Set a user piecemark to override the system generated piecemark for this group. If other groups shared this system mark, this will split them apart. To recombine them, the same user mark has to be set on those groups.

         By setting a user piecemark you opt this group out of
         system piecemarking and piecemark matching/batching.

Declaration

public void SetPiecemark(string userPiecemark)

Parameters

Type	Name	Description
string	userPiecemark