SampleLine Class

Lines used for obtaining elevational information from an existing terrain model or surface for creating profiles and cross sections.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    DisposableWrapper
      RXObject
        Drawable
          DBObject
            Entity
              Curve
                Entity
                  Autodesk.Civil.DatabaseServicesEntity
                    Autodesk.Civil.DatabaseServicesGeoEntity
                      Autodesk.Civil.DatabaseServicesSampleLine

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292

Syntax

C++

Copy

public sealed class SampleLine : GeoEntity

Public NotInheritable Class SampleLine
	Inherits GeoEntity

public ref class SampleLine sealed : public GeoEntity

The SampleLine type exposes the following members.

Properties

	Name	Description
	Application	Gets the Application. Not currently implemented. (Inherited from Entity)
	Description	Gets or sets the Entity object's description. (Inherited from Entity)
	DisplayName	Gets the Entity object's display name. (Inherited from Entity)
	Document	Gets the Document. Not currently implemented. (Inherited from Entity)
	FingerPrint	Gets or sets FingerPrint of the Entity. (Inherited from Entity)
	FolderId	Gets the folder ObjectId of the Entity Returns ObjectId::Null if the Entity is located in root folder (Inherited from Entity)
	GroupId	Gets the object id of the sample line group it belongs to.
	IsCWSReferenceObject	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)
	IsCWSSourceObject	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)
	IsPartialReferenceObject	Gets whether the surface is partial reference surface. (Inherited from Entity)
	IsReadOnlyReferenceObject	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)
	IsReferencedSourceExisting	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)
	IsReferenceObject	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)
	IsReferenceStale	For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale. (Inherited from Entity)
	IsReferenceSubObject	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)
	IsReferenceValid	For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid. (Inherited from Entity)
	IsUsed	Gets whether the style is used by other objects in the current drawing. (Inherited from Entity)
	LockToStation	Gets or sets a boolean value which specified whether locks the SampleLine to the station of the alignment.
	Name	Gets or sets the Entity object's name. (Inherited from Entity)
	Number	Gets the assigned sample line number of sample line.
	ShowToolTip	Gets or sets whether to show tooltips for the Entity. (Inherited from Entity)
	Station	Gets or sets the station of the sample line.
	StyleId	Sets the SampleLine style. (Overrides EntityStyleId)
	StyleName	Sets the SampleLine style by Name. (Overrides EntityStyleName)
	Vertices	Gets all the vertex points of the sample line.

Top

Methods

	Name	Description
	ComputeFingerPrint	Compute FingerPrint of the Entity. (Inherited from Entity)
	Create(String, ObjectId, Point2dCollection)	Creates a new sample line with specified vertex points.
	Create(String, ObjectId, Double)	Creates a new sample line at a specified station.
	GetMaterialSectionId	Gets MaterialSection objectId by MaterialList GUID and Material GUID.
	GetReferenceInfo	For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information. (Inherited from Entity)
	GetSectionId	Gets section objectId generated from the specified source.
	GetSectionIds	Gets the objectId collection of all sections attached on this sample line.
	GetSectionViewIds	Gets the objectId collection of all section views attached on this sample line.

Top

Remarks

Sample Lines are lines placed along an alignment at a specified station interval (or at defined stations of interest, such as at assemblies of a corridor object), using a specified left and right swath width. SampleLine objects are contained in SampleLineGroup objects, which organize multiple related sample lines. A SampleLine is used to create a SectionView object, which displays some or all of the sections sampled at that sample line.

Reference

Autodesk.Civil.DatabaseServices Namespace