Class: PrimaryCriterion

Defines a PrimaryCriterion.

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.
EvaluateAllResults() Run the EvaluateAllResults action.
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.

Properties

Name Description
BaseResult Gets or sets the BaseResult.
BoundaryCondition Gets or sets the BoundaryCondition.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the Coordinate System.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DirectionX Gets or sets the DirectionX.
DirectionY Gets or sets the DirectionY.
DirectionZ Gets or sets the DirectionZ.
DiscretizationError Gets or sets the DiscretizationError.
Figures Gets the list of associated figures.
FrequencyRangeType Gets or sets the FrequencyRangeType.
FrequencyReduction Gets or sets the FrequencyReduction.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
LocationMethod Gets or sets the LocationMethod.
MaximumFrequency Gets or sets the MaximumFrequency.
MinimumFrequency Gets or sets the MinimumFrequency.
ModeNumber Gets or sets the ModeNumber.
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.
ReadOnly Gets or sets the ReadOnly.
ReferenceType Gets or sets the ReferenceType.
RemotePoint Gets or sets the RemotePoint.
RobustFrequenciesReduction Gets or sets the RobustFrequenciesReduction.
SpatialReduction Gets or sets the SpatialReduction.
SpatialReductionMethod Gets or sets the SpatialReductionMethod.
Step Gets or sets the Step.
Suppressed Gets or sets the Suppressed.
Value Gets the Value.
VectorReduction Gets or sets the VectorReduction.
VisibleProperties Gets the list of properties that are visible for this object.