Class: Spring

Defines a Spring.

Methods

Name Description
Activate() Activate the current object.
AddCommandSnippet() Creates a new CommandSnippet
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
AddImage(String) 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.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Delete() Run the Delete action.
Duplicate() Creates a copy of the current DataModelObject.
GetChildren(Boolean, IList<ChildrenType>)
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
PromoteToNamedSelection() Run the PromoteToNamedSelection action.
PromoteToRemotePoint() Run the PromoteToRemotePoint action.
PropertyByAPIName(String) 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.
PropertyByName(String) Get a property by its unique name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnDefinition() Run the RenameBasedOnDefinition action.

Properties

Name Description
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
Figures Gets the list of associated figures.
FreeLength Gets or sets the FreeLength.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Load Gets or sets the Load.
LongitudinalDamping Gets or sets the LongitudinalDamping.
LongitudinalStiffness Gets or sets the constant longitudinal stiffness (expressed in N/m).
Material Gets or sets the Material.
MobileAppliedBy Gets or sets the MobileAppliedBy.
MobileBeamMaterial Gets or sets the MobileBeamMaterial.
MobileBeamRadius Gets or sets the MobileBeamRadius.
MobileBehavior Gets or sets the MobileBehavior.
MobileBody Gets the MobileBody.
MobileCoordinateSystem Gets or sets the MobileCoordinateSystem.
MobileLocation Gets or sets the MobileLocation.
MobilePinballRegion Gets or sets the MobilePinballRegion.
MobileScopeLocation Gets or sets the MobileScopeLocation.
MobileXCoordinate Gets or sets the MobileXCoordinate.
MobileYCoordinate Gets or sets the MobileYCoordinate.
MobileZCoordinate Gets or sets the MobileZCoordinate.
Name Gets the name of the object.
NonLinearLongitudinalStiffness Gets the non linear longitudinal stiffness defined in the tabular data.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
Parent Gets the parent object.
PreloadType Gets or sets the PreloadType.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
ReferenceAppliedBy Gets or sets the ReferenceAppliedBy.
ReferenceBeamMaterial Gets or sets the ReferenceBeamMaterial.
ReferenceBeamRadius Gets or sets the ReferenceBeamRadius.
ReferenceBehavior Gets or sets the ReferenceBehavior.
ReferenceBody Gets the ReferenceBody.
ReferenceCoordinateSystem Gets or sets the ReferenceCoordinateSystem.
ReferenceLocation Gets or sets the ReferenceLocation.
ReferencePinballRegion Gets or sets the ReferencePinballRegion.
ReferenceScopeLocation Gets or sets the ReferenceScopeLocation.
ReferenceXCoordinate Gets or sets the ReferenceXCoordinate.
ReferenceYCoordinate Gets or sets the ReferenceYCoordinate.
ReferenceZCoordinate Gets or sets the ReferenceZCoordinate.
Rotation Gets or sets the Rotation.
Scope Gets or sets the Scope.
SpringBehavior Gets or sets the SpringBehavior.
SpringElementAPDLName Gets or sets the SpringElementAPDLName.
SpringLength Gets the SpringLength.
SpringType Gets or sets the SpringType.
Suppressed Gets or sets the Suppressed.
Torque Gets or sets the Torque.
TorsionalDamping Gets or sets the TorsionalDamping.
TorsionalStiffness Gets or sets the TorsionalStiffness.
Visible Gets or sets the Visible.
VisibleProperties Gets the list of properties that are visible for this object.