CoordinateSystem

class ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.CoordinateSystem(internalObject: Any)

Bases: object

Defines a CoordinateSystem.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
AddTransformation	Adds a new transformation.
CopyTo	Copies all visible properties from this object to another.
CreateConstructionSurface	Run the CreateConstructionSurface action.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
CreateSectionPlane	Run the CreateSectionPlane action.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
FlipX	Flips the X Axis of the coordinate system
FlipY	Flips the Y Axis of the coordinate system
FlipZ	Flips the Z Axis of the coordinate system
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.
GetTransformationValue	Gets the value of a transformation.
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.
MoveTransformationDown	Moves a transformation down.
MoveTransformationUp	Moves a transformation up.
OffsetX	Creates an offset in the X Axis direction of the coordinate system
OffsetY	Creates an offset in the Y Axis direction of the coordinate system
OffsetZ	Creates an offset in the Z Axis direction of the coordinate system
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.
RemoveTransformation	Removes a tranformation.
RotateX	Creates a rotation about the X Axis of the coordinate system
RotateY	Creates a rotation about the Y Axis of the coordinate system
RotateZ	Creates a rotation about the Z Axis of the coordinate system
SetCoordinateSystemOriginAtCenterOfMass	SetCoordinateSystemOriginAtCenterOfMass method.
SetOriginLocation	Changes the origin location.
SetPrimaryAxisUsingCenterOfMass	Sets the primary axis using a 1 or 2 point selection and the center of mass
SetTransformationValue	Sets the value of a transformation.
ToString	ToString method.

Properties

APDLName	Gets or sets the APDLName.
AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CoordinateSystemID	Gets or sets the CoordinateSystemID.
CoordinateSystemIDGeneration	Gets or sets the CoordinateSystemIDGeneration.
CoordinateSystemType	Gets or sets the CoordinateSystemType.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
GloballyAvailable	Gets or sets the GloballyAvailable.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
IsGlobal	Gets the IsGlobal.
IsValid	IsValid property.
Matrix	Matrix property.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Origin	Origin property.
OriginDefineBy	Gets or sets the origin define by.
OriginLocation	Gets or sets the origin location.
OriginX	Gets or sets the origin X coordinate.
OriginY	Gets or sets the origin Y coordinate.
OriginZ	Gets or sets the origin Z coordinate.
Parent	Parent property.
PrimaryAxis	Gets or sets the PrimaryAxis.
PrimaryAxisDefineBy	Gets or sets the PrimaryAxisDefineBy.
PrimaryAxisDirection	Gets or sets the Principal Axis Direction.
PrimaryAxisLocation	Gets or sets the principal axis geometry selection.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
SecondaryAxis	Gets or sets the SecondaryAxis.
SecondaryAxisDefineBy	Gets or sets the SecondaryAxisDefineBy.
SecondaryAxisDirection	Gets the Secondary Axis Direction.
SecondaryAxisLocation	Gets or sets the orientation about principal axis geometry selection.
State	State property.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
TransformationCount	Gets the number of transformations.
TransformedConfiguration	Gets the TransformedConfiguration.
VisibleProperties	Gets the list of properties that are visible for this object.
XAxis	XAxis property.
XAxisData	Gets the XAxisData.
YAxis	YAxis property.
YAxisData	Gets the YAxisData.
ZAxis	ZAxis property.
ZAxisData	Gets the ZAxisData.

Property detail

property CoordinateSystem.APDLName: str | None

Gets or sets the APDLName.

property CoordinateSystem.AttachedRefs: List[int] | None

AttachedRefs property.

property CoordinateSystem.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property CoordinateSystem.ClsId: int | None

ClsId property.

property CoordinateSystem.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property CoordinateSystem.CoordinateSystemID: int | None

Gets or sets the CoordinateSystemID.

property CoordinateSystem.CoordinateSystemIDGeneration: Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None

Gets or sets the CoordinateSystemIDGeneration.

property CoordinateSystem.CoordinateSystemType: Ansys.ACT.Interfaces.Analysis.CoordinateSystemTypeEnum | None

Gets or sets the CoordinateSystemType.

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

Gets the current DataModelObject's category.

property CoordinateSystem.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property CoordinateSystem.GloballyAvailable: bool | None

Gets or sets the GloballyAvailable.

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

GroupingFolder property.

property CoordinateSystem.IconName: str | None

IconName property.

property CoordinateSystem.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property CoordinateSystem.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property CoordinateSystem.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCoordinateSystemAuto | None

Gets the internal object. For advanced usage only.

property CoordinateSystem.IsGlobal: bool | None

Gets the IsGlobal.

property CoordinateSystem.IsValid: bool | None

IsValid property.

property CoordinateSystem.Matrix: Iterable[float] | None

Matrix property.

property CoordinateSystem.Name: str | None

Name property.

property CoordinateSystem.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property CoordinateSystem.Origin: Iterable[float] | None

Origin property.

property CoordinateSystem.OriginDefineBy: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAlignmentType | None

Gets or sets the origin define by.

property CoordinateSystem.OriginLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the origin location.

property CoordinateSystem.OriginX: Ansys.Core.Units.Quantity | None

Gets or sets the origin X coordinate.

property CoordinateSystem.OriginY: Ansys.Core.Units.Quantity | None

Gets or sets the origin Y coordinate.

property CoordinateSystem.OriginZ: Ansys.Core.Units.Quantity | None

Gets or sets the origin Z coordinate.

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

Parent property.

property CoordinateSystem.PrimaryAxis: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType | None

Gets or sets the PrimaryAxis.

property CoordinateSystem.PrimaryAxisDefineBy: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAlignmentType | None

Gets or sets the PrimaryAxisDefineBy.

property CoordinateSystem.PrimaryAxisDirection: Ansys.ACT.Math.Vector3D | None

Gets or sets the Principal Axis Direction.

property CoordinateSystem.PrimaryAxisLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the principal axis geometry selection.

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

Gets the list of properties for this object.

property CoordinateSystem.ReadOnly: bool | None

Gets or sets the ReadOnly.

property CoordinateSystem.SecondaryAxis: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType | None

Gets or sets the SecondaryAxis.

property CoordinateSystem.SecondaryAxisDefineBy: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAlignmentType | None

Gets or sets the SecondaryAxisDefineBy.

property CoordinateSystem.SecondaryAxisDirection: Ansys.ACT.Math.Vector3D | None

Gets the Secondary Axis Direction.

property CoordinateSystem.SecondaryAxisLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the orientation about principal axis geometry selection.

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

State property.

property CoordinateSystem.Suppressed: bool | None

Gets or sets the Suppressed.

property CoordinateSystem.TransferableObjectId: str | None

TransferableObjectId property.

property CoordinateSystem.TransformationCount: int | None

Gets the number of transformations.

property CoordinateSystem.TransformedConfiguration: str | None

Gets the TransformedConfiguration.

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

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

property CoordinateSystem.XAxis: Iterable[float] | None

XAxis property.

property CoordinateSystem.XAxisData: str | None

Gets the XAxisData.

property CoordinateSystem.YAxis: Iterable[float] | None

YAxis property.

property CoordinateSystem.YAxisData: str | None

Gets the YAxisData.

property CoordinateSystem.ZAxis: Iterable[float] | None

ZAxis property.

property CoordinateSystem.ZAxisData: str | None

Gets the ZAxisData.

Method detail

CoordinateSystem.Activate() → None

Activate the current object.

CoordinateSystem.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

CoordinateSystem.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

CoordinateSystem.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

CoordinateSystem.AddTransformation(trans: Ansys.Mechanical.DataModel.Enums.TransformationType, axis: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType) → None

Adds a new transformation.

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

Copies all visible properties from this object to another.

CoordinateSystem.CreateConstructionSurface() → None

Run the CreateConstructionSurface action.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

CoordinateSystem.CreateSectionPlane() → None

Run the CreateSectionPlane action.

CoordinateSystem.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

CoordinateSystem.FlipX() → None

Flips the X Axis of the coordinate system

CoordinateSystem.FlipY() → None

Flips the Y Axis of the coordinate system

CoordinateSystem.FlipZ() → None

Flips the Z Axis of the coordinate system

CoordinateSystem.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

CoordinateSystem.GetHashCode() → int

GetHashCode method.

CoordinateSystem.GetIconFile() → System.Byte

GetIconFile method.

CoordinateSystem.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

CoordinateSystem.GetPath() → str

GetPath method.

CoordinateSystem.GetPropertyName(dispId: int) → str

GetPropertyName method.

CoordinateSystem.GetPropertyValue(name: str) → Any

GetPropertyValue method.

CoordinateSystem.GetTransformationValue(index: int) → Any

Gets the value of a transformation.

CoordinateSystem.GetType() → type

GetType method.

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

GetVisibleProperties method.

CoordinateSystem.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

CoordinateSystem.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

CoordinateSystem.InitializeLifetimeService() → Any

InitializeLifetimeService method.

CoordinateSystem.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

CoordinateSystem.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

CoordinateSystem.MoveTransformationDown(index: int) → None

Moves a transformation down.

CoordinateSystem.MoveTransformationUp(index: int) → None

Moves a transformation up.

CoordinateSystem.OffsetX() → None

Creates an offset in the X Axis direction of the coordinate system

CoordinateSystem.OffsetY() → None

Creates an offset in the Y Axis direction of the coordinate system

CoordinateSystem.OffsetZ() → None

Creates an offset in the Z Axis direction of the coordinate system

CoordinateSystem.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.

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

PropertyById method.

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

Get a property by its unique name.

CoordinateSystem.RemoveParameter(propName: str) → None

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

CoordinateSystem.RemoveTransformation(index: int) → None

Removes a tranformation.

CoordinateSystem.RotateX() → None

Creates a rotation about the X Axis of the coordinate system

CoordinateSystem.RotateY() → None

Creates a rotation about the Y Axis of the coordinate system

CoordinateSystem.RotateZ() → None

Creates a rotation about the Z Axis of the coordinate system

CoordinateSystem.SetCoordinateSystemOriginAtCenterOfMass(geoBodies: List[Ansys.ACT.Interfaces.Geometry.IBaseGeoBody], pointMasses: List[Ansys.ACT.Automation.Mechanical.PointMass], distributedMasses: List[Ansys.ACT.Automation.Mechanical.DistributedMass]) → None

SetCoordinateSystemOriginAtCenterOfMass method.

CoordinateSystem.SetOriginLocation(originX: Ansys.Core.Units.Quantity, originY: Ansys.Core.Units.Quantity, originZ: Ansys.Core.Units.Quantity) → None

Changes the origin location.

CoordinateSystem.SetPrimaryAxisUsingCenterOfMass() → None

Sets the primary axis using a 1 or 2 point selection and the center of mass

CoordinateSystem.SetTransformationValue(index: int, value: Any) → None

Sets the value of a transformation.

CoordinateSystem.ToString() → str

ToString method.