def update_meta_destination(self, destination, txip_str, txport):
''' Update a destination for SPEAD meta data output. Create a new one if not yet existing
@param destination: unique descriptor string describing destination
@param txip_str: IP address in string form (takes preference)
@param txport: transmission port as integer
'''
log_not_implemented_error(LOGGER, '%s.update_meta_destination not implemented'%self.descriptor)
def delete_meta_destination(self, destination=all):
''' Clears destination from SPEAD meta data destination list
@param desination: unique descriptor string describing destination to be cleared from list
'''
log_not_implemented_error(LOGGER, '%s.delete_meta_destination not implemented'%self.descriptor)
def start_tx(self):
''' Start SPEAD data transmission
'''
log_not_implemented_error(LOGGER, '%s.start_tx not implemented'%self.descriptor)
def stop_tx(self, issue_meta=True):
''' Stop SPEAD data transmission
@param issue_meta: Issue SPEAD meta data informing receivers of stopped stream
'''
log_not_implemented_error(LOGGER, '%s.stop_tx not implemented'%self.descriptor)
def get_txport(self):
log_not_implemented_error(LOGGER, '%s.get_txport not implemented'%self.descriptor)
def is_producing_valid_data(self):
''' Is producing valid data ready for SPEAD output
'''
log_not_implemented_error(LOGGER, '%s.is_producing_valid_data not implemented'%self.descriptor)
def set_txip(self, txip_str=None, issue_spead=True):
''' Set base transmission IP for SPEAD output
@param txip_str: IP address in string form
'''
log_not_implemented_error(LOGGER, '%s.set_txip not implemented'%self.descriptor)
def calculate_integration_time(self):
'''Calculate the number of accumulations and integration time for this system.
'''
log_not_implemented_error(LOGGER, '%s.calculate_integration_time not implemented'%self.descriptor)
def get_status(self):
''' Get status related to this engine
'''
log_not_implemented_error(LOGGER, '%s.get_status not implemented'%self.descriptor)
def is_receiving_valid_data(self):
''' Is receiving valid data
'''
log_not_implemented_error(LOGGER, '%s.is_receiving_valid_data not implemented'%self.descriptor)
def clear_status(self):
''' Clear status related to this engine
'''
log_not_implemented_error(LOGGER, '%s.clear_status not implemented'%self.descriptor)
def create_fengine(self, ant_id):
'''Create an fengine.
Overload in decendant class
'''
log_not_implemented_error(LOGGER, '%s.create_fengine not implemented'%self.descriptor)
def calculate_bandwidth(self):
'''Determine the bandwidth the system is processing.
The ADC on the running system must report how much bandwidth it is processing.
'''
log_not_implemented_error(LOGGER, '%s.calculate_bandwidth not implemented'%self.descriptor)
def setup_hosts_for_engines_of_type(self, engine_type):
''' Instruments must do this themselves based on instrument and engine type
'''
log_not_implemented_error(LOGGER, '%s.setup_hosts_for_engines_of_type not implemented'%self.descriptor)
def set_txport(self, txport=None, issue_meta=True):
''' Set transmission port for SPEAD output
@param txport: transmission port as integer
'''
log_not_implemented_error(LOGGER, '%s.set_txport not implemented'%self.descriptor)
def create_engines_of_type(self, engine_type):
''' Create a new engine of specified type using link provided and info
This should be created in instrument being implemented as it helps
generic instruments create engines with the same capabilities
'''
log_not_implemented_error(LOGGER, '%s.create_engines_of_type not implemented'%self.descriptor)
def create_xengine(self, xengine_index):
''' Create an xengine.
'''
log_not_implemented_error(LOGGER, '%s.create_xengine not implemented'%self.descriptor)
