LocalDesignRestriction

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.LocalDesignRestriction(internalObject: Any)

Bases: object

Defines a LocalDesignRestriction.

Overview

Methods

Activate	Activate the current object.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
AxisForDirection	Gets or sets the Axis of the CoordinateSystemForDirection that must be used as a direction Directional Morphing LocalDesignRestrictionNature. Only positive direction enums will be accepted (“PositiveXAxis”, “PositiveYAxis”, “PositiveXAxis”).
Children	Gets the list of children.
ClsId	ClsId property.
CoordinateSystemForDirection	Gets or sets the Coordinate system that is used to define a direction consumed for Directional Morphing and Angle Local Design Restriction Nature.
DataModelObjectCategory	Gets the current DataModelObject's category.
ExclusionRegionLocation	Gets or sets the ExclusionRegionLocation.
ExclusionScopingMethod	Gets or sets the ExclusionScopingMethod.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
InternalObject	Gets the internal object. For advanced usage only.
LocalDesignRestrictionNature	Gets or sets the LocalDesignRestrictionNature. This property enables you to specify geometry that the application does not optimize or specific faces from which the application does not move any nodes vertically with respect to the original face. Non-Optimizable option is the default. If AlongDirection is used, the direction is defined by the combination of CoordinateSystemForDirection and AxisOfCoordinateSystemForDirection properties.
LowerBound	Lower threshold for the restriction. Used for Angle Variation constraint, as an angle value, must be strictly negative and above –180 degree, otherwise an exception is thrown.
Material	Gets or sets the Material imposed on the selection during Material Optimization.
MaxCumulatedDisplacementControl	Gets or sets the MaxCumulatedDisplacementControl.
MorphingTotalMoveLimit	Gets or sets the MorphingTotalMoveLimit.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
State	State property.
Suppressed	Gets or sets the Suppressed.
UpperBound	Upper threshold for the restriction. Used for Angle and Angle Variation constraints, as an angle value, must be strictly positive and below 180 degrees, otherwise an exception is thrown.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property LocalDesignRestriction.AttachedRefs: List[int] | None

AttachedRefs property.

property LocalDesignRestriction.AxisForDirection: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType | None

Gets or sets the Axis of the CoordinateSystemForDirection that must be used as a direction Directional Morphing LocalDesignRestrictionNature. Only positive direction enums will be accepted (“PositiveXAxis”, “PositiveYAxis”, “PositiveXAxis”).

InvalidArgumentException: Any unsupported enum value.

property LocalDesignRestriction.Children: List[Ansys.ACT.Automation.Mechanical.DataModelObject] | None

Gets the list of children.

property LocalDesignRestriction.ClsId: int | None

ClsId property.

property LocalDesignRestriction.CoordinateSystemForDirection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the Coordinate system that is used to define a direction consumed for Directional Morphing and Angle Local Design Restriction Nature. Selected coordinate system must be cartesian, if not an exception is thrown.

property LocalDesignRestriction.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property LocalDesignRestriction.ExclusionRegionLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the ExclusionRegionLocation.

property LocalDesignRestriction.ExclusionScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ExclusionScopingMethod.

property LocalDesignRestriction.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property LocalDesignRestriction.IconName: str | None

IconName property.

property LocalDesignRestriction.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSOptimizationRegionAuto | None

Gets the internal object. For advanced usage only.

property LocalDesignRestriction.LocalDesignRestrictionNature: Ansys.Mechanical.DataModel.Enums.TopoLocalDesignRestrictionNature | None

Gets or sets the LocalDesignRestrictionNature. This property enables you to specify geometry that the application does not optimize or specific faces from which the application does not move any nodes vertically with respect to the original face. Non-Optimizable option is the default. If AlongDirection is used, the direction is defined by the combination of CoordinateSystemForDirection and AxisOfCoordinateSystemForDirection properties.

property LocalDesignRestriction.LowerBound: Ansys.Core.Units.Quantity | None

Lower threshold for the restriction. Used for Angle Variation constraint, as an angle value, must be strictly negative and above –180 degree, otherwise an exception is thrown.

property LocalDesignRestriction.Material: Ansys.ACT.Automation.Mechanical.Material | None

Gets or sets the Material imposed on the selection during Material Optimization.

property LocalDesignRestriction.MaxCumulatedDisplacementControl: Ansys.Mechanical.DataModel.Enums.TopoPropertyControlType | None

Gets or sets the MaxCumulatedDisplacementControl.

property LocalDesignRestriction.MorphingTotalMoveLimit: float | None

Gets or sets the MorphingTotalMoveLimit.

property LocalDesignRestriction.Name: str | None

Name property.

property LocalDesignRestriction.ObjectId: int | None

ObjectId property.

property LocalDesignRestriction.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property LocalDesignRestriction.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property LocalDesignRestriction.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property LocalDesignRestriction.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property LocalDesignRestriction.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property LocalDesignRestriction.Suppressed: bool | None

Gets or sets the Suppressed.

property LocalDesignRestriction.UpperBound: Ansys.Core.Units.Quantity | None

Upper threshold for the restriction. Used for Angle and Angle Variation constraints, as an angle value, must be strictly positive and below 180 degrees, otherwise an exception is thrown.

property LocalDesignRestriction.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

LocalDesignRestriction.Activate() → None

Activate the current object.

LocalDesignRestriction.CopyTo(other: Ansys.ACT.Automation.Mechanical.LocalDesignRestriction) → None

Copies all visible properties from this object to another.
Override because of copy order of properties

LocalDesignRestriction.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

LocalDesignRestriction.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

LocalDesignRestriction.Delete() → None

Run the Delete action.

LocalDesignRestriction.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

LocalDesignRestriction.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

LocalDesignRestriction.GetAPIName(dispId: int) → str

Property name bound to dispId.

LocalDesignRestriction.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

LocalDesignRestriction.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

LocalDesignRestriction.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

LocalDesignRestriction.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

LocalDesignRestriction.GetHashCode() → int

GetHashCode method.

LocalDesignRestriction.GetIconFile() → System.Byte

GetIconFile method.

LocalDesignRestriction.GetLifetimeService() → Any

GetLifetimeService method.

LocalDesignRestriction.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

LocalDesignRestriction.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

LocalDesignRestriction.GetPath() → str

GetPath method.

LocalDesignRestriction.GetPropertyName(dispId: int) → str

GetPropertyName method.

LocalDesignRestriction.GetPropertyValue(name: str) → Any

GetPropertyValue method.

LocalDesignRestriction.GetType() → type

GetType method.

LocalDesignRestriction.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

LocalDesignRestriction.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

LocalDesignRestriction.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

LocalDesignRestriction.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

LocalDesignRestriction.InitializeLifetimeService() → Any

InitializeLifetimeService method.

LocalDesignRestriction.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

LocalDesignRestriction.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

LocalDesignRestriction.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

LocalDesignRestriction.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

LocalDesignRestriction.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

LocalDesignRestriction.RemoveParameter(propName: str) → None

Removes the parameter from the parameter set corresponding to the given property.

LocalDesignRestriction.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

LocalDesignRestriction.ToString() → str

ToString method.