BaseDataLoadingBuilder Class¶
-
class
NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder.An instance of this class can be obtained from
BaseDataBuilder.CreateLoading()New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| Active | Returns or sets the status to indicate whether the loading is active or not. |
| Color | Returns or sets the color of loading. |
| DataDefinition | Returns or sets the Data Definition option of loading. |
| FrontWheel | Returns the front wheel data of this loading. |
| Name | Returns or sets the name of loading. |
| RearWheel | Returns the rear wheel data of this loading. |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the vehicle loading type. |
Methods¶
| Method | Description |
|---|---|
| Assign | Assigns value from another loading. |
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetDescription | Gets the loading descriptions. |
| GetObject | Returns the object currently being edited by this builder. |
| SetDescription | Sets the loading descriptions. |
| SetReferencePlane | Sets the reference plane to represent the loading plane. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| BaseDataLoadingBuilderLoadingType Enumeration | This enum represents the vehicle loading types. |
Property Detail¶
Active¶
-
BaseDataLoadingBuilder.Active¶ Returns or sets the status to indicate whether the loading is active or not.
If it is true, the loading is active.
-------------------------------------Getter Method
Signature
ActiveReturns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ActiveParameters: active (bool) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Color¶
-
BaseDataLoadingBuilder.Color¶ Returns or sets the color of loading.
-------------------------------------Getter Method
Signature
ColorReturns: Return type: Id New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ColorParameters: color (Id) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
DataDefinition¶
-
BaseDataLoadingBuilder.DataDefinition¶ Returns or sets the Data Definition option of loading.
-------------------------------------Getter Method
Signature
DataDefinitionReturns: Return type: NXOpen.Features.VehicleDesign.BaseDataLoadingWheelBuilderDataDefinitionOptionsNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DataDefinitionParameters: dataDefinition ( NXOpen.Features.VehicleDesign.BaseDataLoadingWheelBuilderDataDefinitionOptions) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
FrontWheel¶
-
BaseDataLoadingBuilder.FrontWheel¶ Returns the front wheel data of this loading.
-------------------------------------Getter Method
Signature
FrontWheelReturns: Return type: NXOpen.Features.VehicleDesign.BaseDataLoadingWheelBuilderNew in version NX8.5.0.
License requirements: None.
Name¶
-
BaseDataLoadingBuilder.Name¶ Returns or sets the name of loading.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
RearWheel¶
-
BaseDataLoadingBuilder.RearWheel¶ Returns the rear wheel data of this loading.
-------------------------------------Getter Method
Signature
RearWheelReturns: Return type: NXOpen.Features.VehicleDesign.BaseDataLoadingWheelBuilderNew in version NX8.5.0.
License requirements: None.
Type¶
-
BaseDataLoadingBuilder.Type¶ Returns or sets the vehicle loading type.
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Features.VehicleDesign.BaseDataLoadingBuilderLoadingTypeNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: loadingType ( NXOpen.Features.VehicleDesign.BaseDataLoadingBuilderLoadingType) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Method Detail¶
Assign¶
-
BaseDataLoadingBuilder.Assign¶ Assigns value from another loading.
Signature
Assign(other)Parameters: other ( NXOpen.Features.VehicleDesign.BaseDataLoadingBuilder) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
GetDescription¶
-
BaseDataLoadingBuilder.GetDescription¶ Gets the loading descriptions.
Signature
GetDescription()Returns: Return type: list of str New in version NX8.5.0.
License requirements: None.
SetDescription¶
-
BaseDataLoadingBuilder.SetDescription¶ Sets the loading descriptions.
Signature
SetDescription(description)Parameters: description (list of str) – New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
SetReferencePlane¶
-
BaseDataLoadingBuilder.SetReferencePlane¶ Sets the reference plane to represent the loading plane.
Signature
SetReferencePlane(referencePlane)Parameters: referencePlane ( NXOpen.DatumPlane) –New in version NX8.5.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Validate¶
-
BaseDataLoadingBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.