Class: RSDisplacement

Defines a RSDisplacement.

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

Properties

Name Description
BoundaryCondition Gets or sets the BoundaryCondition.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
Direction Gets or sets the Direction.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LoadData Gets or sets the LoadData.
MissingMassEffect Gets or sets the MissingMassEffect.
MissingMassEffectZPA Gets or sets the MissingMassEffectZPA.
Name Gets the name of the object.
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.
Properties Gets the list of properties for this object.
RigidResponseEffect Gets or sets the RigidResponseEffect.
RigidResponseEffectFreqBegin Gets or sets the RigidResponseEffectFreqBegin.
RigidResponseEffectFreqEnd Gets or sets the RigidResponseEffectFreqEnd.
RigidResponseEffectType Gets or sets the RigidResponseEffectType.
RigidResponseEffectZPA Gets or sets the RigidResponseEffectZPA.
ScaleFactor Gets or sets the ScaleFactor.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.