IFMEServerParameter Class Reference

IFMEServerParameter interface. More...

#include <ifmeserverparameter.h>

List of all members.

Public Member Functions
virtual void	getDefaultValue (IFMEServerString &value) const =0
virtual void	getDescription (IFMEServerString &description) const =0
virtual void	getName (IFMEServerString &name) const =0
virtual void	getOptions (IFMEServerString &options) const =0
virtual void	getOptionsList (IFMEServerStringArray &optionsList) const =0
virtual void	getOptionsType (IFMEServerString &optionsType) const =0
virtual void	getType (IFMEServerString &type) const =0
Protected Member Functions
	IFMEServerParameter ()
virtual	~IFMEServerParameter ()
Private Member Functions
	IFMEServerParameter (const IFMEServerParameter &other)
IFMEServerParameter &	operator= (const IFMEServerParameter &other)

---

Detailed Description

IFMEServerParameter 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

IFMEServerParameter::IFMEServerParameter

(

)

[inline, protected]

virtual IFMEServerParameter::~IFMEServerParameter

(

)

[inline, protected, virtual]

IFMEServerParameter::IFMEServerParameter

(

const IFMEServerParameter &

other

)

[private]

---

Member Function Documentation

virtual void IFMEServerParameter::getDefaultValue

(

IFMEServerString &

value

)

const [pure virtual]

Gets the default value for this published parameter, if one has been specified by the workspace author. All values are returned as simple strings.

Returns:

the default value of this parameter, or an empty string if no default value has been specified

See also:

getType()

virtual void IFMEServerParameter::getDescription

(

IFMEServerString &

description

)

const [pure virtual]

Gets a description of this parameter as entered by the workspace author.

Returns:

a description of the parameter

virtual void IFMEServerParameter::getName

(

IFMEServerString &

name

)

const [pure virtual]

Gets the name of the parameter.

Returns:

the name of the parameter

virtual void IFMEServerParameter::getOptions

(

IFMEServerString &

options

)

const [pure virtual]

Gets parameter options in raw form

Returns:

the parameter options in raw form

virtual void IFMEServerParameter::getOptionsList

(

IFMEServerStringArray &

optionsList

)

const [pure virtual]

Gets a list of parameter options.

Returns:

the list of parameter options

virtual void IFMEServerParameter::getOptionsType

(

IFMEServerString &

optionsType

)

const [pure virtual]

Gets the type of the options.

Possible option types are: DEFAULT SINGLECHOICE_CONFIG MULTICHOICE_CONFIG FILEFILTER_CONFIG

Returns:

the type of the options

virtual void IFMEServerParameter::getType

(

IFMEServerString &

type

)

const [pure virtual]

Gets the type of the parameter (e.g., "integer" or "string").

Returns:

the type of the parameter

IFMEServerParameter& IFMEServerParameter::operator=

(

const IFMEServerParameter &

other

)

[private]

---

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

• ifmeserverparameter.h