Profile Class

A record of elevation against distance along a horizontal Alignment or other line. Profiles are used to visualize the terrain along a route of interest, such as a proposed road, or simply to show how the elevation changes across a particular region.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    DisposableWrapper
      RXObject
        Drawable
          DBObject
            Entity
              Curve
                Entity
                  Autodesk.Civil.DatabaseServicesEntity
                    Autodesk.Civil.DatabaseServicesFeature
                      Autodesk.Civil.DatabaseServicesProfile

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
Syntax
public sealed class Profile : Feature

The Profile type exposes the following members.

Properties
 NameDescription
Public propertyAlignmentId Gets the object id of the corresponding alignment for the profile.
Public propertyApplication Gets the Application. Not currently implemented.
(Inherited from Entity)
Public propertyDataSourceId Gets the object id of object that is associated with the profile.
Public propertyDataSourceName Gets the name of object that is associated with the profile.
Public propertyDescription Gets or sets the Entity object's description.
(Inherited from Entity)
Public propertyDesignCheckSetId Gets the object id of design check set that is used in the profile.
Public propertyDesignCheckSetName Gets the name of of design check set that is used in the profile.
Public propertyDesignSpeedBased Gets or sets whether the design is speed-based.
Public propertyDisplayName Gets the Entity object's display name.
(Inherited from Entity)
Public propertyDocument Gets the Document. Not currently implemented.
(Inherited from Entity)
Public propertyElevationMax Gets the maximum elevation value on the profile.
Public propertyElevationMin Gets the minimum elevation value on the profile.
Public propertyEndingStation Gets the profile ending station.
Public propertyEntities Gets the profile entities' collection.
Public propertyFingerPrint Gets or sets FingerPrint of the Entity.
(Inherited from Entity)
Public propertyFolderId Gets the folder ObjectId of the Entity Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity)
Public propertyIsCWSReferenceObject Gets whether the Entity is a Civil Worksharing reference object. A Civil Worksharing reference object is a Civil object shared to Shared Space. It is not editable. But it can be updated to the new version in the Shared Space.
(Inherited from Entity)
Public propertyIsCWSSourceObject Gets whether the Entity is a Civil Worksharing source object. A Civil Worksharing source object is a Civil object shared to Shared Space. It is editable and can be updated to Shared Space.
(Inherited from Entity)
Public propertyIsEditable Gets the value indicates whether the Feature derived entity (Alignment,Profile,etc) is editable.
(Inherited from Feature)
Public propertyIsPartialReferenceObject Gets whether the surface is partial reference surface.
(Inherited from Entity)
Public propertyIsReadOnlyReferenceObject Gets whether the Entity is a readonly reference object. A readonly reference object is either a data shortcut referece object or a Civil Worksharing reference object.
(Inherited from Entity)
Public propertyCode exampleIsReferencedSourceExisting For reference object (IsReferenceObject == true), it will try to get its source entity while opening a drawing. This indicates whether the reference object has source entity.
(Inherited from Entity)
Public propertyIsReferenceObject Gets whether the Entity is a reference object. A reference object is located in another drawing, and linked using a data shortcut or Vault. If the entity is native to the current drawing this property returns false; if it is being referenced via data shortcuts or AutoCAD Vault it returns true.
(Inherited from Entity)
Public propertyIsReferenceStale For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity)
Public propertyIsReferenceSubObject For reference objects (IsReferenceObject == true), gets whether the Entity is a reference subobject. For example, when iterating through the structure of a pipe network referenced from another drawing, this property is true for each entity.
(Inherited from Entity)
Public propertyIsReferenceValid For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity)
Public propertyIsUsed Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity)
Public propertyLength Gets the profile length.
Public propertyName Gets or sets the Entity object's name.
(Inherited from Entity)
Public propertyOffset Gets the profile offset.
Public propertyOffsetParameters Gets an offset profile's parameters.
Public propertyPlinegen Gets or sets the PLINEGEN setting for the profile.
Public propertyProfileType Gets or sets the profile type.
Public propertyCode examplePVIs Gets the points of vertical intersection for the profile.
Public propertyShowToolTip Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity)
Public propertyStartingStation Gets the profile starting station.
Public propertyStyleId Sets the profile's style Id.
(Overrides EntityStyleId)
Public propertyStyleName Sets the profile's style name.
(Overrides EntityStyleName)
Public propertyUpdateMode Gets or sets the update mode of the profile.
Public propertyUseDesignCheckSet Gets or sets whether the design check set is used.
Public propertyUseDesignCriteriaFile Gets or sets whether the design criteria file is used.
Top
Methods
 NameDescription
Public methodComputeFingerPrint Compute FingerPrint of the Entity.
(Inherited from Entity)
Public methodStatic memberCode exampleCreateByLayout(String, ObjectId, ObjectId, ObjectId, ObjectId) Creates a profile of FG type.
Public methodStatic memberCreateByLayout(String, CivilDocument, String, String, String, String) Creates a profile of FG type.
Public methodStatic memberCreateFromFeatureLine Creates a profile of EG type from a corridor feature line.
Public methodStatic memberCreateFromSurface(String, ObjectId, ObjectId, ObjectId, ObjectId, ObjectId) Creates a profile of EG type from a surface.
Public methodStatic memberCreateFromSurface(String, CivilDocument, String, String, String, String, String) Creates a profile of EG type from a surface.
Public methodStatic memberCreateFromSurface(String, ObjectId, ObjectId, ObjectId, ObjectId, ObjectId, Double, Double, Double) Creates a profile of EG type from a surface.
Public methodStatic memberCreateFromSurface(String, CivilDocument, String, String, String, String, String, Double, Double, Double) Creates a profile of EG type from a surface.
Public methodCreateOffsetProfileBySlope(String, ObjectId, ObjectId, Double) Creates a profile of Offset type
Public methodCreateOffsetProfileBySlope(String, String, String, Double) Creates a profile of Offset type
Public methodStatic memberCreateStaticFGFromProfile(String, ObjectId, ObjectId, ObjectId, ObjectId) Creates a new static FG profile from another profile. The profile inherits the originating profile's geometry, the update type is static. The new profile belongs to the same alignment of the originating profile.
Public methodStatic memberCreateStaticFGFromProfile(String, CivilDocument, String, String, String, String) Creates a new static FG profile from another profile. The profile inherits the originating profile's geometry, the update type is static. The new profile belongs to the same alignment of the originating profile.
Public methodElevationAt Gets the elevation at a specified station.
Public methodCode exampleGetReferenceInfo For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity)
Public methodGradeAt Given a station, gets the instantaneous grade and the algebraic difference.
Top
Remarks
A profile can record the elevation of the surface along an alignment. Together, a profile and an alignment represent a 3D path. Such a path can form the baseline of a Corridor. A ProfileView is used to display one or more profiles for a horizontal alignment. You can configure data bands and profile annotations in a ProfileView to make it clearer or more informative for the user. In general, you do not directly edit a surface profile (existing ground profile). If you move the parent alignment or edit the surface, the changes are reflected in the surface profile. By contrast, the layout profile is a fully designed object that you usually edit in many ways, such as changing tangent grades, modifying curves, and adding or moving points of vertical intersection (PVI).
See Also