encoder Class Reference
Encode/decode data in different encodings. More...
Public Member Functions | |
| encoder () | |
| virtual | ~encoder () |
| virtual utility::stream::size_type | encode (utility::inputStream &in, utility::outputStream &out, utility::progressListener *progress=NULL)=0 |
| virtual utility::stream::size_type | decode (utility::inputStream &in, utility::outputStream &out, utility::progressListener *progress=NULL)=0 |
| const propertySet & | getProperties () const |
| propertySet & | getProperties () |
| virtual const std::vector< string > | getAvailableProperties () const |
| const propertySet & | getResults () const |
Protected Member Functions | |
| propertySet & | getResults () |
Detailed Description
Encode/decode data in different encodings.
Constructor & Destructor Documentation
| encoder | ( | ) |
| ~encoder | ( | ) | [virtual] |
Member Function Documentation
| virtual utility::stream::size_type decode | ( | utility::inputStream & | in, | |
| utility::outputStream & | out, | |||
| utility::progressListener * | progress = NULL | |||
| ) | [pure virtual] |
Decode data.
- Parameters:
-
in input data (encoded) out output stream for decoded data progress progress listener, or NULL if you do not want to receive progress notifications
- Returns:
- number of bytes written into output stream
Implemented in b64Encoder, binhexEncoder, defaultEncoder, qpEncoder, and uuEncoder.
| virtual utility::stream::size_type encode | ( | utility::inputStream & | in, | |
| utility::outputStream & | out, | |||
| utility::progressListener * | progress = NULL | |||
| ) | [pure virtual] |
Encode data.
- Parameters:
-
in input data (decoded) out output stream for encoded data progress progress listener, or NULL if you do not want to receive progress notifications
- Returns:
- number of bytes written into output stream
Implemented in b64Encoder, binhexEncoder, defaultEncoder, qpEncoder, and uuEncoder.
| const std::vector< string > getAvailableProperties | ( | ) | const [virtual] |
Return a list of property names that can be set for this encoder.
- Returns:
- list of property names
Reimplemented in b64Encoder, binhexEncoder, qpEncoder, and uuEncoder.
Referenced by uuEncoder::getAvailableProperties(), qpEncoder::getAvailableProperties(), and b64Encoder::getAvailableProperties().
| propertySet & getProperties | ( | ) |
Return the properties of the encoder.
- Returns:
- properties of the encoder
| const propertySet & getProperties | ( | ) | const |
Return the properties of the encoder.
- Returns:
- properties of the encoder
Referenced by qpEncoder::decode(), uuEncoder::encode(), qpEncoder::encode(), b64Encoder::encode(), and uuEncoder::uuEncoder().
| propertySet & getResults | ( | ) | [protected] |
| const propertySet & getResults | ( | ) | const |
Return the results returned by this encoder.
- Returns:
- results returned by the encoder
Referenced by uuEncoder::decode().
The documentation for this class was generated from the following files:
