BooleanPart Class |
The BooleanPart class represents a part cut or an add. This means that a model object is, for example,
cut with a part instance to create a void to the father part. Typically the operative part is deleted after
the boolean cut operation. In case of boolean add, operative part is deleted automatically.
Inheritance Hierarchy
SystemObject
Tekla.Structures.ModelObject
Tekla.Structures.ModelModelObject
Tekla.Structures.ModelBoolean
Tekla.Structures.ModelBooleanPart
Tekla.Structures.ModelObject
Tekla.Structures.ModelModelObject
Tekla.Structures.ModelBoolean
Tekla.Structures.ModelBooleanPart
Namespace: Tekla.Structures.Model
Assembly: Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2023.0.3
Syntax
The BooleanPart type exposes the following members.
Constructors
Name | Description | |
---|---|---|
BooleanPart |
Instantiates an empty cut operation.
|
Properties
Name | Description | |
---|---|---|
Father |
The father object of the boolean operation; the model object instance to operate on.
(Inherited from Boolean.) | |
Identifier |
The identifier of the object.
(Inherited from Object.) | |
IsUpToDate | Gets if the object does not have a modification which is not shared. (Inherited from ModelObject.) | |
ModificationTime | Gets latest time of the object was modified or created. (Inherited from ModelObject.) | |
OperativePart |
The part that does the boolean operation. When Insert() is called, this field is overwritten
with a new part instance which is a copy of the original operative part. This part has the
same identifier as the boolean part. Modifications (such as profile change) have
to be made through the part instance and not the boolean part instance. The operative part's
class must be BooleanOperativeClass.
| |
Type |
Defines the boolean operation: an add or a cut.
|
Methods
Name | Description | |
---|---|---|
CompareTo |
Compares Identifiers of model objects.
(Inherited from ModelObject.) | |
Delete |
Deletes the boolean part instance with the given ID from the model database.
(Overrides ModelObjectDelete.) | |
Equals |
Check if Identifiers of model objects are same.
(Inherited from ModelObject.) | |
GetAllReportProperties |
Retrieves all properties for the model object in one hashtable.
Type for the returned value must be checked using type casting.
(Inherited from ModelObject.) | |
GetAllUserProperties |
Retrieves all properties for the model object in one hashtable.
Type for the returned value must be checked using type casting.
(Inherited from ModelObject.) | |
GetChildren |
Returns an enumerator of all the children model objects.
(Inherited from ModelObject.) | |
GetCoordinateSystem |
Returns the coordinate system for the given model object.
(Inherited from ModelObject.) | |
GetDoubleReportProperties |
Retrieves multiple double report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) | |
GetDoubleUserProperties |
Retrieves all double properties for the model object.
(Inherited from ModelObject.) | |
GetDynamicStringProperty |
Gets a dynamic string property from the model object.
(Inherited from ModelObject.) | |
GetFatherComponent |
Returns the father component of the model object.
(Inherited from ModelObject.) | |
GetHierarchicObjects |
Returns an enumerator of all the connected hierarchic objects.
(Inherited from ModelObject.) | |
GetIntegerReportProperties |
Retrieves multiple integer report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) | |
GetIntegerUserProperties |
Retrieves all integer properties for the model object.
(Inherited from ModelObject.) | |
GetPhase |
Retrieves the phase of the model object (the phase number, the phase name,
the phase comment and whether the phase is the current one or not).
(Inherited from ModelObject.) | |
GetReportProperty(String, Double) |
Retrieves a double property of the report for the model object.
(Inherited from ModelObject.) | |
GetReportProperty(String, Int32) |
Retrieves an integer property of the report for the model object.
(Inherited from ModelObject.) | |
GetReportProperty(String, String) |
Retrieves a string property of the report for the model object.
(Inherited from ModelObject.) | |
GetStringReportProperties |
Retrieves multiple string report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) | |
GetStringUserProperties |
Retrieves all string properties for the model object.
(Inherited from ModelObject.) | |
GetUserProperty(String, Double) |
Retrieves a double property for the model object.
(Inherited from ModelObject.) | |
GetUserProperty(String, Int32) |
Retrieves an integer property for the model object.
(Inherited from ModelObject.) | |
GetUserProperty(String, String) |
Retrieves a string property for the model object.
(Inherited from ModelObject.) | |
Insert |
Inserts the boolean part into the model database. All the attributes must be set.
The operative part is overwritten by a copy of the original part.
(Overrides ModelObjectInsert.) | |
Modify |
Currently it is not possible to modify the boolean part as there is nothing
that can be modified for it. Calling this function will actually call modify for
the operative part member.
(Overrides ModelObjectModify.) | |
Select |
Selects a boolean part from the model database. The part ID must be set.
(Overrides ModelObjectSelect.) | |
SetDynamicStringProperty |
Sets a dynamic string property for the model object.
(Inherited from ModelObject.) | |
SetLabel |
Sets a label for an object when a new instance is created, this method must be called before Insert.
The label is used in plug-ins for identifying the changed object in modification.
(Inherited from ModelObject.) | |
SetOperativePart |
Sets the part to operate with. The operative part's
class member must be defined to be BooleanOperativeClass.
| |
SetPhase |
Sets the phase of the model object.
(Inherited from ModelObject.) | |
SetUserProperties |
Sets multiple properties for the model object.
(Inherited from ModelObject.) | |
SetUserProperty(String, Double) |
Sets a double property for the model object.
(Inherited from ModelObject.) | |
SetUserProperty(String, Int32) |
Sets an integer property for the model object.
(Inherited from ModelObject.) | |
SetUserProperty(String, String) |
Sets a string property for the model object.
(Inherited from ModelObject.) |
Fields
Name | Description | |
---|---|---|
BooleanOperativeClassName |
A constant string that defines a part class name to be the boolean
operative part. This class must be used when inserting the operative part to
the database.
|
Examples
using Tekla.Structures.Model; using Tekla.Structures.Geometry3d; using System; public class Example { public void Example1() { Point point = new Point(0, 7000, 0); Point point2 = new Point(1000, 7000, 0); Beam Beam1 = new Beam(); Beam1.StartPoint = point; Beam1.Profile.ProfileString = "400*400"; Beam1.EndPoint = point2; Beam1.Insert(); Beam Beam2 = new Beam(); Beam2.Profile.ProfileString = "400*400"; Beam2.StartPoint = new Point(500, 6000, 0); Beam2.EndPoint = new Point(500, 8000, 0); Beam2.Class = BooleanPart.BooleanOperativeClassName; Beam2.Insert(); BooleanPart Beam = new BooleanPart(); Beam.Father = Beam1; Beam.SetOperativePart(Beam2); // Beam.Type = BooleanPart.BooleanTypeEnum.BOOLEAN_ADD; // BOOLEAN_CUT is default type. if(!Beam.Insert()) Console.WriteLine("Insert failed!"); Beam2.Delete(); // Not needed when using BOOLEAN_ADD, operative part is deleted automatically. } }
See Also