Click or drag to resize

SimpleVariable Interface

Represents a simple variable in the woodwork automation system. A simple variable is a basic output control that formats numeric values for NC file output with optional enable/disable state management. Simple variables apply formatting rules (decimal precision, sign display, zero padding, prefix/suffix decoration) to produce consistently formatted text strings, enabling straightforward value output without state tracking or conditional logic.

Namespace: Woodwork.Automation
Assembly: WoodworkAutomation (in WoodworkAutomation.dll) Version: 10.2.1+e3fd5885edfa7211ba46258e0eed5ac221a54381
Syntax
Copy
public interface SimpleVariable

The SimpleVariable type exposes the following members.

Properties
 NameDescription
Public propertyForce Gets and sets a value indicating whether the variable forces output on every format call. When true, the formatted value is output; when false (default), the variable respects normal output rules. Force enables unconditional output regardless of state or conditions.
Public propertyPrefix Gets and sets the prefix text string prepended to the formatted output value.
Public propertyShaper Gets and sets the Format(Double) object that defines how numeric values are formatted for output.
Public propertySuffix Gets and sets the suffix text string appended to the formatted output value.
Top
Methods
 NameDescription
Public methodDisable Disables this variable from producing any output. When disabled, the Format method returns an empty string regardless of input values.
Public methodEnable Enables this variable for output (default condition when variable is created). When enabled, the variable resumes normal formatting and output behavior.
Public methodFormat Formats the specified numeric value and returns the formatted text string. The formatting applies the Format(Double) rules including decimal precision, sign display, zero padding, and prefix/suffix decoration.
Public methodGetCurrent Returns the formatted text string representation of the most recently formatted value. This allows inspecting the current formatted output without processing a new value.
Public methodIsEnable Gets a value indicating whether the variable is currently enabled for output.
Public methodReset Forces the output of the formatted text string on the next format call, overriding normal output rules. This ensures the next Format call produces output regardless of enable/disable state.
Public methodSetPrefix Temporarily overrides the prefix text string for subsequent output operations.
Public methodSetSuffix Temporarily overrides the suffix text string for subsequent output operations.
Top
See Also