Class: UserDefinedResult

Defines a UserDefinedResult.

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.
CreateResultsAtAllSets() Creates results at all sets for results under a solution.
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.
ExportToTextFile(String) Run the ExportToTextFile action.
FetchRemoteResults() Run the FetchRemoteResult 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.
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.
RenameBasedOnDefinition() Run the RenameBasedOnDefinition action.

Properties

Name Description
Average Gets the Average.
AverageAcrossBodies Gets or sets the AverageAcrossBodies.
By Gets or sets the By.
CalculateTimeHistory Gets or sets the CalculateTimeHistory.
CombinationNumber Gets or sets the Combination Number for a Solution Combination result.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub scoped by ply.
CyclicMode Gets or sets the CyclicMode.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DisplayOption Gets or sets the DisplayOption.
DisplayTime Gets or sets the DisplayTime.
Expression Gets or sets the Expression.
Figures Gets the list of associated figures.
GlobalIDs Gets or sets the GlobalIDs.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
Identifier Gets or sets the Identifier.
Images Gets the list of associated images.
InputUnitSystem Gets the InputUnitSystem.
InternalObject Gets the internal object. For advanced usage only.
IsSolved Gets the IsSolved.
ItemType Gets or sets the ItemType.
IterationNumber Gets the IterationNumber.
Layer Gets or sets the Layer.
LoadMultiplier Gets the LoadMultiplier.
LoadStep Gets the LoadStep.
LoadStepNumber Gets or sets the LoadStepNumber.
Location Gets or sets the Location.
Maximum Gets the Maximum.
MaximumOccursOn Gets the MaximumOccursOn.
MaximumOfMaximumOverTime Gets the MaximumOfMaximumOverTime.
MaximumOfMinimumOverTime Gets the MaximumOfMinimumOverTime.
Minimum Gets the Minimum.
MinimumOccursOn Gets the MinimumOccursOn.
MinimumOfMaximumOverTime Gets the MinimumOfMaximumOverTime.
MinimumOfMinimumOverTime Gets the MinimumOfMinimumOverTime.
Mode Gets or sets the Mode (Result Set Number).
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.
OutputUnit Gets or sets the OutputUnit.
Parent Gets the parent object.
PhaseIncrement Gets or sets the PhaseIncrement.
Plies
PlotData Gets the result table.
Ply Gets or sets the Ply selection.
Position Gets or sets the Position.
Properties Gets the list of properties for this object.
ReportedFrequency Gets the ReportedFrequency.
RequestedFrequency Gets or sets the RequestedFrequency.
ResponseType Gets or sets the ResponseType.
ScaleFactor Gets or sets the ScaleFactor.
ScaleFactorValue Gets or sets the ScaleFactorValue.
ScopingMethod Gets or sets the ScopingMethod.
SetNumber Gets or sets the Set Number.
SolutionCombinationDriver Gets or sets the SolutionCombinationDriver.
SolverComponentIDs Gets or sets the SolverComponentIDs.
SubScopeBy Gets or sets the SubScopeBy.
Substep Gets the Substep.
Suppressed Gets or sets the Suppressed.
SweepingPhase Gets or sets the SweepingPhase.
Time Gets the Time.
Type Gets the Type.
VisibleProperties Gets the list of properties that are visible for this object.