IFMEServerString Class Reference

string class More...

#include <ifmeserverstring.h>

List of all members.

Public Member Functions
virtual const char *	data () const =0
virtual FME_UInt32	length () const =0
virtual	operator const char * () const =0
virtual const char *	operator= (const char *stringValue)=0
virtual FME_Boolean	operator== (const char *other)=0
virtual void	set (const char *stringValue, const FME_UInt32 length)=0
Protected Member Functions
	IFMEServerString ()
virtual	~IFMEServerString ()
Private Member Functions
	IFMEServerString (const IFMEServerString &)
IFMEServerString &	operator= (const IFMEServerString &)

---

Detailed Description

string class

Package Overview:

This class is an abstract string and string array class that are used to pass character string data between the FME Server and developer's modules.

This file defines the interface that subclasses of this class MUST follow.

Developers MUST NOT implement their own subclasses of this, instead, the FME will ALWAYS provide them with the subclass instance they should be using.

---

Constructor & Destructor Documentation

IFMEServerString::IFMEServerString

(

)

[inline, protected]

virtual IFMEServerString::~IFMEServerString

(

)

[inline, protected, virtual]

IFMEServerString::IFMEServerString

(

const IFMEServerString &

)

[private]

---

Member Function Documentation

virtual const char* IFMEServerString::data

(

)

const [pure virtual]

This method returns a pointer to a const char* string representation of the string. The string retains ownership of the memory returned, and does not guarantee its persistance. Callers should make a copy of the data to ensure its persistance.

virtual FME_UInt32 IFMEServerString::length

(

)

const [pure virtual]

This method returns the actual length of the string, not including null termination.

virtual IFMEServerString::operator const char *

(

)

const [pure virtual]

This operator casts the string to a const char * string. A pointer to the const char* string is returned, but is owned by the string, and is not guaranteed to persist. All callers should make a copy if they want the string to persist.

virtual const char* IFMEServerString::operator=

(

const char *

stringValue

)

[pure virtual]

This operator allows a const char * string to be assigned. The assigned string MUST be NULL terminated, or undefined behaviour will result.

IFMEServerString& IFMEServerString::operator=

(

const IFMEServerString &

)

[private]

virtual FME_Boolean IFMEServerString::operator==

(

const char *

other

)

[pure virtual]

This operator allows comparison with a const char* string.

virtual void IFMEServerString::set	(	const char *	stringValue,
		const FME_UInt32	length
	)		[pure virtual]

This method sets the string using a const char* string and a length. No null termination assumptions are made.

---

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

• ifmeserverstring.h