FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoFunction Class Reference

#include <Function.h>

Inherits FdoExpression.

Inheritance diagram for FdoFunction:

[legend]
List of all members.

Detailed Description

The FdoFunction class derives from FdoExpression and represents a function call. As such it defines the name of the function and the collection of arguments to be passed to it.

Definition at line 34 of file Function.h.


Public Member Functions

FDO_API FdoExpressionCollectionGetArguments ()
 Gets the FdoExpressionCollection that contains the arguments to the function.
FDO_API FdoStringGetName ()
 Gets the name of the function.
FDO_API void Process (FdoIExpressionProcessor *p)
 Overrides FdoExpression.Process to pass the FdoFunction to the appropriate expression processor operation.
FDO_API void SetName (FdoString *value)
 Sets the name of the function.
FDO_API FdoStringToString ()
 Returns the well defined text representation of this expression.
FdoStringToStringInternal (FdoIdentifierCollection *pIdCol)
 This is an internal method. It returns the well defined text representation of the expression.

Static Public Member Functions

FDO_API FdoFunctionCreate (FdoString *name, FdoExpressionCollection *arguments)
 Constructs an instance of a function using the specified arguments.
FDO_API FdoFunctionCreate (FdoString *name, FdoExpression **arguments, FdoInt32 numArgs)
 Constructs an instance of a function using the specified arguments.
FDO_API FdoFunctionCreate ()
 Constructs a default instance of an FdoFunction.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoFunction (FdoString *name, FdoExpression **arguments, FdoInt32 numArgs)
 Constructs an instance of a function using the specified arguments.
 FdoFunction ()
 Constructs a default instance of an FdoFunction.
virtual ~FdoFunction ()
 Default destructor for FdoFunction.

Constructor & Destructor Documentation

FdoFunction::FdoFunction  )  [protected]
 

Constructs a default instance of an FdoFunction.

FdoFunction::FdoFunction FdoString name,
FdoExpression **  arguments,
FdoInt32  numArgs
[protected]
 

Constructs an instance of a function using the specified arguments.

virtual FdoFunction::~FdoFunction  )  [protected, virtual]
 

Default destructor for FdoFunction.


Member Function Documentation

FDO_API FdoFunction* FdoFunction::Create FdoString name,
FdoExpressionCollection arguments
[static]
 

Constructs an instance of a function using the specified arguments.

Parameters:
name Input name of the function
arguments Input arguments as collection
Returns:
Returns FdoFunction

FDO_API FdoFunction* FdoFunction::Create FdoString name,
FdoExpression **  arguments,
FdoInt32  numArgs
[static]
 

Constructs an instance of a function using the specified arguments.

Parameters:
name Input name of the function
arguments Input pointer to arguments
numArgs Input number of arguments
Returns:
Returns FdoFunction

FDO_API FdoFunction* FdoFunction::Create  )  [static]
 

Constructs a default instance of an FdoFunction.

Returns:
Returns FdoFunction class

virtual void FdoFunction::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoExpressionCollection* FdoFunction::GetArguments  ) 
 

Gets the FdoExpressionCollection that contains the arguments to the function.

Returns:
Returns arguments as collection

FDO_API FdoString* FdoFunction::GetName  ) 
 

Gets the name of the function.

Returns:
Returns name of the function

FDO_API void FdoFunction::Process FdoIExpressionProcessor p  )  [virtual]
 

Overrides FdoExpression.Process to pass the FdoFunction to the appropriate expression processor operation.

Parameters:
p Input expression processor
Returns:
Returns nothing

Implements FdoExpression.

FDO_API void FdoFunction::SetName FdoString value  ) 
 

Sets the name of the function.

Parameters:
value Input name of the function
Returns:
Returns nothing

FDO_API FdoString* FdoFunction::ToString  )  [virtual]
 

Returns the well defined text representation of this expression.

Returns:
Returns the well defined text representation of this expression

Implements FdoExpression.

FdoString* FdoFunction::ToStringInternal FdoIdentifierCollection pIdCol  )  [virtual]
 

This is an internal method. It returns the well defined text representation of the expression.

Parameters:
pIdCol A identifier collection that contains all the computed identifier used by the filter
Returns:
Returns the well defined text string

Reimplemented from FdoExpression.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.