Class Reports
Contains static methods used to execute WisDOT Reports.
Namespace: WisDOT
Assembly: WisDOT.Extensions.dll
Methods
AddAreaLabels(ObjectIdCollection, int, string)
Adds MText area lables to the selected objects with options for precision and units.
Declaration
public static void AddAreaLabels(ObjectIdCollection objects, int areaPrecision, string areaUnits)Parameters
| Type | Name | Description |
|---|---|---|
| ObjectIdCollection | objects | ObjectIdCollection of entities to label |
| int | areaPrecision | Number of decimal places to include |
| string | areaUnits | Indicate "SF" for square feet or "SY" for square yards |
CalculateEarthwork(ObjectId, ObjectId, string, bool, bool, bool, bool)
Creates earthwork detail report data for WisDOT specifications.
Declaration
public static List<List<string>> CalculateEarthwork(ObjectId slStartId, ObjectId slEndId, string materialList, bool useMarsh, bool useEBS, bool backfillMarsh, bool backfillEBS)Parameters
| Type | Name | Description |
|---|---|---|
| ObjectId | slStartId | ObjectId of start sample line |
| ObjectId | slEndId | ObjectId of end sample line |
| string | materialList | Name of the material list to use. |
| bool | useMarsh | Use marsh in fill. |
| bool | useEBS | Use Excavation Below Subgrade in fill. |
| bool | backfillMarsh | Backfill marsh with common excavation. |
| bool | backfillEBS | Backfill Excavation Below Subgrade with common excavation. |
Returns
| Type | Description |
|---|---|
| List<List<string>> | List of string lists containing each line of the report. |
ExportStyles(Database, Dictionary<string, List<string>>)
Exports a dictionary of styles to another drawing database
Declaration
public static void ExportStyles(Database exportDb, Dictionary<string, List<string>> styles)Parameters
| Type | Name | Description |
|---|---|---|
| Database | exportDb | Drawing database to export to |
| Dictionary<string, List<string>> | styles | Dictionary of styles. Use output of StylesReport() as guide |
FeatureLineDescriptions()
Creates an .xlsx file with a course description of feature line(s).
Declaration
public static List<List<string>> FeatureLineDescriptions()Returns
| Type | Description |
|---|---|
| List<List<string>> |
Remarks
Curve data is not included. If a feature line includes a curve, the bearing and distance of the curve chord is reported.
https://c3dkb.dot.wi.gov/Content/c3d/wisdot-cstm/c3d-tab/srvy/srvy-rprt-fl-dscrptn.htm
FeatureLineStationOffsets()
Creates a .xlsx of station and offset values for all vertices in one or more feature lines.
Declaration
public static List<List<string>> FeatureLineStationOffsets()Returns
| Type | Description |
|---|---|
| List<List<string>> |
Remarks
GetCSDescAndCat(string, bool)
Returns a string list with index 0 = the coordinate system description and index 1 = coordinate system catagory (optional)
Declaration
public static List<string> GetCSDescAndCat(string csCode, bool csCat)Parameters
| Type | Name | Description |
|---|---|---|
| string | csCode | Coordinate system code to report on. |
| bool | csCat | Return coordinate system catagory. It's possible for a system to be listed in multiple catagories. This return the primary catagory. |
Returns
| Type | Description |
|---|---|
| List<string> | List of strings |
GetDWGUnitsZone(string)
Returns a string list containing in the order listed: Drawing Units, Metric/Imperial conversion units, insertion units, LandXml export units, plot style mode, Coordinate system code,
Declaration
public static List<string> GetDWGUnitsZone(string fileName)Parameters
| Type | Name | Description |
|---|---|---|
| string | fileName | File path to the DWG file to report on. |
Returns
| Type | Description |
|---|---|
| List<string> | String List containing the file information. |
ParcelLegalDescription(string, string[])
Creates a .txt file of a legal description of one or more parcels.
Declaration
public static void ParcelLegalDescription(string helpKey, string[] counties)Parameters
| Type | Name | Description |
|---|---|---|
| string | helpKey | The command name used to execute this method. This is used to look up the help url in the /en-US/HelpResources.csv |
| string[] | counties | String array of counties to list in the form's County combo box. |
Remarks
Report3DSurfAreas(ObservableCollection<SelectableItem>, string, int, int, string)
Builds a list of object arrays for downstream report creation. Each object array includes the station range, location (reference alignment), area, and layer
Declaration
public static List<object[]> Report3DSurfAreas(ObservableCollection<SelectableItem> surfaces, string alignment, int areaPrecision, int stationPrecision, string areaUnits)Parameters
| Type | Name | Description |
|---|---|---|
| ObservableCollection<SelectableItem> | surfaces | Collection of surfaces wrapped in SelectableItem objects. |
| string | alignment | Name of the reference alignment for outputing station range. |
| int | areaPrecision | Number of decimal places to include in the area output. |
| int | stationPrecision | Number of decimal places to include in the station range output. |
| string | areaUnits | Indicate "SF" for square feet or "SY" for square yards |
Returns
| Type | Description |
|---|---|
| List<object[]> | List of object arrays. Each array is a line that can be used in a report. |
ReportAlignDesc(string, int, int, int, int)
Creates alignment description report data for WisDOT specifications.
Declaration
public static List<List<string>> ReportAlignDesc(string aliNm, int staPrec, int distPrec, int coordPrec, int angPrec)Parameters
| Type | Name | Description |
|---|---|---|
| string | aliNm | Alignment name |
| int | staPrec | Number of decimal places to include in the station output. |
| int | distPrec | Number of decimal places to include in the distance output. |
| int | coordPrec | Number of decimal places to include in the coordinate output. |
| int | angPrec | Number of decimal places to include in the angle/bearing output. |
Returns
| Type | Description |
|---|---|
| List<List<string>> | List of string lists containing each line of the report. |
ReportAreas(ObjectIdCollection, string, int, int, string)
Builds a list of object arrays for downstream report creation. Each object array includes the station range, location (reference alignment), area, and layer
Declaration
public static List<object[]> ReportAreas(ObjectIdCollection objects, string aliName, int areaPrecision, int stationPrecision, string areaUnits)Parameters
| Type | Name | Description |
|---|---|---|
| ObjectIdCollection | objects | ObjectIdCollection of entities to include in the report. |
| string | aliName | Name of the reference alignment for outputing station range. |
| int | areaPrecision | Number of decimal places to include in the area output. |
| int | stationPrecision | Number of decimal places to include in the station range output. |
| string | areaUnits | Indicate "SF" for square feet or "SY" for square yards |
Returns
| Type | Description |
|---|---|
| List<object[]> | List of object arrays. Each array is a line that can be used in a report. |
ReportBlocks()
Returns a list of string arrays containing information about blocks in a drawing
Declaration
public static List<string[]> ReportBlocks()Returns
| Type | Description |
|---|---|
| List<string[]> | List of string arrays |
ReportCulverts(ObservableCollection<SelectableItem>, string)
Builds a list of string lists representing lines in a WisDOT culvert pipe report for QTO.
Declaration
public static List<List<string>> ReportCulverts(ObservableCollection<SelectableItem> networks, string payItemFile)Parameters
| Type | Name | Description |
|---|---|---|
| ObservableCollection<SelectableItem> | networks | Collection of Pipe Networks wrapped in SelectableItem objects. |
| string | payItemFile | File path to the pay item file. |
Returns
| Type | Description |
|---|---|
| List<List<string>> | List of string lists. Each string list is a line that can be used in a report. |
ReportLengths(ObjectIdCollection, string, int, int)
Builds a list of object arrays for downstream report creation. Each object array includes the station range, location (reference alignment), length (ft), and layer
Declaration
public static List<object[]> ReportLengths(ObjectIdCollection objects, string aliName, int lengthPrecision, int stationPrecision)Parameters
| Type | Name | Description |
|---|---|---|
| ObjectIdCollection | objects | ObjectIdCollection of entities that can be derived from the Curve class |
| string | aliName | Reference alignment |
| int | lengthPrecision | Precision of the reported lengths. Number of decimal places |
| int | stationPrecision | Precision of the reported stations. Number of decimal places |
Returns
| Type | Description |
|---|---|
| List<object[]> | List of object arrays. Each array is a line that can be used in a report. |
ReportPointstoSurfaceCompare(string, string, string)
Compares points from a point group or a point file to a surface.
Declaration
public static Dictionary<string, object> ReportPointstoSurfaceCompare(string surfaceName, string pointGroupName = "", string pointFileName = "")Parameters
| Type | Name | Description |
|---|---|---|
| string | surfaceName | Name of surface to compare with points. |
| string | pointGroupName | Point group name (Optional). |
| string | pointFileName | Path to point file name (Optional). Point file must be PENZD format of the file type: .txt, .wsi, or .csv. |
Returns
| Type | Description |
|---|---|
| Dictionary<string, object> | Dictionary with Keys: "surfaceName" = Surface Name, "sourceType" = source of points, "surfaceDescription" = surface description, "allPoints" = list of string lists containing data for all points, "onPoints" = list of string lists containing data for on surface points, "offPoints" = list of string lists containing data for off surface points String lists contain point number, point name, easting, northing, elevation, description code, description |
ReportSOE(ObjectId, double, double, int, List<SelectableItem>, List<double>, ObservableCollection<SelectableItem>?, int, int, int, int, bool, bool, SampleLineInfo, SampleLineInfo)
Declaration
public static List<List<string>> ReportSOE(ObjectId alignId, double startSta, double endSta, int staInc, List<SelectableItem> surfaces, List<double> offsets, ObservableCollection<SelectableItem>? entities, int coordPrec, int elevPrec, int staPrec, int osPrec, bool includeNE, bool useSampleLines, SampleLineInfo startSampleLine, SampleLineInfo endSampleLine)Parameters
| Type | Name | Description |
|---|---|---|
| ObjectId | alignId | ObjectId of the reference alignment. |
| double | startSta | Start raw station. |
| double | endSta | End raw station. |
| int | staInc | Frequency of station samples. |
| List<SelectableItem> | surfaces | List of surfaces to sample. |
| List<double> | offsets | List of offsets to sample. |
| ObservableCollection<SelectableItem> | entities | List of ObjectIds for entities used as sample locations. Enter empty List if not used. |
| int | coordPrec | Number of decimal places to include in the coordinate output. |
| int | elevPrec | Number of decimal places to include in the elevation output. |
| int | staPrec | Number of decimal places to include in the station output. |
| int | osPrec | Number of decimal places to include in the offset output. |
| bool | includeNE | Include the coordinate of each Station/offset location. |
| bool | useSampleLines | Use sample lines for station locations. |
| SampleLineInfo | startSampleLine | Start sample line. Enter ObjectId.Null if not used. |
| SampleLineInfo | endSampleLine | End sample line. Enter ObjectId.Null if not used. |
Returns
| Type | Description |
|---|---|
| List<List<string>> | List of string lists. Each string list is a line that can be used in a report. |
ReportSlopeStake(ObjectId, ObjectId, ObjectId, bool, double)
Builds a list of string lists representing lines in a WisDOT slope stake report.
Declaration
public static List<List<string>> ReportSlopeStake(ObjectId slStartId, ObjectId slEndId, ObjectId surfId, bool weed, double tol = 0)Parameters
| Type | Name | Description |
|---|---|---|
| ObjectId | slStartId | ObjectId of start sample line. |
| ObjectId | slEndId | ObjectId of end sample line |
| ObjectId | surfId | ObjectId of surface to report on. |
| bool | weed | Weed surface inflection points with slope changes less than the tolerance value. |
| double | tol | Tolerance value for weeding slope change. Units of ft/ft. |
Returns
| Type | Description |
|---|---|
| List<List<string>> | List of string lists. Each string list is a line that can be used in a report. |
ReportStormSewerPipes(ObservableCollection<SelectableItem>, string)
Builds a list of string lists representing lines in a WisDOT storm sewer pipe report for QTO.
Declaration
public static List<List<string>> ReportStormSewerPipes(ObservableCollection<SelectableItem> networks, string payItemFile)Parameters
| Type | Name | Description |
|---|---|---|
| ObservableCollection<SelectableItem> | networks | Collection of Pipe Networks wrapped in SelectableItem objects. |
| string | payItemFile | File path to the pay item file. |
Returns
| Type | Description |
|---|---|
| List<List<string>> | List of string lists. Each string list is a line that can be used in a report. |
ReportStormSewerStructures(ObservableCollection<SelectableItem>, double, string)
Builds a list of string lists representing lines in a WisDOT storm sewer structure report for QTO.
Declaration
public static List<List<string>> ReportStormSewerStructures(ObservableCollection<SelectableItem> networks, double ringHeight, string payItemFile)Parameters
| Type | Name | Description |
|---|---|---|
| ObservableCollection<SelectableItem> | networks | Collection of Pipe Networks wrappred in SelectableItem objects. |
| double | ringHeight | The anticipated adjustment ring height in inches. |
| string | payItemFile | File path to the pay item file. |
Returns
| Type | Description |
|---|---|
| List<List<string>> | List of string lists. Each string list is a line that can be used in a report. |
ReportSuperelevation(List<AlignmentInfo>)
Builds a dictionary where each key is an input alignment name. The value for each key is a List of string lists representing each line in the alignment superelevation report.
Declaration
public static Dictionary<string, List<List<string>>> ReportSuperelevation(List<AlignmentInfo> alignments)Parameters
| Type | Name | Description |
|---|---|---|
| List<AlignmentInfo> | alignments | List of alignment names to report superelevation for. |
Returns
| Type | Description |
|---|---|
| Dictionary<string, List<List<string>>> | Dictionary where each key is an input alignment name. Each key value is a string list containing lines of the report. |
StylesReport()
Report of all styles in the current drawing.
Declaration
public static List<string[]> StylesReport()Returns
| Type | Description |
|---|---|
| List<string[]> |