The AnalyticalModel type exposes the following members.

Methods

  NameDescription
Public methodApproximate
Switches between non-approximated (e.g., Curved) Analytical Models and approximated (made up of lines only) Analytical Models
Public methodArePhasesModifiable
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element.)
Public methodCanApproximate
Indicates if Analytical Model can be approximated or not.
Public methodCanBeHidden
Indicates if the element can be hidden in the view.
(Inherited from Element.)
Public methodCanBeLocked
Identifies if the element can be locked.
(Inherited from Element.)
Public methodCanDeleteSubelement
Checks if given subelement can be removed from the element.
(Inherited from Element.)
Public methodCanDisableAutoDetect
Indicates if Analytical Auto-detect can be disabled programmatically
Public methodCanHaveAnalyticalModel
Indicates whether the Element can have an Analytical Model.
(Inherited from Element.)
Public methodCanHaveRigidLinks
Indicates if Analytical Model supports Rigid Links.
Public methodCanHaveTypeAssigned()()()()
Identifies if the element can have a type assigned.
(Inherited from Element.)
Public methodCanUseHardPoints
Indicates if Analytical Model can use Hard Points.
Public methodChangeTypeId(ElementId)
Changes the type of the element.
(Inherited from Element.)
Public methodCloneAdjustment
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
Public methodDeleteEntity
Deletes the existing entity created by %schema% in the element
(Inherited from Element.)
Public methodDeleteSubelement
Removes a subelement from the element.
(Inherited from Element.)
Public methodDeleteSubelements
Removes the subelements from the element.
(Inherited from Element.)
Public methodDisconnect
Unjoin from Hub Element.
Public methodDispose (Inherited from Element.)
Public methodEnable
Enables or disables Analytical Model, if the Element allows a one-operation Analytical Model toggle.
Public methodEnableAutoDetect
Enable or disable Analytical Auto-detect.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAnalyticalModel
Retrieves writeable Analytical Model for Element.
(Inherited from Element.)
Public methodGetAnalyticalModelId
Retrieves the Element Id of the Analytical Model Element for this Element.
(Inherited from Element.)
Public methodGetAnalyticalModelSketchComponents
Retrieves a collection of AnalyticalModelSketchComponent objects, which are useful for those Analytical Models that have finer calibration below the Element level.
Public methodGetAnalyticalModelSupports
Retrieves the AnalyticalModelSupport array, which is useful to extract Analytical Support Information from Elements.
Public methodGetAnalyzeAs
Returns value of Analyze As parameter for Analytical Model.
Public methodGetApproximationDeviation
Retrieves amount by which approximation is made.
Public methodGetAutoDetectMatchedElements
Retrieves other Element Ids that this Element is Auto-detecting against.
Public methodGetCurve
Returns the single curve of the Analytical Model, if it is only one curve.
Public methodGetCurves
Retrieves all curves for the Analytical Model of a given type.
Public methodGetDependentElements
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element.)
Public methodGetElementId
Retrieves Element Id of the structural element corresponding to the Analytical Model.
Public methodGetEntity
Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
(Inherited from Element.)
Public methodGetEntitySchemaGuids
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element.)
Public methodGetExternalFileReference
Gets information pertaining to the external file referenced by the element.
(Inherited from Element.)
Public methodGetExternalResourceReference
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.)
Public methodGetExternalResourceReferences
Gets the full map of the external resource references referenced by the element.
(Inherited from Element.)
Public methodGetGeneratingElementIds
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element.)
Public methodGetGeometryObjectFromReference
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLocalCoordinateSystem
Gets the local coordinate system (LCS) for an analytical model element.
Public methodGetManualAdjustmentMatchedElements
Retrieves other Element Ids against which the Analytical Model has been adjusted.
Public methodGetMaterialArea
Gets the area of the material with the given id.
(Inherited from Element.)
Public methodGetMaterialIds
Gets the element ids of all materials present in the element.
(Inherited from Element.)
Public methodGetMaterialVolume
Gets the volume of the material with the given id.
(Inherited from Element.)
Public methodGetMonitoredLinkElementIds
Provides the link instance IDs when the element is monitoring.
(Inherited from Element.)
Public methodGetMonitoredLocalElementIds
Provides the local element IDs when the element is monitoring.
(Inherited from Element.)
Public methodGetOffset
Gets the offset of the analytical model at end.
Public methodGetOrderedParameters
Gets the parameters associated to the element in order.
(Inherited from Element.)
Public methodGetParameterFormatOptions
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element.)
Public methodGetParameters
Retrieves the parameters from the element via the given name.
(Inherited from Element.)
Public methodGetPhaseStatus
Gets the status of a given element in the input phase
(Inherited from Element.)
Public methodGetPoint
Retrieves point of the Analytical Model.
Public methodGetReference
Returns a reference to a given curve within the analytical model.
Public methodGetRigidLink
Returns rigid link curve corresponding to selector.
Public methodGetSubelements
Returns the collection of element subelements.
(Inherited from Element.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeId
Returns the identifier of this element's type.
(Inherited from Element.)
Public methodGetValidTypes()()()()
Obtains a set of types that are valid for this element.
(Inherited from Element.)
Public methodHasDeletedLinks
Indicates if Analytical Model contains deleted Analytical Links.
Public methodHasPhases
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element.)
Public methodHasRigidLinksWith
Indicates if Analytical Model has Rigid Links with specified element.
Public methodIsAnalyzeAsValid
Determines if the given Analyze As parameter is valid for this Element.
Public methodIsApproximated
Indicates if Analytical Model is approximated or not.
Public methodIsAutoDetectEnabled
Reports if Analytical Auto-detect for the given direction is enabled.
Public methodIsElementFullySupported
Indicates if Analytical Model is fully supported.
Public methodIsEnabled
Reports whether the Analytical Model is enabled or disabled.
Public methodIsExternalFileReference
Determines whether this Element represents an external file.
(Inherited from Element.)
Public methodIsHidden
Identifies if the element has been permanently hidden in the view.
(Inherited from Element.)
Public methodIsManuallyAdjusted
Indicates if the Analytical Model has been manually adjusted by the user.
Public methodIsModified
Checks if AM has been adjusted from auto-detect at any end.
Public methodIsMonitoringLinkElement
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element.)
Public methodIsMonitoringLocalElement
Indicate whether an element is monitoring other local elements.
(Inherited from Element.)
Public methodIsPhaseCreatedValid
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element.)
Public methodIsPhaseDemolishedValid
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element.)
Public methodIsSingleCurve
Indicates if the Analytical Model can be expressed as a single curve.
Public methodIsSinglePoint
Indicates if the Analytical Model can be expressed as a single point.
Public methodIsValidDirectionForAutoDetect
Tests if the supplied direction is valid for Analytical Auto-detect.
Public methodIsValidForManualAdjustment
Indicates if the identified reference is acceptable for Manual Analytical Adjustment.
Public methodIsValidManualAdjustmentSource
Indicates if the identified reference is acceptable as a source for Manual Analytical Adjustment.
Public methodIsValidManualAdjustmentTarget
Indicates if reference is acceptable as a "Target" for Manual Analytical Adjustment.
Public methodIsValidRigidLinksOption
Indicates if Rigid Links option is valid for the Analytical Model.
Public methodIsValidSelector
Indicates if the input selector is valid for the Analytical Model.
Public methodIsValidType(ElementId)
Checks if given type is valid for this element.
(Inherited from Element.)
Public methodLookupParameter
Attempts to find a parameter on the element which has the given name.
(Inherited from Element.)
Public methodManuallyAdjust
Perform Manual Analytical Adjustment on analytical model, with respect to another Element
Public methodRefersToExternalResourceReference
Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element.)
Public methodRefersToExternalResourceReferences
Determines whether this Element uses external resources.
(Inherited from Element.)
Public methodResetLinks
The function is trying to recreate analytical link elements that were deleted by the user.
Public methodResetManualAdjustment
Resets all manual adjustments performed by the user onto the Analytical Model.
Public methodSetAnalyzeAs
Sets value of Analyze As parameter for this Element.
Public methodSetApproximationDeviation
Adjusts the amount by which approximation is made.
Public methodSetEntity
Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element.)
Public methodSetOffset
Sets the offset of the analytical model at end.
Public methodSetUsesHardPoints
Sets Hard Points for the Analytical Model.
Public methodSupportsManualAdjustment
Indicates if the Element supports Manual Analytical Adjustment.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUsesHardPoints
Indicates if the Analytical Model is using Hard Points during approximation.

Properties

  NameDescription
Public propertyAssemblyInstanceId
The id of the assembly instance to which the element belongs.
(Inherited from Element.)
Public propertyBoundingBox
Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element.)
Public propertyCategory
Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element.)
Public propertyCreatedPhaseId
Id of a Phase at which the Element was created.
(Inherited from Element.)
Public propertyDemolishedPhaseId
Id of a Phase at which the Element was demolished.
(Inherited from Element.)
Public propertyDesignOption
Returns the design option to which the element belongs.
(Inherited from Element.)
Public propertyDocument
Returns the Document in which the Element resides.
(Inherited from Element.)
Public propertyGeometry
Retrieves the geometric representation of the element.
(Inherited from Element.)
Public propertyGroupId
The id of the group to which an element belongs.
(Inherited from Element.)
Public propertyId
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element.)
Public propertyIsTransient
Indicates whether an element is transient or permanent.
(Inherited from Element.)
Public propertyIsValidObject
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element.)
Public propertyLevelId
The id of the level associated with the element.
(Inherited from Element.)
Public propertyLocation
This property is used to find the physical location of an element within a project.
(Inherited from Element.)
Public propertyName
A human readable name for the Element.
(Inherited from Element.)
Public propertyOwnerViewId
The id of the view that owns the element.
(Inherited from Element.)
Public propertyParameter[([( Guid])])
Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element.)
Public propertyParameter[([( BuiltInParameter])])
Retrieves a parameter from the element given a parameter id.
(Inherited from Element.)
Public propertyParameter[([( Definition])])
Retrieves a parameter from the element based on its definition.
(Inherited from Element.)
Public propertyParameters
Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element.)
Public propertyParametersMap
Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element.)
Public propertyPinned
Identifies if the element has been pinned to prevent changes.
(Inherited from Element.)
Public propertyRigidLinksOption
Indicates if parameters indicate if Rigid Links should be formed.
Public propertyUniqueId
A stable unique identifier for an element within the document.
(Inherited from Element.)
Public propertyVersionGuid
Get the element version Guid.
(Inherited from Element.)
Public propertyViewSpecific
Identifies if the element is owned by a view.
(Inherited from Element.)
Public propertyWorksetId
Get Id of the Workset which owns the element.
(Inherited from Element.)

See Also