Configuration (.ini) File Setup

The .ini file is simply an ASCII file formatted as in the following example. All items beginning with RPT_ are the reporting fields. If set equal to one (1), that item is reported and if set equal to zero (0), that item is not reported. The position of the RPT_ items in the .ini file indicates the column position in the report. In the example below, plane will be reported in colume one, element name in colume two, and so on.

Example poly2dRpt.ini File

INPUT_PATH=D:\WORK\POLYRPT\_MSRESOURCES\MY_DIR
OUTPUT_RPT_PATH=polyRpt.csv
GET_ALL_2D_POLYGONS=1
GET_ALL_2D_POLYLINES=1
SUMMARY_BY_PLANE=1
SUMMARY_BY_RESOURCE_NAME=1
FILTER_BY_PLANE=1
PLANE_ORIENTATION=NonOrtho
NON_ORTHO_PLANE_AZIMUTH=20.0
NON_ORTHO_PLANE_DIP=15.0
PLANE_START=0.0
PLANE_END=100000.0
PLANE_INTERVAL=0.0
GRAND_SUMMARY=1
SPAWN_REPORT=1
SUPPRESS_TITLES=0
RPT_PLANE=1
RPT_ELEMENT_NAME=1
RPT_PLANE_ORIENTATION=1
RPT_FEATURE_TYPE=1
RPT_FEATURE_INVALID=1
RPT_DIRECTION_CCW=1
RPT_OPEN=1
RPT_SELF_INTERSECTING=1
RPT_RESOURCE_NAME=1
RPT_ELEMENT_MATERIAL=1
RPT_AREA=1
RPT_RESOURCE_MATERIAL=0
RPT_RESOURCE_VBM_CODE=0
RPT_RESOURCE_MODEL_CODE=0
RPT_ELEMENT_VBM_CODE=0
RPT_ELEMENT_MODEL_CODE=0
RPT_TOT_PTS=0
RPT_START_END_PTS=0
RPT_LENGTH=0
RPT_LENGTH_IN_PLAN=0

Configuration (.ini) File Items

INPUT_PATH=D:polyRpt_MSRESOURCESpolys.msr

String. The input path can be a directory path or an msr file path.

If it is a directory, all msr objects in that directory are processed (seached for polys). If it is an msr file path, only that msr is processed.

The value assigned to INPUT_PATH is not surrounded by quotes and is the absolute path to the object. The components in the path can be separated by double backslashes () or single front-slashes (/).

OUTPUT_RPT_PATH=polyRpt.csv

String. The output report file path can be an absolute path or just the file name, in which case it is written to the current or project directory. The report written to the output file is nomally comma delimited and as such the file name should end with .csv to be spawed by the default spawning program, usually Excel.

However, if using another extension, such as .txt is used, the report will be displayed by the associated application for .txt files, such as Notepad.

GET_ALL_2D_POLYGONS=1

Boolean. Set GET_ALL_2D_POLYGONS equal to 1 to report all the 2d polygons or set to 0 (zero) to ignore polygons.

GET_ALL_2D_POLYLINES=1

Boolean. Set GET_ALL_2D_POLYLINES equal to 1 to report all the 2d polylines or set to 0 (zero) to ignore polylines.

SUMMARY_BY_RESOURCE_NAME=1

Boolean. Writes an additional matrix below the detailed report with summaries for each resource object (msr) over all planes.

SUMMARY_BY_PLANE=0

Boolean. Set SUMMARY_BY_PLANE equal to 1 for report to summarize by plane. Set to zero if plane summary is not wanted.

If a plane summary is requested, the following config values must be properly valued:

PLANE_ORIENTATION=EW Section

String. Plane orientation can be set to:

EW Section (North) NS Section (East) Plan (Elev) NonOrtho

If 'NonOrtho' is specified, the following tokens must also be valued:

NON_ORTHO_PLANE_AZIMUTH=20.0 NON_ORTHO_PLANE_DIP=15.0

where azimuth is >= 0 and <= 360

dip is >= -90 and <= 90

PLANE_START=1000

Decimal number. Plane start must be less than plane end.

PLANE_END=2000

Decimal number. Plane end must be greater than plane start.

PLANE_INTERVAL=0

Decimal number. Plane interval must be valued if summarizing by plane.

Plane interval can be equal to zero to group by all natural planes in the objects.

FILTER_BY_PLANE=0

Boolean. Set FILTER_BY_PLANE=1 to only report polys satisfying requirements of PLANE_START, PLANE_END, PLANE_ORIENTATION.

If PLANE_ORIENTATION=NonOrtho, dip and azimuth must be valued.

PLANE_ORIENTATION=EW Section

String. Plane orientation can be:

EW Section, NS Section, Plan, NonOrtho,

or Any if filtering by plane. ('Any' may not be used if plane summary requested - see above)

If FILTER_BY_PLANE=1, then PLANE_ORIENTATION is used as a filter and only features with this orientation are included in the report. If PLANE_ORIENTATION=NonOrtho, azimuth and dip must be valued.

PLANE_START=1000

Decimal number. If SUMMARY_BY_PLANE or FILTER_BY_PLANE then PLANE_START is used as a filter and only features with plane values greater than PLANE_START are included in the report.

PLANE_END=2000

Decimal number. If SUMMARY_BY_PLANE or FILTER_BY_PLANE then PLANE_END is used as a filter and only features with plane values less than PLANE_END are included in the report.

PLANE_INTERVAL=0

Decimal number. Plane interval must be valued if summarizing by plane. Plane interval can be equal to zero to group by all natural planes in the objects.

GRAND_SUMMARY=1

Boolean. Set GRAND_SUMMARY equal to 1 to report a grand summary of all the features values as the last line of the report. Set to 0 (zero) to suppress the grand summary line.

SPAWN_REPORT=1

Boolean. Set SPAWN_REPORT equal to 1 if you want the application associated with report file extension, (usually .csv files are associated with Excel) to be spawned thus displaying the report.csv file after it is created by this script. Set to 0 (zero) to not spawn the report.

SUPPRESS_TITLES=0

Boolean. Set SUPPRESS_TITLES equal to 1 to suppress titles and headings on the report. This would be used in combination with not summarizing, not writing grand totals line, and not writing the msr resource summary section of the report. The output report can then be used as an input data file to another application.

RPT_ configuration values for selecting report fields:

All constants starting with RPT_ are set to boolean values to indicate what items to include in the report. Set to zero to not report or one to report.

All tokens need to be present in the ini file.

The order of these lines in the ini file reflects the order of the columns in the report. For example if the plane is wanted in col 1 of the csv report, put RPT_PLANE as the first item in the RPT_ lines.

Report items:

RPT_PLANE=1
RPT_PLANE_ORIENTATION=1
RPT_RESOURCE_NAME=1
RPT_RESOURCE_MATERIAL=1
RPT_RESOURCE_VBM_CODE=1
RPT_RESOURCE_MODEL_CODE=1
RPT_ELEMENT_NAME=1
RPT_ELEMENT_MATERIAL=1
RPT_ELEMENT_VBM_CODE=1
RPT_ELEMENT_MODEL_CODE=1
RPT_TOT_PTS=1
RPT_START_END_PTS=1
RPT_AREA=1
RPT_LENGTH_IN_PLAN=1
RPT_LENGTH=1
RPT_FEATURE_TYPE=1
RPT_FEATURE_INVALID=1
RPT_DIRECTION_CCW=1
RPT_OPEN=1
RPT_SELF_INTERSECTING=1