Vulcan : Dragline : Appendix A : Macro Functions

Command

Description

Syntax

$block = Dragline::new_block($strip,$horizon,$history)

Retrieves a block object with the specified strip number, horizon number, and operation history.

$block - Returned block object.
$strip - Strip number of the block.
$horizon - Horizon of the block.
$history - Operation history of the block.

$Block = Dragline::new_imported_block()

Obtains a block object and flags it as an imported block. The returned block carries no information except that it is imported from somewhere. When it gets used in an operation, you will be asked to specify which of the currently available imported blocks is to be used.

$block - Returned block object.

$template= Dragline::new_template($name,$control_index)

Obtains a template object with the specified name. A vertex is assigned to the template as the vertex to be used for positioning it during an operation.

$template - Retuned template object.
$name - Name of the template.
$control_index - Zero based integer index of the template vertex to use for positioning purposes.

$position = Dragline::new_position($name)

Obtains a named position object of the specified name. Valid names would include in the names of the dragline extents (INNER_LEFT_SETBACK, CENTER etc) and the names of any dragline named point objects (P_* or PNT_*).

Older datasets may contain named points with a PNT_ prefix. These are also supported.

$position - Returned position object
$name - Name of the position

$position = Dragline::new_insitu_position($strip,$horizon,$highwall,$point)

Obtains an named position corresponding to a dragline P_* or PNT_* object. The particular dragline point object retrieved is determined by the specified parameters

$position - Returned position object
$strip - Strip number
$horizon - Horizon number $highwall - "current" or "next" $point - "toe" or "crest"

$result = Dragline::get_section(\$section)

Displays a panel asking you to enter a section number. The section number chosen will be assigned to $section. A backslash must be placed before the parameter.

$result - Returns true if successful.
$section - Returned section number.

$result = Dragline::get_section_and_strip(\$section,\$strip)

Displays a panel asking you to enter a section and strip number. These will be assigned to $section and $strip respectively. Backslashes must be placed before both parameters.

$result - Returns true if successful.
$section - Returned section number.
$strip - Returned strip number

$result =Dragline::dragline_lt($section,$block,$rehandle, $equipment,$swell,$position)

Performs a dragline left toe operation. The $block and $position parameters must be objects created by the new_block and new_position functions respectively

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false"
$equipment - Name of equipment to use.
$swell - Swell factor for post operation block.
$position - Position of the left toe.

$result =Dragline::dragline_centre($section,$block,$rehandle, $equipment,$swell,$position)

Performs a dragline centre operation. The $block and $position parameters must be objects created by the new_block and new_position functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false"
$equipment - Name of equipment to use.
$swell - Swell factor for post operation block.
$position - Position of the dump peak.

$result =Dragline::dragline_rt($section,$block,$rehandle, $equipment,$swell,$position)

Performs a dragline right toe operation. The $block and $position parameters must be objects created by the new_block and new_position functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false"
$equipment - Name of equipment to use.
$swell - Swell factor for post operation block.
$position - Position of the right toe.

$result =Dragline::bulldoze_right($section,$block,$rehandle, $equipment,$swell,$position)

Performs a bulldoze right operation. The $block and $position parameters must be objects created by the new_block and new_position functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false"
$equipment - Name of equipment to use.
$swell - Swell factor for post operation block.
$position - RL of bulldozed block.

$result =Dragline::bulldoze_left($section,$block,$rehandle, $equipment,$swell,$position)

Performs a bulldoze left operation. The $block and $position parameters must be objects created by the new_block and new_position functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false"
$equipment - Name of equipment to use.
$swell - Swell factor for post operation block.
$position - RL of bulldozed block.

$result =Dragline::area_balance_whole($section,$block,$rehandle, $equipment,$swell,$template,$position,$dx,$dy)

Performs an area balance by whole profile. The $block, $position, and $template parameters must be objects created by the new_block, new_position, and new_template functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false".
$equipment - Name of equipment to use.
$swell - Swell factor for post operation block.
$template - Template to use for new block profile
$position - Position at which to place the template control point.
$dx,$dy - Area balance direction vector.

$result =Dragline::area_balance_part($section,$block,$rehandle,$equipment,$swell, $template,$position,$b_index,$b_side)

Performs an area balance by partial profile. The $block, $position, and $template parameters must be objects created by the new_block, new_position, and new_template functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false".
$equipment - Name of equipment to use.
$swell - Swell factor for post operation block.
$template - Template to use for new block profile
$position - Position at which to place the template control point.
$b_index - Zero based index of the template point to use for balance.
$b_side - Side of $b_index to balance. "left" or "right".

$result =Dragline::area_reshape($section,$block,$rehandle, $equipment,$template,$position)

Performs an area reshape operation. The $block, $position, and $template parameters must be objects created by the new_block, new_position, and new_template functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false".
$equipment - Name of equipment to use.
$template - Template to use for new block profile
$position - Position at which to place the template control point.

$result =Dragline::area_cutfill($section,$block,$rehandle, $equipment,$swell, $template,$position,$c_angle,$f_angle,$outcome)

Performs an area cut and fill operation. If the outcome does not match $outcome, a warning message is posted. The $block, $position, and $template parameters must be objects created by the new_block, new_position, and new_template functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$rehandle - Calculate rehandle? "true" or "false".
$equipment - Name of equipment to use.
$swell - Swell factor for post operation block.
$template - Template to use for new block profile
$position - Position at which to place the template control point.
$c_angle - Cut angle.
$f_angle - Fill angle.
$outcome - Expected outcome. Either "undercut", "underfilled", or "equal".

$result=Dragline::split_block_2point($section,$block,$pos1,$pos2)

Performs a two point split operation. The $block parameter must be an object created by the new_block function.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$pos1 - Position of first point.
$pos2 - Position of second point.

$result=Dragline::split_block_elevation($section,$block,$position)

Performs a split by elevation. The $block parameter must be an object created by the new_block function.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$position - Elevation of split.

$result=Dragline::split_block_angle($section,$block,$position,$angle)

Performs a split by angle. The $block parameter must be an object created by the new_block function.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$position - Position to begin split from.
$angle - Angle of split.

$result=Dragline::split_block_template($section,$block,$template,$position)

Performs a split by template. The $block and $template parameters must be objects created by the new_block and new_template functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$block - Block to perform this operation on.
$template - Template to use for split.
$position - Position at which to place the template control point.

$result=Dragline::merge_blocks($section,$blocks,$label,$colour,$line,$pattern)

Merge block operation. Build an array of block objects and pass a reference to it by placing a backslash in front. The blocks in the array will be merged together.

$result - Returns true if successful.
$section - Section to perform this operation in.
$blocks - Reference to array of blocks to be merged.
$label - Text label to be used for the merged block.
$colour - Colour to apply to the merged block.
$line - Line style to apply to the merged block.
$pattern - Fill pattern to apply to the merged block.

$result=Dragline::create_block($section,$strip,$horizon,$equipment,$template,$position)

Creates a new block in the given strip, horizon and section. The $template and $position parameters must be objects created by the new_template and new_position functions respectively.

$result - Returns true if successful.
$section - Section to perform this operation in.
$strip - Create new block in this strip.
$horizon - Create new block in this horizon.
$equipment - Equipment item to assign to block.
$template - Template to use for the new block profile.
$position - Position at which to place the template control point.

$result=Dragline::remove_block($section,$block,$equipment)

Removes a block from a section. The $block parameter must be created using the new_block function.

$result - Returns true if successful.
$section - Section to remove block from.
$block - Block to remove.
$equipment - Equipment to use for removal.

$result=Dragline::export_block($section)

Exports a block from the given section. You will be asked to select the block to be exported.

$result - Returns true if successful.
$section - Section to export from.

$result=Dragline::nullify_block($section,$block)

Nullifies a block. The $block parameter must be an object created by the new_block function.

$result - Returns true if successful.
$section - Section to perform operation in.
$block - Block to nullify.

$result=Dragline::select_dragline($section,$dragline_name)

Sets the given dragline as the current one for the specified section.

$result - Returns true if successful.
$section - Section to select dragline for.
$dragline_name - Dragline to select.

$result=Dragline::DRE_snap_outer_right_extent($section,$position)

Moves the position of the current dragline of a given section such that it's outer right extent is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the outer right extent.

$result=Dragline::DRE_snap_inner_right_extent($section,$position)

Moves the position of the current dragline of a given section such that it's inner right extent is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the inner right extent.

$result=Dragline::DRE_snap_outer_right_setback($section,$position)

Moves the position of the current dragline of a given section such that it's outer right setback is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the outer right setback.

$result=Dragline::DRE_snap_inner_right_setback($section,$position)

Moves the position of the current dragline of a given section such that it's inner right setback is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the inner right setback.

$result=Dragline::DRE_snap_centre ($section,$position)

Moves the position of the current dragline of a given section such that it's centre is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the dragline centre.

$result=Dragline::DRE_snap_inner_left_setback($section,$position)

Moves the position of the current dragline of a given section such that it's inner left setback is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the inner left setback.

$result=Dragline::DRE_snap_outer_left_setback($section,$position)

Moves the position of the current dragline of a given section such that it's outer left setback is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the outer left setback.

$result=Dragline::DRE_snap_inner_left_extent($section,$position)

Moves the position of the current dragline of a given section such that it's inner left extent is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the inner left extent.

$result=Dragline::DRE_snap_outer_left_extent($section,$position)

Moves the position of the current dragline of a given section such that it's outer left extent is located at the position indicated by $position. The $position parameter must be an object created by the new_position or new_insitu_position functions.

$result - Returns true if successful.
$section - Section to perform operation in.
$position - Position for the outer left extent.

$result=Dragline::DRE_drag_position($section)

You will be asked to set the position of the current dragline by manually dragging it into place.

$result - Returns true if successful.
$section - Section to perform operation in.

$result=Dragline::DRE_translate_position($section,$dx,$dy)

Moves the location of the current dragline of a given section by translating it by $dx,$dy.

$result - Returns true if successful.
$section - Section to perform operation in.
$dx,$dy - Translation vectors.

$result=Dragline::DRE_unset_position($section)

Removes the current dragline from the given section.

$result - Returns true if successful.
$section - Section to perform this operation in.