Class: CurrentDensityProbe

Defines a CurrentDensityProbe.

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.
ClearGeneratedData() Run the ClearGeneratedData action.
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.
DuplicateWithoutResults() Run the DuplicateWithoutResults action.
EvaluateAllResults() Run the EvaluateAllResults action.
ExportAnimation(String, GraphicsAnimationExportFormat, AnimationExportSettings) Run the ExportAnimation action.
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.
RenameBasedOnDefinition() Run the RenameBasedOnDefinition action.
SnapToMeshNodes() Snap the coordinates of probe result to the mesh nodes.

Properties

Name Description
BeamSelection Gets or sets the BeamSelection.
BoundaryConditionSelection Gets or sets the BoundaryConditionSelection. In order to select the option 'WeakSprings', please use the property 'LocationMethod = LocationDefinitionMethod.WeakSprings'.
Comments Gets the list of associated comments.
ContactRegionSelection Gets or sets the ContactRegionSelection.
CoordinateSystemSelection Gets or sets the CoordinateSystemSelection.
CurrentDensityTotal Gets the CurrentDensityTotal.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DisplayTime Gets or sets the DisplayTime.
DpfEvaluation Gets or sets the DpfEvaluation.
Figures Gets the list of associated figures.
GeometryLocation Gets or sets the GeometryLocation.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
IsSolved Gets the IsSolved.
IterationNumber Gets the IterationNumber.
LoadStep Gets the LoadStep.
LoadStepNumber Gets or sets the LoadStepNumber.
LocationMethod Gets or sets the LocationMethod.
MaximumTotal Gets the MaximumTotal.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumTotal Gets the MinimumTotal.
MinimumXAxis Gets the MinimumXAxis.
MinimumYAxis Gets the MinimumYAxis.
MinimumZAxis Gets the MinimumZAxis.
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.
Orientation Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
Parent Gets the parent object.
Properties Gets the list of properties for this object.
RemotePointSelection Gets or sets the RemotePointSelection.
ResultSelection Gets or sets the ResultSelection.
SpatialResolution Gets or sets the SpatialResolution.
SpringSelection Gets or sets the SpringSelection.
Substep Gets the Substep.
Summation Gets or sets the Summation.
Suppressed Gets or sets the Suppressed.
SurfaceSelection Gets or sets the MeshConnectionSelection.
Time Gets the Time.
Total Gets the Total.
Type Gets the Type.
VisibleProperties Gets the list of properties that are visible for this object.
XAxis Gets the XAxis.
XAxisCurrentDensity Gets the XAxisCurrentDensity.
YAxis Gets the YAxis.
YAxisCurrentDensity Gets the YAxisCurrentDensity.
ZAxis Gets the ZAxis.
ZAxisCurrentDensity Gets the ZAxisCurrentDensity.