Civil: Reference Data Guide
Civil: Reference Data Guide
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial use. The Other Documentation
may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and
for any reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, FrameWorks, I-Sketch, SmartMarine, IntelliShip, ISOGEN, SmartSketch,
SPOOLGEN, SupportManager, SupportModeler, Sapphire, and Intergraph Smart are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Hexagon and the Hexagon logo are registered
trademarks of Hexagon AB or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. ACIS is a
registered trademark of SPATIAL TECHNOLOGY, INC. Infragistics, Presentation Layer Framework, ActiveTreeView Ctrl,
ProtoViewCtl, ActiveThreed Ctrl, ActiveListBar Ctrl, ActiveSplitter, ActiveToolbars Ctrl, ActiveToolbars Plus Ctrl, and ProtoView are
trademarks of Infragistics, Inc. Incorporates portions of 2D DCM, 3D DCM, and HLM by Siemens Product Lifecycle Management
Software III (GB) Ltd. All rights reserved. Gigasoft is a registered trademark, and ProEssentials a trademark of Gigasoft, Inc.
VideoSoft and VXFlexGrid are either registered trademarks or trademarks of ComponentOne LLC 1991-2013, All rights reserved.
Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation and/or its affiliates. Tribon is a
trademark of AVEVA Group plc. Alma and act/cut are trademarks of the Alma company. Other brands and product names are
trademarks of their respective owners.
Index ........................................................................................................................................................... 22
Documentation Comments
For the latest support information for this product, comments or suggestions about this
documentation, and documentation updates for supported software versions, please visit
Intergraph Smart Support (https://smartsupport.intergraph.com).
Common Workbook
The AllCommon.xls workbook defines standard catalog properties and attributes, such as
allowable materials, wall thicknesses, pipe stock, and outfitting cross section mounting faces
and load points. The workbook is delivered to the [Product
Folder]\CatalogData\BulkLoad\DataFiles folder and is bulkloaded into the catalog.
The Civil task uses allowable materials defined on the Material worksheet. For more
information, see Material Sheet in the Reference Data Guide.
Definition Section
Defines attributes that apply to the entire cross section type.
PartClassType - Class type CrossSectionClass as defined on the PartClassTypes sheet of the
AllCodeLists.xls file. Do not modify this property.
SymbolDefinition - 2D symbol file associated with the cross-section type. 2D symbol files are
delivered to the [Reference Data Folder]\SharedContent folder. For more information, see Civil
Symbols (on page 13).
SymbolIcon - Specifies a graphic file for the part class. You can view this graphic in the Catalog
task or on the Properties dialog box in the Civil task in the software.
UserClassName - Cross section type defined internally by the software and displayed in the
Catalog task browser in the software.
ReferenceStandard - Standards organization or shape library for the cross section type, as
defined on the ReferenceStandard worksheet.
oa:[parameter name] - Occurrence attribute that places the named catalog attribute on the
Trench Run Properties dialog box in the Civil task. Each parameter also appears in the Head
section and corresponding to a parameter in the 2D symbol file defined by SymbolDefinition.
You must map symbol parameters to the following interface and attribute
names:
IJTrenchCrossSectionWidthEx InsideWidth
IStructCrossSectionDimensions Depth
Width
Head Section
Defines properties for individual cross-section sizes.
SectionName - Name of the trench or ditch cross-section size as it appears in the Catalog task.
The name must be unique.
ShortName - The short name for the cross-section.
EDIName - The Electronic Data Interchange name for the cross-section. This property is
currently not used by the software.
[cross-section properties] - Properties that defines the cross-section of the trench. These
properties are in the format InterfaceName:AttributeName, as defined on the CustomInterfaces
sheet of the workbook.
When defined as an occurrence attribute in the definition section, the cross-section
properties defined in the corresponding trench cross-section symbol appear on the Trench Run
Properties dialog box in the Civil task.
Definition Section
Defines attributes that apply to the entire trench class.
PartClassType - Class type as defined on the PartClassTypes sheet of the AllCodeLists.xls
file. For more information, see Code List Workbook (on page 7).
UserClassName - Trench type defined internally by the software and displayed in the Catalog
task browser in the software.
Trench Composition Worksheet (on page 9)
Trench Type Worksheets (on page 11)
Trench Turn Part Worksheet (on page 12)
Head Section
Defines properties for individual sections of a trench type. Each section is defined as a contour
in the symbol file.
Name
The name of the trench contour as the contour appears in the Catalog task. The name must
be unique.
TrenchName
The name of the trench, as defined within a trench type worksheet. For more information,
see Trench Type Worksheets (on page 11).
GroupName
The name of the contour in the symbol file, such as LeftWall, RightWall, or Footing.
GroupType
The contour type. Type 1 for trench wall, 2 for trench slab, 3 for trench footing, or 4 for
trench other. 4 is only used to construct a single lump cross-section.
ThicknessProjection
The vertical thickness projection of the trench slab or footing contour with respect to the
slope of the path.
DefaultMaterial
The material used for the GroupName, as defined in the AllCommon.xls workbook. Each
contour can use a different material. For more information, see Common Workbook (on
page 7).
DefaultMaterialGrade
The material grade used for the GroupName, as defined in the AllCommon.xls workbook.
Each contour can use a different material grade. For more information, see Common
Workbook (on page 7).
Description
A description of the trench material composition.
Each trench type has one cross-section PartClass with a set of GroupName values for the
contours of the symbol file.
You can associate different materials to the trench wall, footing, and slab components.
Follow the steps listed below:
1. First, create a separate contour for each component.
2. Next, provide a group name for each contour.
3. Label each edge of the contour as shown below:
1 - Top
2 - Bottom
3 - Web_Left
4 - Web_Right
4. Then, merge all groups into a single group under the Simple Physical representation of
the symbol.
5. Finally, use the GroupType settings to associate each group to a group type: Leftwall,
Rightwall, Footing, or Slab.
For more information about symbol naming conventions and symbol representations, see
Symbol 2D User's Guide.
Head Section
Defines properties for individual trenches within a trench type.
Name - The name of the trench as it appears in the Catalog task. The name must be unique.
Description - A description of the trench.
Type - The trench type. Type 1 for drainage ditch, 2 for pipe trench, or 3 for cable trench.
SectionClass - The name of the trench cross-section, as defined in
Trench_CrossSections.xls. For more information, see Trench Cross-Sections Workbook (on
page 7).
MinBottomSurfaceSlope - This option is not currently supported by the software.
TrenchTurnPartRule - The rule used for a turn with the trench, as defined in the
TrenchTurnPart worksheet. For more information, see Trench Turn Part Worksheet (on page
12).
CustomProgram - The name of a custom program used to create a solid for the trench, in the
format DLLName.ProgID.
Head Section
Defines properties for individual turn features. Each section is defined as a contour in the
symbol file.
Name - The name of the turn feature as the feature appears in the Catalog task. The name must
be unique.
Description - A description of the turn feature.
1 - Outside Chamfer Y
2 - Outside Chamfer X
3 - Path Direction
4 - Projection Y
5 - Projection X
6 - Inside Chamfer Y
7 - Inside Chamfer X
8 - Included Angle
ProjectionX - The inside length of the turn feature along the local X axis of the trench path.
ProjectionY - The inside length of the turn feature along the local Y axis of the trench path.
AngleMin - The minimum included angle of the chamfer.
AngleMax - The maximum included angle of the chamfer.
InsideChamfer - The presence of an inside chamfer. Type 1 to create an inside chamfer. Type
0 if no inside chamfer exists.
InsideChamferX - The local X-component of the length of the inside chamfer along the path of
the turn.
InsideChamferY - The local Y-component of the length of the inside chamfer along the path of
the turn.
OutsideChamfer - The presence of an outside chamfer. Type 1 to create an outside chamfer.
Type 0 if no outside chamfer exists.
OutsideChamferX - The local X-component of the length of the outside chamfer along the path
of the turn.
OutsideChamferY - The local Y-component of the length of the outside chamfer along the path
of the turn.
Civil Symbols
Civil symbols provide the geometric representations of Civil objects placed in the model. You
can modify the geometry and parameters of the symbols. The symbols are delivered as 2D
symbol files for trenches and ditches.
Symbol icon bitmap files are also delivered for graphical previews that appear in the Catalog
task and in properties dialog boxes.
You can use any shape consisting of four straight lines forming a closed contour as
the symbol.
The symbols and symbol icons are delivered to [Reference Data
Folder]\SharedContent\CrossSections. The symbols are also bulkloaded into the catalog. For
more information, see Trench Cross-Sections Workbook (on page 7).
You can associate different materials to the trench wall, footing, and slab components.
Follow the steps listed below:
1. First, create a separate contour for each component.
2. Next, provide a group name for each contour.
3. Label each edge of the contour as shown below:
1 - Top
2 - Bottom
3 - Web_Left
4 - Web_Right
4. Then, merge all groups into a single group under the Simple Physical representation of
the symbol.
5. Finally, use the GroupType settings to associate each group to a group type: Leftwall,
Rightwall, Footing, or Slab.
For more information about symbol naming conventions and symbol representations, see
Symbol 2D User's Guide.
Symbol Requirement
Each civil symbol cross-section must have a representation named DrivenDimensions in the
respective 2D symbol file of the cross-section containing Width, Depth, and InsideDepth
parameters. The example defines the DrivenDimensions for a U_Shape trench cross-section.
1. Define the three new dimensions using the Place a Dimension Between Two
Elements or Key Points from the Distance Between command. For more information,
see Symbol 2D User's Guide. You can select the points or the lines. The new
dimensions are shown in red in the graphic below.
2. Name the new dimensions with respect to their attribute names in the catalog. For more
information, see Trench Cross-Sections Workbook (on page 7).
Width:
Depth:
InsideWidth:
Trench Symbol U
The U_Shape trench cross-section symbol defines a trench with vertical walls and uses the
following parameters:
InsideLeftWidth - Distance from the center cardinal point to the extreme left cardinal points.
InsideRightWidth - Distance from the center cardinal point to the extreme right cardinal points.
FootingThk - Footing thickness of the trench.
InsideDepth - Inside depth of the trench.
WallThk - Wall thickness of the trench.
InsideLeftWidth - Distance from the center cardinal point to the extreme left cardinal points.
InsideRightWidth - Distance from the center cardinal point to the extreme right cardinal points.
FootingThk - Footing thickness of the trench.
Inside Depth - Inside depth of the trench.
WallThk - Wall thickness of the trench.
FootingProj - Footing projection.
InsideLeftWidth - Distance from the center cardinal point to the extreme left cardinal points.
InsideRightWidth - Distance from the center cardinal point to the extreme right cardinal points.
FootingThk - Footing thickness of the trench.
InsideDepth - Inside depth of the trench.
WallThk - Wall thickness of the trench.
FootingThk - Width of each footing.
Trench Symbol V
The V_Shape trench cross-section symbol defines a trench with sloping walls and common
footing bounded by the outer edge of walls. The symbol uses the following parameters:
InsideLeftWidth - Distance from the center cardinal point to the extreme left cardinal points.
InsideRightWidth - Distance from the center cardinal point to the extreme right cardinal points.
FootingThk - Footing thickness of the trench.
InsideDepth - Inside depth of the trench.
WallThk - Wall thickness of the trench.
InsideAngle - Slope of the walls with respect to the horizontal line.
InsideLeftWidth - Distance from the center cardinal point to the extreme left cardinal points.
InsideRightWidth - Distance from the center cardinal point to the extreme right cardinal points.
FootingThk - Footing thickness of the trench.
InsideDepth - Inside depth of the trench.
WallThk - Wall thickness of the trench.
SlabThk - Slab thickness of the trench.
B
Bulkload Files and the Civil Catalog • 7
C
Civil Reference Data Overview • 6
Civil Symbols • 13
Code List Workbook • 7
Common Workbook • 7
P
Preface • 5
T
Trench Composition Worksheet • 9
Trench Cross-Sections Workbook • 7
Trench General Composition Workbook • 9
Trench Symbol 2W1F • 19
Trench Symbol 2W2F • 20
Trench Symbol Box • 21
Trench Symbol U • 19
Trench Symbol V • 20
Trench Turn Part Worksheet • 12
Trench Type Worksheets • 11
W
What's New in Civil Reference Data • 5