Class: Displacement

Defines a Displacement.

Implemented types

Methods

Name Description
Activate() Activate the current object.
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.
GetActivateAtLoadStep(UInt32)
GetChildren(Boolean, IList<ChildrenType>)
GetComponentActivateAtLoadStep(String, UInt32)
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.
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.
SetActivateAtLoadStep(UInt32, Boolean)
SetComponentActivateAtLoadStep(String, UInt32, Boolean)

Properties

Name Description
AbsoluteResult Gets or sets the AbsoluteResult.
BaseExcitation Gets or sets the BaseExcitation.
BoundaryCondition Gets or sets the BoundaryCondition.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DefineBy Gets or sets the DefineBy.
Direction Gets or sets the Direction.
Distance Gets the Distance.
DynamicRelaxationBehavior Gets or sets the DynamicRelaxationBehavior.
Figures Gets the list of associated figures.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
Images Gets the list of associated images.
IndependentVariable Gets or sets the IndependentVariable.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
MagnitudeImag Gets the MagnitudeImag.
Name Gets the name of the object.
NumberOfSegments Gets or sets the NumberOfSegments.
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.
PhaseAngle Gets the PhaseAngle.
Properties Gets the list of properties for this object.
RangeMaximum Gets or sets the RangeMaximum.
RangeMinimum Gets or sets the RangeMinimum.
ReadOnly Gets or sets the ReadOnly.
ReverseDirectionForInverseSteps Gets or sets the ReverseDirectionForInverseSteps.
RpmSelection Gets or sets the RpmSelection.
SharedRefBody Gets or sets the SharedRefBody.
StepSelection Gets or sets the StepSelection.
StepVarying Gets or sets the StepVarying.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XComponent Gets the XComponent.
XComponentImag Gets the XComponentImag.
XPhaseAngle Gets the XPhaseAngle.
XYZFunctionCoordinateSystem Gets or sets the XYZFunctionCoordinateSystem.
YComponent Gets the YComponent.
YComponentImag Gets the YComponentImag.
YPhaseAngle Gets the YPhaseAngle.
ZComponent Gets the ZComponent.
ZComponentImag Gets the ZComponentImag.
ZPhaseAngle Gets the ZPhaseAngle.