PlcMemoryAreaBuilder Class¶
-
class
NXOpen.AME.PlcMemoryAreaBuilder¶ Bases:
NXOpen.BuilderRepresents a Subnet creation class Builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreatePlcMemoryAreaBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| DataLengthBit | Returns or sets the DataLengthBit |
| DataLengthByte | Returns or sets the DataLengthByte |
| Description | Returns or sets the Description |
| IOType | Returns or sets the IOType |
| Name | Returns or sets the Name |
| StartAddress | Returns or sets the StartAddress |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| 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. |
| GetObject | Returns the object currently being edited by this builder. |
| 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. |
Property Detail¶
DataLengthBit¶
-
PlcMemoryAreaBuilder.DataLengthBit¶ Returns or sets the DataLengthBit
-------------------------------------Getter Method
Signature
DataLengthBitReturns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DataLengthBitParameters: dataLengthBit (int) – New in version NX12.0.0.
License requirements: None.
DataLengthByte¶
-
PlcMemoryAreaBuilder.DataLengthByte¶ Returns or sets the DataLengthByte
-------------------------------------Getter Method
Signature
DataLengthByteReturns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DataLengthByteParameters: dataLengthByte (int) – New in version NX12.0.0.
License requirements: None.
Description¶
-
PlcMemoryAreaBuilder.Description¶ Returns or sets the Description
-------------------------------------Getter Method
Signature
DescriptionReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DescriptionParameters: description (str) – New in version NX12.0.0.
License requirements: None.
IOType¶
-
PlcMemoryAreaBuilder.IOType¶ Returns or sets the IOType
-------------------------------------Getter Method
Signature
IOTypeReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IOTypeParameters: ioType (str) – New in version NX12.0.0.
License requirements: None.
Name¶
-
PlcMemoryAreaBuilder.Name¶ Returns or sets the Name
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX12.0.0.
License requirements: None.
StartAddress¶
-
PlcMemoryAreaBuilder.StartAddress¶ Returns or sets the StartAddress
-------------------------------------Getter Method
Signature
StartAddressReturns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StartAddressParameters: startAddress (int) – New in version NX12.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
PlcMemoryAreaBuilder.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.