Strings
|
A String_Filter filters the String contents of a Sliding_String during its slide forward. More...
#include <String_Filter.hh>
Public Types | |
typedef std::string::size_type | Index |
Index of character in a String. | |
Public Member Functions | |
virtual bool | enabled (bool enable) |
Enables or disables filtering. | |
virtual bool | enabled () const |
Tests if the filter is enabled or disabled. | |
virtual void | filter (std::string &a_string, Index start=0, Index end=std::string::npos) |
Applies the filtering algorithm to a string. | |
virtual std::string | identification () const |
Gets the identification string for the filter. | |
virtual | ~String_Filter () |
A String_Filter filters the String contents of a Sliding_String during its slide forward.
virtual ~String_Filter | ( | ) | [inline, virtual] |
virtual std::string identification | ( | ) | const [inline, virtual] |
Gets the identification string for the filter.
By default an empty string is provided.
Reimplemented in Line_Count_Filter, and VMS_Records_Filter.
virtual void filter | ( | std::string & | a_string, |
Index | start = 0 , |
||
Index | end = std::string::npos |
||
) | [inline, virtual] |
Applies the filtering algorithm to a string.
An index range - [start, end) - of the string may be specified over which filtering is to be applied.
a_string | A string to be filtered. |
start | The index in the string of the first character where the filtering is expected to start. |
end | The index where filtering is expected to end; this character is not included in the filtering. |
Reimplemented in Line_Count_Filter, and VMS_Records_Filter.
virtual bool enabled | ( | bool | enable | ) | [inline, virtual] |
Enables or disables filtering.
enable | If true filtering will be enabled; otherwise it is disabled. |
Reimplemented in Line_Count_Filter, and VMS_Records_Filter.
virtual bool enabled | ( | ) | const [inline, virtual] |
Tests if the filter is enabled or disabled.
Reimplemented in Line_Count_Filter, and VMS_Records_Filter.