srecord 1.65.0
 
Loading...
Searching...
No Matches
srecord::input_filter_interval Class Referenceabstract

The srecord::input_filter_interval class is used to represent a filter which works with the interval representing the data's coverage, exclusive of where the result is to be placed. More...

#include <interval.h>

Inheritance diagram for srecord::input_filter_interval:
Collaboration diagram for srecord::input_filter_interval:

Public Member Functions

virtual ~input_filter_interval ()
 The destructor.
 
- Public Member Functions inherited from srecord::input_filter
virtual ~input_filter ()
 The destructor.
 
std::string filename () const
 The filename method is used to get the name of the input file being processed.
 
std::string filename_and_line () const
 The filename_and_line method is used to get the name and current line number within the file.
 
const char * get_file_format_name () const
 The get_file_format_name method is used to find out the name of the file format being read.
 
void disable_checksum_validation ()
 The disable_checksum_validation method is used to have this input stream ignore checksum errors.
 
- Public Member Functions inherited from srecord::input
virtual ~input ()
 The destructor.
 
virtual void fatal_error (const char *,...) const FORMAT_PRINTF(2
 The fatal_error method is used to report problems parsing the file.
 
virtual void virtual void fatal_error_errno (const char *,...) const FORMAT_PRINTF(2
 The fatal_error_errno method is used to report problems reading the input file.
 
virtual void virtual void virtual void warning (const char *,...) const FORMAT_PRINTF(2
 The warning method is used to report potential (but non-fatal) problems parsing the file.
 
void set_quit (quit &)
 The set_quit method is used to set the disposition of the error messages, and the "exit" implementation.
 
void reset_quit (void)
 The reset_quit method is used to cause the disposition of the error messages, and the "exit" back to the default.
 
virtual void command_line (srecord::arglex_tool *cmdln)
 The command_line method is used by arglex_srec::get_input when parsing the command line, to give a format or filter an opportunity to grab extra arguments off the command line.
 

Protected Member Functions

 input_filter_interval (const input::pointer &deeper, long address, int length, endian_t end, bool inclusive)
 The constructor.
 
virtual long calculate_result () const =0
 The calculate_result method is used to calculate the final value to be placed into the output.
 
const intervalget_range () const
 The get_range method may be used to derived classes to get access to the address range covered by the input data.
 
bool read (record &record)
 The read method is used to read one record from the input.
 
- Protected Member Functions inherited from srecord::input_filter
 input_filter (input::pointer deeper)
 The constructor.
 
- Protected Member Functions inherited from srecord::input
 input ()
 The default constructor.
 

Additional Inherited Members

- Public Types inherited from srecord::input
typedef std::shared_ptr< inputpointer
 
- Protected Attributes inherited from srecord::input_filter
pointer ifp
 

Detailed Description

The srecord::input_filter_interval class is used to represent a filter which works with the interval representing the data's coverage, exclusive of where the result is to be placed.

Definition at line 33 of file interval.h.

Constructor & Destructor Documentation

◆ ~input_filter_interval()

virtual srecord::input_filter_interval::~input_filter_interval ( )
virtual

The destructor.

◆ input_filter_interval()

srecord::input_filter_interval::input_filter_interval ( const input::pointer & deeper,
long address,
int length,
endian_t end,
bool inclusive )
protected

The constructor.

Parameters
deeperThe input source to be filtered.
addressThe address at which to place the interval.
lengthThe number of bytes of interval to be inserted.
endThe byte order.
inclusivetrue if the output location is included in the address range, false if not

Referenced by read().

Member Function Documentation

◆ calculate_result()

virtual long srecord::input_filter_interval::calculate_result ( ) const
protectedpure virtual

The calculate_result method is used to calculate the final value to be placed into the output.

Implemented in srecord::input_filter_interval_length, srecord::input_filter_interval_maximum, and srecord::input_filter_interval_minimum.

◆ get_range()

const interval & srecord::input_filter_interval::get_range ( ) const
inlineprotected

The get_range method may be used to derived classes to get access to the address range covered by the input data.

Definition at line 71 of file interval.h.

◆ read()

bool srecord::input_filter_interval::read ( record & rec)
protectedvirtual

The read method is used to read one record from the input.

It returns 0 at the end of the input, and 1 if a record is read successfully.

See the srecord::record documentation (header file) for details of the various record types.

Note: there is no guarantee that a header record will appear first, or that a execution start address record will appear last.

Parameters
recWhere to put the returned data.
Returns
bool; true if data was read, false if at end-of-file

Reimplemented from srecord::input_filter.

References input_filter_interval().


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