Class: AcousticIncidentWaveSource

Defines a AcousticIncidentWaveSource.

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

Properties

Name Description
AnglePhi Gets or sets the AnglePhi.
AngleTheta Gets or sets the AngleTheta.
CalculateIncidentPower Gets or sets the CalculateIncidentPower.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DipoleLength Gets or sets the DipoleLength.
ExcitationType Gets or sets the ExcitationType.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
IncidentWaveLocation Gets or sets the IncidentWaveLocation.
InternalObject Gets the internal object. For advanced usage only.
MassDensity Gets or sets the MassDensity.
Material Gets or sets the Material.
MaterialAssignment ***OBSOLETE*** Use 'Material' property instead Gets or sets the Material.
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.
PhaseAngle Gets or sets the PhaseAngle.
PortSelection Gets or sets the PortSelection.
PressureAmplitude Gets or sets the PressureAmplitude.
Properties Gets the list of properties for this object.
RadiusOfPulsatingSphere Gets or sets the RadiusOfPulsatingSphere.
SourceOriginX Gets or sets the SourceOriginX.
SourceOriginY Gets or sets the SourceOriginY.
SourceOriginZ Gets or sets the SourceOriginZ.
SpeedOfSound Gets or sets the SpeedOfSound.
Suppressed Gets or sets the Suppressed.
VelocityAmplitude Gets or sets the VelocityAmplitude.
VisibleProperties Gets the list of properties that are visible for this object.
WaveNumber Gets the WaveNumber.
WaveType Gets or sets the WaveType.
XComponentOfUnitDipoleVector Gets or sets the XComponentOfUnitDipoleVector.
YComponentOfUnitDipoleVector Gets or sets the YComponentOfUnitDipoleVector.
ZComponentOfUnitDipoleVector Gets or sets the ZComponentOfUnitDipoleVector.