ChannelCreateFromAlignment(String, ObjectId, ObjectId, TupleDouble, Double, ObjectId, ObjectId) Method |
Create channel from alignment and profile with more options.
Namespace: Autodesk.Civil.DatabaseServicesAssembly: AeccDrainageDesignMgd (in AeccDrainageDesignMgd.dll) Version: 13.9.960.0
Syntaxpublic static ObjectId CreateFromAlignment(
string channelName,
ObjectId alignmentId,
ObjectId profileId,
Tuple<double, double> stationRange,
ObjectId channelStyleId,
ObjectId layerId
)
Public Shared Function CreateFromAlignment (
channelName As String,
alignmentId As ObjectId,
profileId As ObjectId,
stationRange As Tuple(Of Double, Double),
channelStyleId As ObjectId,
layerId As ObjectId
) As ObjectId
public:
static ObjectId CreateFromAlignment(
String^ channelName,
ObjectId alignmentId,
ObjectId profileId,
Tuple<double, double>^ stationRange,
ObjectId channelStyleId,
ObjectId layerId
)
Parameters
- channelName String
- Name of the channel to be created.
- alignmentId ObjectId
- Object id of the alignment used to create channel.
- profileId ObjectId
- Object id of the profile used to create channel.
- stationRange TupleDouble, Double
- Station range of channel's start/end station. If it's null, then no specified station range.
- channelStyleId ObjectId
- Channel style object id of the channel to be created. If it's Null object id, then a default channel style is used.
- layerId ObjectId
- Layer object id of the channel to be created. If it's Null object id, then a default layer is used.
Return Value
ObjectIdObject id of the channel created.
Exceptions| Exception | Condition |
|---|
| BackwardCompatibilityException |
Thrown when getting/setting value and data is not compatible with the current version of the channel. Try to fix by upgrading the channel.
|
| ForwardCompatibilityException |
Thrown when getting/setting value and data is not compatible with the current version of the channel. Try to fix by opening the drawing in a newer version of the product.
|
| ArgumentException |
Thrown when:
- Channel name is empty.
- Channel name is duplicate.
- Channel name contains invalid character.
- Alignment object id is invalid.
- Profile object id is invalid.
- The profile doesn't belong to the alignment.
- Station range start is bigger than or equal to station range end.
- Channel style object id is invalid.
- Layer object id is invalid.
|
| ArgumentNullException |
Thrown when the specified channel name string is null.
|
| ArgumentOutOfRangeException |
Thrown when:
- Station range start is out of station range of the baseline.
- Station range end is out of station range of the baseline.
|
Example
This example shows how to create a channel from an alignment.
1ObjectId alignmentId = CivilDocument.GetCivilDocument(m_Database).GetAlignmentIds()[0];
2ObjectId profileId = (alignmentId.GetObject(OpenMode.ForRead) as Alignment).GetProfileIds()[0];
3
4Tuple<double, double> stationRange = new Tuple<double, double> (100, 3000);
5ObjectId sytleId = CivilApplication.ActiveDocument.Styles.GetChannelStyles()["Standard"];
6ObjectId layerId = (m_Database.LayerTableId.GetObject(OpenMode.ForRead) as Autodesk.AutoCAD.DatabaseServices.LayerTable)["0"];
7
8ObjectId channelId = Channel.CreateFromAlignment("channel name", alignmentId, profileId, stationRange, sytleId, layerId);
See Also