FME Server C++ API 3.0

IFMEServerVector< T > Class Template Reference

string class More...

#include <ifmeservervector.h>

List of all members.

Public Member Functions

virtual void append (T *element)=0
virtual void clear ()=0
virtual void clearAndDestroy ()=0
virtual FME_UInt32 entries () const =0
virtual void insertAt (const FME_UInt32 index, T *element)=0
virtual T *& operator() (const FME_UInt32 index)=0
virtual T * removeLast ()=0

Protected Member Functions

 IFMEServerVector ()
virtual ~IFMEServerVector ()

Private Member Functions

 IFMEServerVector (const IFMEServerVector &)
IFMEServerVectoroperator= (const IFMEServerVector &)

Detailed Description

template<class T>
class IFMEServerVector< T >

string class

Package Overview:

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

template<class T >
IFMEServerVector< T >::IFMEServerVector ( ) [inline, protected]
template<class T >
virtual IFMEServerVector< T >::~IFMEServerVector ( ) [inline, protected, virtual]
template<class T >
IFMEServerVector< T >::IFMEServerVector ( const IFMEServerVector< T > &  ) [private]

Member Function Documentation

template<class T >
virtual void IFMEServerVector< T >::append ( T *  element) [pure virtual]

This method appends the element to the vector. The vector takes ownership of any element appended to it. This is the fastest method of insertion. An attempt to insert NULL will be ignored.

template<class T >
virtual void IFMEServerVector< T >::clear ( ) [pure virtual]

This method removes all entries from the vector. Clearing the vector doesn't delete the elements contained in the vector. The client is responsible for freeing the resources of the features that were in the vector. This method is intended to be used to reset a vector for future use.

template<class T >
virtual void IFMEServerVector< T >::clearAndDestroy ( ) [pure virtual]

This method destroys all elements of the vector, and then clears the array to reset it for future use. If features in the collection have been added more than once, this method should not be used, otherwise there may be unexpected behaviour

template<class T >
virtual FME_UInt32 IFMEServerVector< T >::entries ( ) const [pure virtual]

This method returns the number of entries in the vector

template<class T >
virtual void IFMEServerVector< T >::insertAt ( const FME_UInt32  index,
T *  element 
) [pure virtual]

This method Inserts the element into the vector at the specified position. The vector takes ownership of any feature inserted into it. An attempt to insert NULL will be ignored. If the specified position is out of range, this method will exhibit the same behaviour as append.

template<class T >
virtual T*& IFMEServerVector< T >::operator() ( const FME_UInt32  index) [pure virtual]

This method retrieves the entry at the given vector position (which must be between 0 and entries() - 1). The client does not own the returned feature. I.e. it will be destroyed when the vector is destroyed. If the index is invalid, NULL is returned.

template<class T >
IFMEServerVector& IFMEServerVector< T >::operator= ( const IFMEServerVector< T > &  ) [private]
template<class T >
virtual T* IFMEServerVector< T >::removeLast ( ) [pure virtual]

This method retrieves the last entry from the vector. This is the most efficient method of retrieving features. The client owns the returned feature. If the collection is empty, NULL is returned


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines