|
M
Approximate(Boolean)
|
None
|
Switches between non-approximated (e.g., Curved) Analytical Models
and approximated (made up of lines only) Analytical Models
|
|
|
M
ArePhasesModifiable()
|
bool
|
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element .)
|
Element
|
|
M
CanApproximate()
|
bool
|
Indicates if Analytical Model can be approximated or not.
|
|
|
M
CanBeHidden(View)
|
bool
|
Indicates if the element can be hidden in the view. (Inherited from Element .)
|
Element
|
|
M
CanBeLocked()
|
bool
|
Identifies if the element can be locked. (Inherited from Element .)
|
Element
|
|
M
CanDeleteSubelement(Subelement)
|
bool
|
Checks if given subelement can be removed from the element. (Inherited from Element .)
|
Element
|
|
M
CanDisableAutoDetect(AnalyticalDirection)
|
bool
|
Indicates if Analytical Auto-detect can be disabled programmatically
|
|
|
M
CanHaveAnalyticalModel()
|
bool
|
Indicates whether the Element can have an Analytical Model. (Inherited from Element .)
|
Element
|
|
M
CanHaveRigidLinks()
|
bool
|
Indicates if Analytical Model supports Rigid Links.
|
|
|
M
CanHaveTypeAssigned.()
|
bool
|
Identifies if the element can have a type assigned. (Inherited from Element .)
|
Element
|
|
M
CanUseHardPoints()
|
bool
|
Indicates if Analytical Model can use Hard Points.
|
|
|
M
ChangeTypeId(ElementId)
|
ElementId
|
Changes the type of the element. (Inherited from Element .)
|
Element
|
|
M
CloneAdjustment(AnalyticalModel, Int32)
|
None
|
The method clones the adjustment of one end of the AM on another AM,
with respect to the one of the ends.
One of the Analytical Model ends
|
|
|
M
DeleteEntity(Schema)
|
bool
|
Deletes the existing entity created by %schema% in the element (Inherited from Element .)
|
Element
|
|
M
DeleteSubelement(Subelement)
|
bool
|
Removes a subelement from the element. (Inherited from Element .)
|
Element
|
|
M
DeleteSubelements(IList<Subelement>)
|
bool
|
Removes the subelements from the element. (Inherited from Element .)
|
Element
|
|
M
Disconnect(AnalyticalElementSelector)
|
None
|
Unjoin from Hub Element.
|
|
|
M
Dispose()
|
None
|
(Inherited from Element .)
|
Element
|
|
M
Enable(Boolean)
|
None
|
Enables or disables Analytical Model, if the Element allows a one-operation Analytical Model toggle.
|
|
|
M
EnableAutoDetect(AnalyticalDirection, Boolean)
|
None
|
Enable or disable Analytical Auto-detect.
|
|
|
M
Equals
|
None
|
Determines whether the specified Object is equal to the current Object . (Inherited from Object .)
|
Object .
|
|
M
GetAnalyticalModel()
|
Writeable Analytical Model.
|
Retrieves writeable Analytical Model for Element. (Inherited from Element .)
|
Element
|
|
M
GetAnalyticalModelId()
|
Element Id.
|
Retrieves the Element Id of the Analytical Model Element for this Element. (Inherited from Element .)
|
Element
|
|
M
GetAnalyticalModelSketchComponents()
|
IList<AnalyticalModelSketchComponent>
|
Retrieves a collection of AnalyticalModelSketchComponent objects, which are useful for those Analytical Models
that have finer calibration below the Element level.
|
|
|
M
GetAnalyticalModelSupports()
|
IList<AnalyticalModelSupport>
|
Retrieves the AnalyticalModelSupport array, which is useful to extract Analytical
Support Information from Elements.
|
|
|
M
GetAnalyzeAs()
|
AnalyzeAs
|
Returns value of Analyze As parameter for Analytical Model.
|
|
|
M
GetApproximationDeviation()
|
double
|
Retrieves amount by which approximation is made.
|
|
|
M
GetAutoDetectMatchedElements(AnalyticalDirection)
|
ICollection<ElementId>
|
Retrieves other Element Ids that this Element is Auto-detecting against.
|
|
|
M
GetCurve()
|
Curve
|
Returns the single curve of the Analytical Model, if it is only one curve.
|
|
|
M
GetCurves(AnalyticalCurveType)
|
IList<Curve>
|
Retrieves all curves for the Analytical Model of a given type.
|
|
|
M
GetDependentElements(ElementFilter)
|
IList<ElementId>
|
Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element .)
|
Element
|
|
M
GetElementId()
|
ElementId
|
Retrieves Element Id of the structural element corresponding to the Analytical Model.
|
|
|
M
GetEntity(Schema)
|
The returned Entity.
|
Returns the existing entity corresponding to the Schema if it has been saved in the
Element, or an invalid entity otherwise. (Inherited from Element .)
|
Element
|
|
M
GetEntitySchemaGuids()
|
IList<Guid>
|
Returns the Schema guids of any Entities stored in this element. (Inherited from Element .)
|
Element
|
|
M
GetExternalFileReference()
|
ExternalFileReference
|
Gets information pertaining to the external file referenced
by the element. (Inherited from Element .)
|
Element
|
|
M
GetExternalResourceReference(ExternalResourceType)
|
ExternalResourceReference
|
Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element .)
|
Element
|
|
M
GetExternalResourceReferences()
|
IDictionary
|
Gets the full map of the external resource references referenced
by the element. (Inherited from Element .)
|
Element
|
|
M
GetGeneratingElementIds(GeometryObject)
|
ICollection<ElementId>
|
Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element .)
|
Element
|
|
M
GetGeometryObjectFromReference(Reference)
|
GeometryObject
|
Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element .)
|
Element
|
|
M
GetHashCode
|
None
|
Serves as a hash function for a particular type. (Inherited from Object .)
|
Object .
|
|
M
GetLocalCoordinateSystem()
|
nullNothingnullptr
|
Gets the local coordinate system (LCS) for an analytical model element.
|
|
|
M
GetManualAdjustmentMatchedElements()
|
ICollection<ElementId>
|
Retrieves other Element Ids against which the Analytical Model has been adjusted.
|
|
|
M
GetMaterialArea(ElementId, Boolean)
|
double
|
Gets the area of the material with the given id. (Inherited from Element .)
|
Element
|
|
M
GetMaterialIds(Boolean)
|
ICollection<ElementId>
|
Gets the element ids of all materials present in the element. (Inherited from Element .)
|
Element
|
|
M
GetMaterialVolume(ElementId)
|
double
|
Gets the volume of the material with the given id. (Inherited from Element .)
|
Element
|
|
M
GetMonitoredLinkElementIds()
|
IList<ElementId>
|
Provides the link instance IDs when the element is monitoring. (Inherited from Element .)
|
Element
|
|
M
GetMonitoredLocalElementIds()
|
IList<ElementId>
|
Provides the local element IDs when the element is monitoring. (Inherited from Element .)
|
Element
|
|
M
GetOffset(AnalyticalElementSelector)
|
XYZ
|
Gets the offset of the analytical model at end.
|
|
|
M
GetOrderedParameters()
|
IList<Parameter>
|
Gets the parameters associated to the element in order. (Inherited from Element .)
|
Element
|
|
M
GetParameter(ForgeTypeId)
|
Parameter
|
Retrieves a parameter from the element given identifier. (Inherited from Element .)
|
Element
|
|
M
GetParameterFormatOptions(ElementId)
|
FormatOptions
|
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element .)
|
Element
|
|
M
GetParameters(String)
|
IList<Parameter>
|
Retrieves the parameters from the element via the given name. (Inherited from Element .)
|
Element
|
|
M
GetPhaseStatus(ElementId)
|
ElementOnPhaseStatus
|
Gets the status of a given element in the input phase (Inherited from Element .)
|
Element
|
|
M
GetPoint()
|
XYZ
|
Retrieves point of the Analytical Model.
|
|
|
M
GetReference(AnalyticalModelSelector)
|
Requested reference.
|
Returns a reference to a given curve within the analytical model.
|
|
|
M
GetRigidLink(AnalyticalModelSelector)
|
Curve
|
Returns rigid link curve corresponding to selector.
|
|
|
M
GetSubelements()
|
IList<Subelement>
|
Returns the collection of element subelements. (Inherited from Element .)
|
Element
|
|
M
GetType
|
None
|
Gets the Type of the current instance. (Inherited from Object .)
|
Object .
|
|
M
GetTypeId()
|
ElementId
|
Returns the identifier of this element's type. (Inherited from Element .)
|
Element
|
|
M
GetValidTypes.()
|
ICollection<ElementId>
|
Obtains a set of types that are valid for this element. (Inherited from Element .)
|
Element
|
|
M
HasDeletedLinks()
|
bool
|
Indicates if Analytical Model contains deleted Analytical Links.
|
|
|
M
HasPhases()
|
bool
|
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element .)
|
Element
|
|
M
HasRigidLinksWith(ElementId)
|
bool
|
Indicates if Analytical Model has Rigid Links with specified element.
|
|
|
M
IsAnalyzeAsValid(AnalyzeAs)
|
bool
|
Determines if the given Analyze As parameter is valid for this Element.
|
|
|
M
IsApproximated()
|
bool
|
Indicates if Analytical Model is approximated or not.
|
|
|
M
IsAutoDetectEnabled(AnalyticalDirection)
|
bool
|
Reports if Analytical Auto-detect for the given direction is enabled.
|
|
|
M
IsCreatedPhaseOrderValid(ElementId)
|
bool
|
Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .)
|
Element
|
|
M
IsDemolishedPhaseOrderValid(ElementId)
|
bool
|
Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .)
|
Element
|
|
M
IsElementFullySupported()
|
bool
|
Indicates if Analytical Model is fully supported.
|
|
|
M
IsEnabled()
|
bool
|
Reports whether the Analytical Model is enabled or disabled.
|
|
|
M
IsExternalFileReference()
|
bool
|
Determines whether this Element represents an external
file. (Inherited from Element .)
|
Element
|
|
M
IsHidden(View)
|
bool
|
Identifies if the element has been permanently hidden in the view. (Inherited from Element .)
|
Element
|
|
M
IsManuallyAdjusted()
|
bool
|
Indicates if the Analytical Model has been manually adjusted by the user.
|
|
|
M
IsModified()
|
bool
|
Checks if AM has been adjusted from auto-detect at any end.
|
|
|
M
IsMonitoringLinkElement()
|
bool
|
Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element .)
|
Element
|
|
M
IsMonitoringLocalElement()
|
bool
|
Indicate whether an element is monitoring other local elements. (Inherited from Element .)
|
Element
|
|
M
IsPhaseCreatedValid(ElementId)
|
bool
|
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element .)
|
Element
|
|
M
IsPhaseDemolishedValid(ElementId)
|
bool
|
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element .)
|
Element
|
|
M
IsSingleCurve()
|
bool
|
Indicates if the Analytical Model can be expressed as a single curve.
|
|
|
M
IsSinglePoint()
|
bool
|
Indicates if the Analytical Model can be expressed as a single point.
|
|
|
M
IsValidDirectionForAutoDetect(AnalyticalDirection)
|
bool
|
Tests if the supplied direction is valid for Analytical Auto-detect.
|
|
|
M
IsValidForManualAdjustment(Reference)
|
bool
|
Indicates if the identified reference is acceptable for Manual Analytical Adjustment.
|
|
|
M
IsValidManualAdjustmentSource(Reference, AnalyticalDirection)
|
bool
|
Indicates if the identified reference is acceptable as a source for Manual Analytical Adjustment.
|
|
|
M
IsValidManualAdjustmentTarget(Reference, Reference, AnalyticalDirection)
|
bool
|
Indicates if reference is acceptable as a "Target" for Manual Analytical Adjustment.
|
|
|
M
IsValidRigidLinksOption(AnalyticalRigidLinksOption)
|
bool
|
Indicates if Rigid Links option is valid for the Analytical Model.
|
|
|
M
IsValidSelector(AnalyticalModelSelector)
|
bool
|
Indicates if the input selector is valid for the Analytical Model.
|
|
|
M
IsValidType(ElementId)
|
bool
|
Checks if given type is valid for this element. (Inherited from Element .)
|
Element
|
|
M
LookupParameter(String)
|
nullNothingnullptr
|
Attempts to find a parameter on the element which has the given name. (Inherited from Element .)
|
Element
|
|
M
ManuallyAdjust(Reference, Reference)
|
bool
|
Perform Manual Analytical Adjustment on analytical model, with respect to another Element
|
|
|
M
RefersToExternalResourceReference(ExternalResourceType)
|
bool
|
Determines whether this Element uses external resources associated with
a specified external resource type. (Inherited from Element .)
|
Element
|
|
M
RefersToExternalResourceReferences()
|
bool
|
Determines whether this Element uses external resources. (Inherited from Element .)
|
Element
|
|
M
ResetLinks()
|
None
|
The function is trying to recreate analytical link elements that were deleted by the user.
|
|
|
M
ResetManualAdjustment()
|
bool
|
Resets all manual adjustments performed by the user onto the Analytical Model.
|
|
|
M
SetAnalyzeAs(AnalyzeAs)
|
None
|
Sets value of Analyze As parameter for this Element.
|
|
|
M
SetApproximationDeviation(Double)
|
None
|
Adjusts the amount by which approximation is made.
|
|
|
M
SetEntity(Entity)
|
None
|
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten. (Inherited from Element .)
|
Element
|
|
M
SetOffset(AnalyticalElementSelector, XYZ)
|
None
|
Sets the offset of the analytical model at end.
|
|
|
M
SetUsesHardPoints(Boolean)
|
None
|
Sets Hard Points for the Analytical Model.
|
|
|
M
SupportsManualAdjustment()
|
bool
|
Indicates if the Element supports Manual Analytical Adjustment.
|
|
|
M
ToString
|
None
|
Returns a string that represents the current object. (Inherited from Object .)
|
Object .
|
|
M
UsesHardPoints()
|
bool
|
Indicates if the Analytical Model is using Hard Points during approximation.
|
|