IStandardCreator¶

class IStandardCreator¶

Bases: ImpactCOMWrapperBase

Summary:: Use the IStandardCreator for creating standards.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property add_non_print_hatching¶

Gets add_non_print_hatching.

Summary:: Add non print hatching areas to the standard if it has any defined.

Returns:: The value of add_non_print_hatching.
Return type:: add_non_print_hatching (bool)

property add_overall_dimensions¶

Gets add_overall_dimensions.

Summary:: Add overall dimensions to the standard.

Returns:: The value of add_overall_dimensions.
Return type:: add_overall_dimensions (bool)

property add_panel_dimensions¶

Gets add_panel_dimensions.

Summary:: Add panel dimensions to the standard.

Returns:: The value of add_panel_dimensions.
Return type:: add_panel_dimensions (bool)

property advanced_corrugated_materials_enabled¶

Gets advanced_corrugated_materials_enabled.

Summary:: A flag indicating if advanced corrugated materials are enabled in the database for the current user.

Returns:: The value of advanced_corrugated_materials_enabled.
Return type:: advanced_corrugated_materials_enabled (bool)

property corrugated_material¶

Gets corrugated_material.

Summary:: Gets the corrugated material associated with this standard creator.
Remarks:: Introduced in Impact 6.1.0.21

Returns:: The value of corrugated_material.
Return type:: corrugated_material (ICorrugatedMaterial)

property creation_layer¶

Gets creation_layer.

Summary:: Defines the layer in which to create the standard.
Remarks:: To create the standard in an existing layer, set this property. If new_drawing is set to True then the creation_layer property is ignored.

Returns:: The value of creation_layer.
Return type:: creation_layer (ILayer)

property delete_parametric_dimensions¶

Gets delete_parametric_dimensions.

Summary:: Specifies if parametric dimensions should be deleted after creating the standard.

Returns:: The value of delete_parametric_dimensions.
Return type:: delete_parametric_dimensions (bool)

property description¶

Gets Description.

Summary:: The description of the standard to create.
Remarks:: The description property can be read once the Standard has been assigned.

Returns:: The value of Description.
Return type:: description (str)

property dimension_horizontal_position¶

Gets dimension_horizontal_position.

Summary:: The horizontal position of dimensions.

Returns:: The value of dimension_horizontal_position.
Return type:: dimension_horizontal_position (ipHorzTextPos)

property dimension_mts¶

Gets dimension_mts.

Summary:: Gets and sets the dimension settings to use.

Returns:: The value of dimension_mts.
Return type:: dimension_mts (IMasterSetting)

property dimension_settings_name¶

Gets dimension_settings_name.

Summary:: Gets and sets the dimension settings to use by name.
Remarks:: Deprecated, use dimension_mts instead.

Returns:: The value of dimension_settings_name.
Return type:: dimension_settings_name (str)

property dimension_vertical_position¶

Gets dimension_vertical_position.

Summary:: The vertical position of dimensions.

Returns:: The value of dimension_vertical_position.
Return type:: dimension_vertical_position (ipVertTextPos)

property display_wizard¶

Gets display_wizard.

Summary:: Display the Standard Wizard when the Create method is called.

Returns:: The value of display_wizard.
Return type:: display_wizard (bool)

Examples:

Display Standard Wizard

property has_parametric_constructions¶

Gets has_parametric_constructions.

Summary:: Whether or not this standard creator has any parametric constructions. Parametric constructions contain geometry driven by Parametric Construction Model (Pre-Dynamic Constraints).
Remarks:: Introduced in Impact 13.0.0.56

Returns:: The value of has_parametric_constructions.
Return type:: has_parametric_constructions (bool)

Examples:

Standard Creating

property material_mts¶

Gets material_mts.

Summary:: Gets and sets the material.
Remarks:: This must always refer to an existing MTS.

Returns:: The value of material_mts.
Return type:: material_mts (IMasterSetting)

property material_name¶

Gets material_name.

Summary:: Gets and sets the material by name.
Remarks:: Deprecated, use material_mts instead.

Returns:: The value of material_name.
Return type:: material_name (str)

property metric¶

Gets Metric.

Summary:: Specifies whether to use Metric or Imperial settings.
Remarks:: Many standards will change their behaviour when running in Metric or Imperial mode. This may include their default values or how certain panel sizes are calculated.

Returns:: The value of Metric.
Return type:: metric (bool)

property new_drawing¶

Gets new_drawing.

Summary:: Specifies whether the standard is to be created in a new drawing (as opposed to the current drawing).
Remarks:: By default, new_drawing is True. If new_drawing is set to True then the creation_layer property is ignored. Introduced in Impact 8.0.0.65

Returns:: The value of new_drawing.
Return type:: new_drawing (bool)

property non_print_hatch_mts¶

Gets non_print_hatch_mts.

Summary:: Gets and sets the hatch settings to use.
Remarks:: For standards containing a single non print palette or to specify a default non print hatching use this property. To specify hatching settings for multiple non print palettes use the add_non_print_hatch_settings method instead.

Returns:: The value of non_print_hatch_mts.
Return type:: non_print_hatch_mts (IMasterSetting)

property non_print_hatch_settings_name¶

Gets non_print_hatch_settings_name.

Summary:: Gets and sets the hatch settings to use by name.
Remarks:: Deprecated, use non_print_hatch_mts instead.

Returns:: The value of non_print_hatch_settings_name.
Return type:: non_print_hatch_settings_name (str)

property rounding_threshold¶

Gets rounding_threshold.

Summary:: Specifies the rounding threshold to use.
Remarks:: A rounding threshold will round certain variables within the standard to a fixed increment. For example you may want to round all sizes to 1/8 of an inch. The rounding threshold will only be used if use_rounding_threshold is true.

Returns:: The value of rounding_threshold.
Return type:: rounding_threshold (any)

property standard¶

Gets Standard.

Summary:: The name of the standard to create.
Remarks:: Setting the name will load the Description, material_name and Variables of the standard. It is then possible to get and set the variable values to be used in creating the standard.

Returns:: The value of Standard.
Return type:: standard (str)

property standard2¶

Gets Standard2.

Summary:: The name of the second standard to use in a mix and match standard.
Remarks:: To create a mix and match standard, first assign a name to Standard for the top, then to Standard2 for the base. When Standard2 is set both Standard and Standard2 are checked to ensure they match and are suitable to be used together to produce a mix and match standard. This involves checking the mix and match type and the mix and match panel dimensions for each standard. When the Standard2 is loaded it automatically merges its variables into the existing variables from Standard. This enables you to get and set variable values appropriate to the mix and match standard being created.

Returns:: The value of Standard2.
Return type:: standard2 (str)

property unit_settings¶

Gets unit_settings.

Summary:: Gets and sets the unit settings associated with this standard creator.
Remarks:: The unit_settings are used in the production of hints for an ICorrugatedMaterialComponent, to use the user’s preferred units and formatting. The unit_settings do not in any way affect the geometry generated by the standard.

Returns:: The value of unit_settings.
Return type:: unit_settings (IUnitSettings)

property use_rounding_threshold¶

Gets use_rounding_threshold.

Summary:: Specifies whether to apply a rounding threshold.
Remarks:: A rounding threshold will round certain variables within the standard to a fixed increment. For example you may want to round all sizes to 1/8 of an inch. See also rounding_threshold for specifying the rounding value to use.

Returns:: The value of use_rounding_threshold.
Return type:: use_rounding_threshold (bool)

property valid¶

Gets Valid.

Summary:: Indicates whether the properties of IStandardCreator are valid and the Create method can be called.

Returns:: The value of Valid.
Return type:: valid (bool)

property valid_material_master_settings¶

Gets valid_material_master_settings.

Summary:: Returns the valid standard material MTS associated with this standard creator.
Remarks:: If the standard material MTS is not valid, returns NULL.

Returns:: The value of valid_material_master_settings.
Return type:: valid_material_master_settings (IMasterSettings)

property variable_settings¶

Gets variable_settings.

Summary:: The variable settings of the standard to create.
Remarks:: Returns an IDrawingVariableSettings object representing all the variables, variable groups and variable settings in the standard. These variable settings can only be accessed after the Standard property has been successfully set.

Returns:: The value of variable_settings.
Return type:: variable_settings (IDrawingVariableSettings)

add_non_print_hatch_settings(palette_name, hatch_settings)¶

Summary:: Specifies a hatch settings to use for a specific non print palette
Remarks:: Use this method to specify a hatch settings for a non-print palette. For standards containing more than one non print palette you can assign unique hatching settings for each one. For standards containing a single non-print palette or to specify a default hatching settings use the non_print_hatch_mts property instead. If no specifc non-print palette to hatch settings mapping exists then the default hatch settings will be used.

Parameters:

palette_name (str) – Non print palette name
hatch_settings (IMasterSetting) – Hatch settings for areas using non print palette

create()¶

Summary:: Creates the standard using the defined properties.
Remarks:: If the property Standard does not refer to an existing standard in the database this method will fail. If the display_wizard property is false and the ‘Prompt the user for the template to use’ option in Standards->Options is unchecked then the database windows will not be displayed to the user. This does not apply to the IServer.

isNone()¶: Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

Examples