ionflux.org | Impressum

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

Truncate a string, appending optional dots. More...

#include <StringManipulator.hpp>

Inheritance diagram for Ionflux::Tools::StringTruncate:

Inheritance graph
[legend]
Collaboration diagram for Ionflux::Tools::StringTruncate:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Static Public Attributes

static const std::string STRINGMANIP_NAME = "truncate"
 Name of this string manipulator.

Detailed Description

Truncate a string, appending optional dots.

truncate(l, [d])
l - Length to truncate string to.
d - Dot string to be appended (optional)

Note: The total length of the string will always be l, whether a dot string is specified or not.


Constructor & Destructor Documentation

Ionflux::Tools::StringTruncate::StringTruncate  )  [inline]
 

Constructor.

virtual Ionflux::Tools::StringTruncate::~StringTruncate  )  [inline, virtual]
 

Destructor.


Member Function Documentation

std::string Ionflux::Tools::StringTruncate::getName  )  [virtual]
 

Get name.

Returns:
Name of the string manipulator.

Implements Ionflux::Tools::StringManipulator.

std::string Ionflux::Tools::StringTruncate::process const std::string &  bytes,
std::vector< std::string > *  args = 0
[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.

Implements Ionflux::Tools::StringManipulator.


Member Data Documentation

const string Ionflux::Tools::StringTruncate::STRINGMANIP_NAME = "truncate" [static]
 

Name of this string manipulator.


The documentation for this class was generated from the following files:
Generated on Tue Mar 14 21:09:52 2006 for Ionflux Tools Class Library (iftools) by  doxygen 1.4.6