|

Ionflux::Tools::StringManipulator Class Reference
[String filters]

String manipulator. More...

#include <StringManipulator.hpp>

Inheritance diagram for Ionflux::Tools::StringManipulator:

[legend]List of all members.

Public Member Functions
	StringManipulator ()
	Constructor.
virtual	~StringManipulator ()
	Destructor.
virtual std::string	process (const std::string &bytes, std::vector< std::string > *args=0)=0
	Process bytes.
virtual std::string	getName ()=0
	Get name.

---

Detailed Description

String manipulator.

This is an abstract base class to encapsulate an object that manipulates byte strings (i.e. generates one string from another string). String manipulators can thus be used as function objects for constructing string filters.

Each string manipulator should have an unique name by which it can be identified in a set of string manipulators. This name can be obtained with the getName() function.

---

Constructor & Destructor Documentation

Ionflux::Tools::StringManipulator::StringManipulator (   )  [inline]

Constructor. Construct new StringManipulator object.

virtual Ionflux::Tools::StringManipulator::~StringManipulator (   )  [inline, virtual]

Destructor. Destruct StringManipulator object.

---

Member Function Documentation

virtual std::string Ionflux::Tools::StringManipulator::getName (   )  [pure virtual]

Get name. Returns: Name of the string manipulator. Implemented in Ionflux::Tools::StringUppercase, Ionflux::Tools::StringLowercase, Ionflux::Tools::StringErase, Ionflux::Tools::StringReplace, Ionflux::Tools::StringTrim, Ionflux::Tools::StringLTrim, Ionflux::Tools::StringRTrim, Ionflux::Tools::StringTruncate, Ionflux::Tools::StringCenter, Ionflux::Tools::StringMove, Ionflux::Tools::StringAppend, Ionflux::Tools::StringInsert, Ionflux::Tools::StringNumFormat, Ionflux::Tools::StringTranslate, Ionflux::Tools::StringSubstr, Ionflux::Tools::StringLPad, Ionflux::Tools::StringRPad, Ionflux::Tools::StringSWrap, Ionflux::Tools::StringXMLEscape, and Ionflux::Tools::StringURLEncode.

virtual std::string Ionflux::Tools::StringManipulator::process (  const std::string &  bytes, std::vector< std::string > *  args = 0 )  [pure virtual]

Process bytes. Processes a byte string and returns the result. Parameters: bytes  The bytes to process. args  Arguments for the manipulator. Returns: The result of applying the string manipulator to bytes. Implemented in Ionflux::Tools::StringUppercase, Ionflux::Tools::StringLowercase, Ionflux::Tools::StringErase, Ionflux::Tools::StringReplace, Ionflux::Tools::StringTrim, Ionflux::Tools::StringLTrim, Ionflux::Tools::StringRTrim, Ionflux::Tools::StringTruncate, Ionflux::Tools::StringCenter, Ionflux::Tools::StringMove, Ionflux::Tools::StringAppend, Ionflux::Tools::StringInsert, Ionflux::Tools::StringNumFormat, Ionflux::Tools::StringTranslate, Ionflux::Tools::StringSubstr, Ionflux::Tools::StringLPad, Ionflux::Tools::StringRPad, Ionflux::Tools::StringSWrap, Ionflux::Tools::StringXMLEscape, and Ionflux::Tools::StringURLEncode.

---

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

• StringManipulator.hpp

---