-
Notifications
You must be signed in to change notification settings - Fork 0
GlobalParameters
Namespace: AlibreScript.API | Kind: Class
The GlobalParameters class provides comprehensive functionality for managing global parameters, configurations, and parameter relationships across parts and assemblies.
- Parameter - Individual parameter management
- Configuration - Configuration operations
- ParameterTypes - Parameter type definitions
- ParameterUnits - Parameter unit definitions
- Part, Assembly - Use global parameters
- Properties - Parameter collections and identity
- Methods - Parameter operations
- Configuration Methods - Configuration management
- File Operations - Save and load operations
Type: Object
A list of configurations
Type: Object
Name of the global parameters
Type: Object
A list of parameters
Opens an existing global parameters set
Overload 1:
def GlobalParameters(folder, name):
"""
Opens an existing global parameters set
Args:
folder (str): Folder containing global parameters
name (str): Name of global parameters to open
"""Overload 2:
def GlobalParameters(name):
"""
Creates a new global parameters set
Args:
name (str): Name of new global parameters set
"""Overload 3:
def GlobalParameters(name, create_new):
"""
Creates a new global parameters set or accesses an already opened global parameters set
Args:
name (str): Name of global parameters set to create or access
create_new (bool): True to create a new global parameters set, false to access an opened global parameters
"""Adds a configuration to the global parameters set
Overload 1:
def AddConfiguration(name):
"""
Adds a configuration to the global parameters set
Args:
name (str): Name of configuration
Returns:
New configuration
"""Overload 2:
def AddConfiguration(name, base_configuration_name):
"""
Adds a configuration to the global parameters set using another configuration as a base
Args:
name (str): Name of configuration
base_configuration_name (str): Name of base configuration to use
Returns:
New configuration
"""Adds a parameter to the global parameters set
Overload 1:
def AddParameter(name, type, value):
"""
Adds a parameter to the global parameters set
Args:
name (str): Name of parameter
type (ParameterTypes): Type of parameter
value (float): Value for parameter
Returns:
New parameter
"""Overload 2:
def AddParameter(name, type, equation):
"""
Adds a parameter to the global parameters set
Args:
name (str): Name of parameter
type (ParameterTypes): Type of parameter
equation (str): Equation for parameter
Returns:
New parameter
"""Gets a configuration with a specific name
def GetConfiguration(name):
"""
Gets a configuration with a specific name
Args:
name (str): Name of confguration
Returns:
Configuration object
"""Gets a parameter with a specific name
def GetParameter(name):
"""
Gets a parameter with a specific name
Args:
name (str): Name of parameter
Returns:
Parameter object
"""Saves the global parameters set to a specific folder
def Save(folder):
"""
Saves the global parameters set to a specific folder
Args:
folder (str): Folder to save to
"""Saves the global parameters set to a specific folder with a new name
def SaveAs(folder, new_name):
"""
Saves the global parameters set to a specific folder with a new name
Args:
folder (str): Folder to save to
new_name (str): New name for global parameters set
"""Documentation Home | Classes | Methods Index | Properties Index | Members Index
Generated on 2025-09-23 02:06