class SpillUnit (AIsisUnit):
"""Concrete implementation of AIsisUnit storing Isis Spill Unit data.
Contains a reference to a rowdatacollection for storing and
accessing all the row data. i.e. the geometry data for the section,
containing the chainage, elevation, etc values.
Methods for accessing the data in these objects and adding removing rows
are available.
See Also:
AIsisUnit
"""
# Name constants the values dictionary
CHAINAGE = 'chainage'
ELEVATION = 'elevation'
EASTING = 'easting'
NORTHING = 'northing'
UNIT_TYPE = 'Spill'
CATEGORY = 'Spill'
FILE_KEY = 'SPILL'
def __init__(self, file_order):
"""Constructor.
Args:
fileOrder (int): The location of this unit in the file.
"""
AIsisUnit.__init__(self, file_order)
# Fill in the header values these contain the data at the top of the
# section, such as the unit name and labels.
self.head_data = {'section_label': '', 'spill_ds': '', 'coeff': 0,
'modular_limit': 0, 'comment': '', 'rowcount': 0}
self.unit_type = SpillUnit.UNIT_TYPE
self.unit_category = SpillUnit.CATEGORY
self.has_datarows = True
self.unit_length = 0
def readUnitData(self, unit_data, file_line):
"""Reads the unit data into the geometry objects.
Args:
unit_data (list): The part of the isis dat file pertaining to
this section
See Also:
AIsisUnit - readUnitData()
"""
file_line = self._readHeadData(unit_data, file_line)
self.name = self.head_data['section_label']
file_line = self._readRowData(unit_data, file_line)
self.head_data['rowcount'] = self.row_collection.getNumberOfRows()
return file_line - 1
def _readHeadData(self, unit_data, file_line):
"""Reads the data in the file header section into the class.
Args:
unit_data (list): contains data for this unit.
"""
self.head_data['comment'] = unit_data[file_line][5:].strip()
self.name = self.head_data['section_label'] = unit_data[file_line + 1][:12].strip()
self.head_data['spill_ds'] = unit_data[file_line + 1][12:24].strip()
self.head_data['coeff'] = unit_data[file_line + 2][:10].strip()
self.head_data['modular_limit'] = unit_data[file_line + 2][10:20].strip()
self.unit_length = int(unit_data[file_line + 3].strip())
return file_line + 4
def _readRowData(self, unit_data, file_line):
"""Reads the units rows into the row collection.
This is all the geometry data that occurs after the no of rows variable in
the Spill Units of the dat file.
Args:
unit_data: the data pertaining to this unit.
"""
# Add the new row data types to the object collection
# All of them must have type, output format, default value and position
# in the row as the first variables in vars.
# The others are DataType specific.
self.row_collection = RowDataCollection()
self.row_collection.initCollection(do.FloatData(0, rdt.CHAINAGE, format_str='{:>10}', no_of_dps=3))
self.row_collection.initCollection(do.FloatData(1, rdt.ELEVATION, format_str='{:>10}', no_of_dps=3))
self.row_collection.initCollection(do.FloatData(2, rdt.EASTING, format_str='{:>10}', no_of_dps=2, default=0.0))
self.row_collection.initCollection(do.FloatData(3, rdt.NORTHING, format_str='{:>10}', no_of_dps=2, default=0.0))
out_line = file_line + self.unit_length
try:
# Load the geometry data
for i in range(file_line, out_line):
# Put the values into the respective data objects
# This is done based on the column widths set in the Dat file
# for the spill section.
self.row_collection.addValue(rdt.CHAINAGE, unit_data[i][0:10].strip())
self.row_collection.addValue(rdt.ELEVATION, unit_data[i][10:20].strip())
# In some edge cases there are no values set in the file for the
# easting and northing, so use defaults.
if not len(unit_data[i]) > 21:
self.row_collection.addValue(rdt.EASTING)
self.row_collection.addValue(rdt.NORTHING)
else:
self.row_collection.addValue(rdt.EASTING, unit_data[i][20:30].strip())
self.row_collection.addValue(rdt.NORTHING, unit_data[i][30:40].strip())
except NotImplementedError:
logger.ERROR('Unable to read Unit Data(dataRowObject creation) - NotImplementedError')
raise
return out_line
def getData(self):
"""Retrieve the data in this unit.
The String[] returned is formatted for printing in the fashion
of the .dat file.
Returns:
list of output data formated the same as in the .DAT file.
"""
out_data = self._getHeadData()
out_data.extend(self._getRowData())
return out_data
def _getRowData(self):
"""Get the data in the row collection.
For all the rows in the spill geometry section get the data from
the rowdatacollection class.
Returns:
list containing the formatted unit rows.
"""
out_data = []
for i in range(0, self.row_collection.getNumberOfRows()):
out_data.append(self.row_collection.getPrintableRow(i))
return out_data
def _getHeadData(self):
"""Get the header data formatted for printing out.
Returns:
list - contining the formatted head data.
"""
out_data = []
self.head_data['rowcount'] = self.unit_length
out_data.append('SPILL ' + self.head_data['comment'])
# Get the row with the section name and spill info from the formatter
out_data.append('{:<12}'.format(self.head_data['section_label']) +
'{:<12}'.format(self.head_data['spill_ds'])
)
out_data.append('{:>10}'.format(self.head_data['coeff']) +
'{:>10}'.format(self.head_data['modular_limit'])
)
out_data.append('{:>10}'.format(self.head_data['rowcount']))
return out_data
def addDataRow(self, chainage, elevation, index=None, easting = 0.00,
northing = 0.00):
"""Adds a new row to the bridge unit.
Ensures that certain requirements of the data rows, such as the
chainage needing to increase for each row down are met, then call the
addNewRow() method in the row_collection.
Args:
chainage (float): chainage value. Must not be less than the
previous chaninage in the collection.
elevation (float): elevation in datum.
index (int): stating the position to insert the new row - Optional.
If no value is given it will be appended to the end of the
data_object
The other values are all optional and will be set to defaults if
not given.
Returns:
False if the addNewRow() method is unsuccessful.
Raises:
IndexError: If the index does not exist.
ValueError: If the given value is not accepted by the DataObjects.
See Also:
ADataObject and subclasses for information on the parameters.
"""
# If it greater than the record length then raise an index error
if index > self.row_collection.getNumberOfRows():
raise IndexError ('Given index out of bounds of row_collection')
# If it's the same as the record length then we can set index to None
# type and it will be appended instead of inserted.
if index == self.row_collection.getNumberOfRows():
index = None
# Check that there won't be a negative change in chainage across row.
if self._checkChainageIncreaseNotNegative(index, chainage) == False:
raise ValueError ('Chainage increase cannot be negative')
# Call the row collection add row method to add the new row.
self.row_collection.addNewRow(values_dict={'chainage': chainage,
'elevation': elevation, 'easting': easting,
'northing': northing}, index=index)
def _checkChainageIncreaseNotNegative(self, index, chainageValue):
"""Checks that new chainage value is not not higher than the next one.
If the given chainage value for the given index is higher than the
value in the following row ISIS will give a negative chainage error.
It will return true if the value is the last in the row.
Args:
index (int): The index that the value is to be added at.
chainageValue (float): The chainage value to be added.
Returns:
False if greater or True if less.
"""
if index == None:
return True
if not index == 0:
if self.row_collection.getDataValue('chainage', index - 1) >= chainageValue:
return False
if self.row_collection.getDataValue('chainage', index) <= chainageValue:
return False
return True
class BridgeUnit(AIsisUnit):
"""Subclass of AIsisUnit storing Isis Bridge Unit data.
Note:
This really an abstract class for any bridge unit and is not really
intended to be used directly.
Contains a reference to a rowdatacollection for storing and
accessing all the row data. i.e. the geometry data for the section,
containing the chainage, elevation, roughness, etc values.
Methods for accessing the data in these objects and adding removing rows
are available.
"""
UNIT_TYPE = 'Bridge'
CATEGORY = 'Bridge'
UNIT_VARS = None
def __init__(self, file_order):
"""Constructor.
Args:
fileOrder (int): The location of this unit in the file.
"""
AIsisUnit.__init__(self, file_order)
# Fill in the header values these contain the data at the top of the
# section, such as the unit name and labels.
self.head_data = {
'upstream': '',
'downstream': '',
'remote_us': '',
'remote_ds': '',
'roughness_type': 'MANNING',
'calibration_coef': 1,
'skew_angle': 1,
'width': 0,
'dual_distance': 0,
'no_of_orifices': 0,
'orifice_flag': '',
'op_lower': 0,
'op_upper': 0,
'op_cd': 0,
'comment': '',
'rowcount': 0,
'row_count_additional': {
'Opening': 1
}
}
self.unit_type = BridgeUnit.UNIT_TYPE
self.unit_category = BridgeUnit.CATEGORY
self.has_datarows = True
self.no_of_collections = 2
self.unit_length = 0
self.no_of_chainage_rows = 1
self.no_of_opening_rows = 1
self.no_of_culvert_rows = 0
self.additional_row_collections = OrderedDict()
def getNumberOfOpenings(self):
"""
"""
return self.no_of_opening_rows
def getArea(self):
"""Returns the cross sectional area of the bridge openings.
Return:
Dict - containing the area of the opening(s). keys = 'total', then
'1', '2', 'n' for all openings found.
"""
return 0
# areas = []
# opening_data = self.additional_row_collections['Opening']
# x_vals = self.row_collection.getRowDataAsList(rdt.CHAINAGE)
# y_vals = self.row_collection.getRowDataAsList(rdt.ELEVATION)
#
# start_vals = opening_data.getRowDataAsList(rdt.OPEN_START)
# end_vals = opening_data.getRowDataAsList(rdt.OPEN_END)
# soffit_vals = opening_data.getRowDataAsList(rdt.SOFFIT_LEVEL)
# springing_vals = opening_data.getRowDataAsList(rdt.SPRINGING_LEVEL)
# openings = zip(start_vals, end_vals, soffit_vals, springing_vals)
#
# for i, x in enumerate(x_vals):
#
# if math.fabs(x - )
#
#
# i=0
def readUnitData(self, unit_data, file_line):
"""Reads the unit data into the geometry objects.
See Also:
AIsisUnit
Args:
unit_data (list): The section of the isis dat file pertaining to
this section.
"""
file_line = self._readHeadData(unit_data, file_line)
self.name = self.head_data['upstream']
file_line = self._readMainRowData(unit_data, file_line)
file_line = self._readAdditionalRowData(unit_data, file_line)
self.head_data['rowcount'] = self.row_collection.getNumberOfRows()
for key, data in self.additional_row_collections.iteritems():
self.head_data['row_count_additional'][key] = data.getNumberOfRows(
)
return file_line
def _readHeadData(self, unit_data, file_line):
"""Format the header data for writing to file.
Note:
Must be implemented by subclass
Raises:
NotImplementedError: if not overriden by sub class.
"""
raise NotImplementedError
def _readMainRowData(self, unit_data, file_line):
"""Reads the units rows into the row collection.
This is all the geometry data that occurs after the no of rows variable in
the Bridge Units of the dat file.
Args:
unit_data (list): the data pertaining to this unit.
"""
# Add the new row data types to the object collection
# All of them must have type, output format, default value and position
# in the row as the first variables in vars.
# The others are DataType specific.
self.row_collection = RowDataCollection()
self.row_collection.initCollection(
do.FloatData(0, rdt.CHAINAGE, format_str='{:>10}', no_of_dps=3))
self.row_collection.initCollection(
do.FloatData(1, rdt.ELEVATION, format_str='{:>10}', no_of_dps=3))
self.row_collection.initCollection(
do.FloatData(2,
rdt.ROUGHNESS,
format_str='{:>10}',
no_of_dps=3,
default=0.0))
self.row_collection.initCollection(
do.ConstantData(3,
rdt.EMBANKMENT, ('L', 'R'),
format_str='{:>11}',
default=''))
self.unit_length = 6
out_line = file_line + self.no_of_chainage_rows
try:
# Load the geometry data
for i in range(file_line, out_line):
# Put the values into the respective data objects
# This is done based on the column widths set in the Dat file
# for the river section.
self.row_collection.addValue(rdt.CHAINAGE,
unit_data[i][0:10].strip())
self.row_collection.addValue(rdt.ELEVATION,
unit_data[i][10:20].strip())
self.row_collection.addValue(rdt.ROUGHNESS,
unit_data[i][20:30].strip())
# Might not exist
try:
bank = unit_data[i][40:51].strip()
except:
bank = ''
self.row_collection.addValue(rdt.EMBANKMENT, bank)
except NotImplementedError:
logger.error(
'Unable to read Unit Data(dataRowObject creation) - NotImplementedError'
)
raise
self.no_of_opening_rows = int(unit_data[out_line].strip())
self.unit_length += self.no_of_chainage_rows + 1
return out_line + 1
def getData(self):
"""Retrieve the data in this unit.
See Also:
AIsisUnit - getData()
Returns:
String list - output data formated the same as in the .DAT file.
"""
out_data = self._getHeadData()
out_data.extend(self._getRowData())
out_data.extend(self._getAdditionalRowData())
return out_data
def _formatDataItem(self,
item,
col_width,
no_of_dps=None,
is_head_item=True,
align_right=True):
"""Format the given head data item for printing to file.
"""
if is_head_item:
item = self.head_data[item]
if not no_of_dps == None:
form = '%0.' + str(no_of_dps) + 'f'
item = form % float(item)
if align_right:
final_str = '{:>' + str(col_width) + '}'
else:
final_str = '{:<' + str(col_width) + '}'
return final_str.format(item)
def _getRowData(self):
"""For all the rows in the river geometry section get the data from
the rowdatacollection class.
Returns:
list - containing the formatted unit rows.
"""
out_data = []
no_of_rows = self.row_collection.getNumberOfRows()
out_data.append(
self._formatDataItem(no_of_rows, 10, is_head_item=False))
for i in range(0, no_of_rows):
out_data.append(self.row_collection.getPrintableRow(i))
return out_data
def _getAdditionalRowData(self):
"""Get the formatted row data for any additional row data objects.
Returns:
list - containing additional row data.
"""
out_data = []
for data in self.additional_row_collections.itervalues():
no_of_rows = data.getNumberOfRows()
out_data.append(
self._formatDataItem(no_of_rows, 10, is_head_item=False))
for i in range(0, no_of_rows):
out_data.append(data.getPrintableRow(i))
return out_data
def _getHeadData(self):
"""Get the header data formatted for printing out
Note:
Must be implemented by concrete subclass.
Raises:
NotImplementedError: if not overridden by sub class
"""
raise NotImplementedError
def updateDataRow(self, row_vals, index, collection_name=None):
"""Updates the row at the given index in the river units row_collection.
The row will be updated at the given index.
Args:
row_vals(Dict): keys must be datunits.ROW_DATA_TYPES with a legal
value assigned for the DataType. Chainage and Elevation MUST
be included.
index: the row to update.
collection_name=None(str): If None the self.row_collection
with the bridges geometry data will be updated. If a string it
will be looked for in the self.additional_row_collections
dictionary or raise an AttributeError if it doesn't exist.
Raises:
KeyError: If collection_name key does not exist.
IndexError: If the index does not exist.
ValueError: If the given value is not accepted by the DataObject's.
See Also:
ADataObject and subclasses for information on the parameters.
"""
if not collection_name is None:
if not collection_name in self.additional_row_collections.keys():
raise KeyError(
'collection_name %s does not exist in row collection' %
(collection_name))
# Call superclass method to add the new row
AIsisUnit.updateDataRow(self, index=index, row_vals=row_vals)
def addDataRow(self, row_vals, index=None, collection_name=None):
"""Adds a new row to one of this bridge units row_collection's.
The new row will be added at the given index. If no index is given it
will be appended to the end of the collection.
If no chainage or elevation values are given an AttributeError will be
raised as they cannot have default values. All other values can be
ommitted. If they are they will be given defaults.
Examples:
>>> import ship.isis.datunits.rdt as rdt
>>> unit.addDataRow({rdt.CHAINAGE:5.0, rdt.ELEVATION:36.2}, index=4)
Args:
row_vals(Dict): keys must be datunits.rdt with a legal
value assigned for the DataType. Chainage and Elevation MUST
be included.
index=None(int): the row to insert into. The existing row at the
given index will be moved up by one.
collection_name=None(str): If None the self.row_collection
with the bridges geometry data will be updated. If a string it
will be looked for in the self.additional_row_collections
dictionary or raise an AttributeError if it doesn't exist.
Raises:
AttributeError: If CHAINAGE or ELEVATION are not given.
KeyError: if the collection_name does not exist.
IndexError: If the index does not exist.
ValueError: If the given value is not accepted by the DataObject's.
See Also:
ADataObject and subclasses for information on the parameters.
"""
if not rdt.CHAINAGE in row_vals.keys(
) or not rdt.ELEVATION in row_vals.keys():
logger.error('Required values of CHAINAGE and ELEVATION not given')
raise AttributeError(
'Required values of CHAINAGE and ELEVATION not given')
if not collection_name is None:
if not collection_name in self.additional_row_collections.keys():
raise KeyError(
'collection_name %s does not exist in row collection' %
(collection_name))
# Setup default values for arguments that aren't given
kw = {}
kw[rdt.CHAINAGE] = row_vals.get(rdt.CHAINAGE)
kw[rdt.ELEVATION] = row_vals.get(rdt.ELEVATION)
kw[rdt.ROUGHNESS] = row_vals.get(rdt.ROUGHNESS, 0.039)
kw[rdt.PANEL_MARKER] = row_vals.get(rdt.PANEL_MARKER, False)
kw[rdt.RPL] = row_vals.get(rdt.RPL, 1.0)
kw[rdt.BANKMARKER] = row_vals.get(rdt.BANKMARKER, '')
kw[rdt.EASTING] = row_vals.get(rdt.EASTING, 0.0)
kw[rdt.NORTHING] = row_vals.get(rdt.NORTHING, 0.0)
kw[rdt.DEACTIVATION] = row_vals.get(rdt.DEACTIVATION, '')
kw[rdt.SPECIAL] = row_vals.get(rdt.SPECIAL, '')
# Call superclass method to add the new row
AIsisUnit.addDataRow(self,
index=index,
row_vals=kw,
collection_name=collection_name)
def _checkChainageIncreaseNotNegative(self, index, chainageValue):
"""Checks that new chainage value is not not higher than the next one.
If the given chainage value for the given index is higher than the
value in the following row ISIS will give a negative chainage error.
It will return true if the value is the last in the row.
Args:
index (int): The index that the value is to be added at.
chainageValue (float): The chainage value to be added.
Returns:
False if greater or True if less.
"""
if index == None:
return True
if not index == 0:
if self.row_collection.getDataValue(rdt.CHAINAGE,
index - 1) >= chainageValue:
return False
if self.row_collection.getDataValue(rdt.CHAINAGE,
index) <= chainageValue:
return False
return True