xboa
Public Member Functions | Private Member Functions | List of all members
LineFactoryBase Class Reference

Base factory class for line by line reads. More...

Inherits HitFactoryBase.

Public Member Functions

def __init__
 Initialise the base class. More...
 
def make_hit
 Read a new hit. More...
 

Private Member Functions

def _read_formatted
 Read a line and parse according to some pre-defined format. More...
 

Detailed Description

Base factory class for line by line reads.

LineFactoryBase defines the interface for line-by-line IO of a text file to make hits. LineFactoryBase is a factory class i.e. it is used for generating new hits from a file

Definition at line 30 of file _line_factory_base.py.

Constructor & Destructor Documentation

def __init__ (   self)

Initialise the base class.

Definition at line 35 of file _line_factory_base.py.

Member Function Documentation

def make_hit (   self)

Read a new hit.

Definition at line 42 of file _line_factory_base.py.

def _read_formatted (   cls,
  format_list,
  format_units_dict,
  file_handle,
  mass_shell_condition 
)
private

Read a line and parse according to some pre-defined format.

Definition at line 50 of file _line_factory_base.py.

Referenced by BuiltinHitFactory.make_hit(), and UserHitFactory.make_hit().


The documentation for this class was generated from the following file: