FME Server C++ API 3.0

IFMEServerCustomFormat Class Reference

IFMEServerCustomFormat interface. More...

#include <ifmeservercustomformat.h>

List of all members.

Public Member Functions

virtual void getDescription (IFMEServerString &description) const =0
virtual FME_UInt32 getFileSize () const =0
virtual void getName (IFMEServerString &name) const =0
virtual IFMEServerResourceVectorgetResources () const =0
virtual void getTitle (IFMEServerString &title) const =0

Protected Member Functions

 IFMEServerCustomFormat ()
virtual ~IFMEServerCustomFormat ()

Private Member Functions

 IFMEServerCustomFormat (const IFMEServerCustomFormat &other)
IFMEServerCustomFormatoperator= (const IFMEServerCustomFormat &other)

Detailed Description

IFMEServerCustomFormat interface.

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

IFMEServerCustomFormat::IFMEServerCustomFormat ( ) [inline, protected]
virtual IFMEServerCustomFormat::~IFMEServerCustomFormat ( ) [inline, protected, virtual]
IFMEServerCustomFormat::IFMEServerCustomFormat ( const IFMEServerCustomFormat other) [private]

Member Function Documentation

virtual void IFMEServerCustomFormat::getDescription ( IFMEServerString description) const [pure virtual]

Gets the description of the custom format.

Parameters:
descriptionIFMEServerString to store the description of the custom format
virtual FME_UInt32 IFMEServerCustomFormat::getFileSize ( ) const [pure virtual]

Gets the file size of the custom format.

Returns:
the file size of the custom format
virtual void IFMEServerCustomFormat::getName ( IFMEServerString name) const [pure virtual]

Gets the name of the custom format.

Parameters:
nameIFMEServerString to store the name of the custom format
virtual IFMEServerResourceVector* IFMEServerCustomFormat::getResources ( ) const [pure virtual]

Gets all the resources of the custom format.

Returns:
a list of all of the custom format's resources
virtual void IFMEServerCustomFormat::getTitle ( IFMEServerString title) const [pure virtual]

Gets the title of the custom format.

Parameters:
titleIFMEServerString to store the title of the custom format
IFMEServerCustomFormat& IFMEServerCustomFormat::operator= ( const IFMEServerCustomFormat other) [private]

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