===========================
``grail.ip.equtils`` Module
===========================
.. include:: ../../version.h

.. contents:: Table of Contents
   :backlinks: top

--------
Overview
--------

This module provides a set of useful utility routines for equipment
reporting with MineSight® Interactive Planner.


---------
Functions
---------

:df:`gettruckcap(setup, eqset)`
  Given the equipment dictionary and an equipment set index, will return you the capacity.

:df:`gettruckeff(setup, eqset)`
  Given the equipment dictionary and an equipment set index, will return truck efficiency.

:df:`gettruckavail(setup, eqset)`
  Given the equipment dictionary and an equipment set index,will return truck availability.

:df:`getloadtime(setup, eqset)`
  Given the equipment dictionary and an equipment set index, will return load time.

:df:`getshovelcap(setup, eqset)`
  Given the equipment dictionary and an equipment set index, will return shovel capacity.

:df:`getshoveleff(setup, eqset)`
  Given the equipment dictionary and an equipment set index, will return shovel efficiency.

:df:`getshovelavail(setup, eqset)`
  Given the equipment dictionary and an equipment set index, will return shovel availability.

:df:`getudefinedbenchattr(setup)`
  Given the equipment dictionary, will return user defined bench attribute.

:df:`getudefinedpushbackattr(setup)`
  Given the equipment dictionary, will return user defined pushback attribute.

:df:`returnifkey(sdict, key)`
  Utility to check to see if a key is in a dictionary.  Arguments are the dictionary and the key to test.

:df:`getcycletimefilename(setup)`
  Given the equipment dictionary, returns the cycle time filename.

:df:`getcycletimefiletype(setup)`
  Given the equipment dictionary, will return type of cycle time file (not currently used).

:df:`getproductivityflag(setup)`
  Given the equipment dictionary, returns a 1 if using productivities.

:df:`getnumdest(setup)`
  Given the equipment dictionary, returns the number of destination records.

:df:`getdestrec(setup, idx)`
  Given the equipment dictionary and a destination record index, returns the destination record.

:df:`getnumtrucks(setup)`
  Given the equipment dictionary, returns the number of trucks.

:df:`gettruck(setup, idx)`
  Given the equipment dictionary and truck index, returns the truck.

:df:`getnumshovels(setup)`
  Given the equipment dictionary, returns the number of shovels.

:df:`getshovel(setup, idx)`
  Given the equipment dictionary and shovel index, returns the shovel.

:df:`getnumaux(setup)`
  Given the equipment dictionary, returns the number of auxiliary equipment.

:df:`getaux(setup, idx)`
  Given the equipment dictionary and the auxiliary equipment index, returns the auxiliary equipment.

:df:`getnumequipsets(setup)`
  Given the equipment dictionary, returns the number of equipment sets.

:df:`getequipsetbyidx(setup, idx)`
  Given the equipment dictionary and an equipment set index, returns the equipment set.

:df:`hasdefaultdest(setup)`
  Given the equipment dictionary, will return a 1 if there is a default destination.

:df:`hasoverrideattrib(setup)`
  Given the equipment dictionary, will return a 1 if there is an override attribute (not currently used).

:df:`getdefaultdest(setup)`
  Given the equipment dictionary, will return the default destination.

:df:`getoverrideattrib(setup)`
  Given the equipment dictionary, will return the override attribute (not currently used).

:df:`getequipset(dRes, setup, setname)`
  Given the reserves dictionary, equipment dictionary, and equipment set name, will return the equipment set.

:df:`store(dict)`
  Given the equipment dictionary, will store the data to a file (used internally).

:df:`storedict(fl, key, dict)`
  Given the file handle, key and dictionary, will store the dictionary to the file (used internally).

:df:`storelist(fl, key, list)`
  Given the file handle, key and list, will store the list to the file (used internally).

:df:`storepair(fl, key, elem)`
  Given the file handle, key and a value, will store the value to the file (used internally).

:df:`loadsetup(dRes, filename)`
  Given the reserves dictionary and a filename, will load and return a dictionary with the stored values (used internally).