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

FdoFunctionDefinition Class Reference

#include <FunctionDefinition.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoFunctionDefinition:

[legend]
List of all members.

Detailed Description

The FdoFunctionDefinition class contains metadata that describes a function and its arguments.

Definition at line 35 of file FunctionDefinition.h.


Public Member Functions

virtual FDO_API FdoBoolean CanSetName ()
 Indicates that this object allows its name to change. This function is defined so that this class can be a FdoNamedCollection element.
FDO_API FdoReadOnlyArgumentDefinitionCollectionGetArguments ()
 Gets an array of FdoArgumentDefinition objects required for the function.
FDO_API FdoStringGetDescription ()
 Gets a brief description of the function.
virtual FDO_API FdoFunctionCategoryType GetFunctionCategoryType ()
 Returns the category for the function described in the current function definition.
FDO_API FdoStringGetName ()
 Gets the name of the function.
FDO_API FdoPropertyType GetReturnPropertyType ()
 Gets the FdoPropertyType of the function return value.
FDO_API FdoDataType GetReturnType ()
 Gets the FdoDataType of the function return value. This is only valid if the function return property type is FdoPropertyType_DataProperty.
FDO_API FdoReadOnlySignatureDefinitionCollectionGetSignatures ()
 Gets an array of FdoSignatureDefinition objects that describe the different signatures supported by the function.
FDO_API bool IsAggregate ()
 Returns true if the function is an aggregate function and false if it is a simple function.

Static Public Member Functions

FDO_API FdoFunctionDefinitionCreate (FdoString *name, FdoString *description, bool isAggregate, FdoSignatureDefinitionCollection *signatures, FdoFunctionCategoryType functionCategoryType=FdoFunctionCategoryType_Unspecified)
 Constructs an instance of an FdoFunctionDefinition using the specified arguments.
FDO_API FdoFunctionDefinitionCreate (FdoString *name, FdoString *description, FdoPropertyType returnPropertyType, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments, FdoFunctionCategoryType functionCategoryType=FdoFunctionCategoryType_Unspecified)
 Constructs an instance of an FdoFunctionDefinition using the specified arguments.
FDO_API FdoFunctionDefinitionCreate (FdoString *name, FdoString *description, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments, FdoFunctionCategoryType functionCategoryType=FdoFunctionCategoryType_Unspecified)
 Constructs an instance of an FdoFunctionDefinition using the specified arguments.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoFunctionDefinition ()
 Constructs an instance of an FdoFunctionDefinition using default values.
 FdoFunctionDefinition (FdoString *name, FdoString *description, bool isAggregate, FdoSignatureDefinitionCollection *signatures, FdoFunctionCategoryType functionCategoryType)
 Constructs an instance of an FdoFunctionDefinition using the specified arguments.
 FdoFunctionDefinition (FdoString *name, FdoString *description, FdoPropertyType returnPropertyType, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments, FdoFunctionCategoryType functionCategoryType)
 Constructs an instance of an FdoFunctionDefinition using the specified arguments.
 FdoFunctionDefinition (FdoString *name, FdoString *description, FdoDataType returnType, FdoArgumentDefinitionCollection *arguments, FdoFunctionCategoryType functionCategoryType)
 Constructs an instance of an FdoFunctionDefinition using the specified arguments.
virtual ~FdoFunctionDefinition ()

Protected Attributes

wchar_t * m_description
FdoFunctionCategoryType m_functionCategoryType
bool m_isAggregate
wchar_t * m_name
FdoReadOnlySignatureDefinitionCollectionm_signatures

Constructor & Destructor Documentation

FdoFunctionDefinition::FdoFunctionDefinition FdoString name,
FdoString description,
FdoDataType  returnType,
FdoArgumentDefinitionCollection arguments,
FdoFunctionCategoryType  functionCategoryType
[protected]
 

Constructs an instance of an FdoFunctionDefinition using the specified arguments.

FdoFunctionDefinition::FdoFunctionDefinition FdoString name,
FdoString description,
FdoPropertyType  returnPropertyType,
FdoDataType  returnType,
FdoArgumentDefinitionCollection arguments,
FdoFunctionCategoryType  functionCategoryType
[protected]
 

Constructs an instance of an FdoFunctionDefinition using the specified arguments.

FdoFunctionDefinition::FdoFunctionDefinition FdoString name,
FdoString description,
bool  isAggregate,
FdoSignatureDefinitionCollection signatures,
FdoFunctionCategoryType  functionCategoryType
[protected]
 

Constructs an instance of an FdoFunctionDefinition using the specified arguments.

FdoFunctionDefinition::FdoFunctionDefinition  )  [protected]
 

Constructs an instance of an FdoFunctionDefinition using default values.

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


Member Function Documentation

virtual FDO_API FdoBoolean FdoFunctionDefinition::CanSetName  )  [inline, virtual]
 

Indicates that this object allows its name to change. This function is defined so that this class can be a FdoNamedCollection element.

Returns:
Returns false

Definition at line 202 of file FunctionDefinition.h.

References FDO_API, and FdoBoolean.

FDO_API FdoFunctionDefinition* FdoFunctionDefinition::Create FdoString name,
FdoString description,
bool  isAggregate,
FdoSignatureDefinitionCollection signatures,
FdoFunctionCategoryType  functionCategoryType = FdoFunctionCategoryType_Unspecified
[static]
 

Constructs an instance of an FdoFunctionDefinition using the specified arguments.

Parameters:
name Input the name of the function.
description Input a brief description.
isAggregate Input a flag indicating whether or not this is an aggregate function.
signatures Input the list of possible function signatures
functionCategoryType Input the category the function belongs to. If not specified the function is categorized as unspecified. Valid values for this parameter are defined in the enumeration FdoFunctionCategoryType.
Returns:
Returns FdoFunctionDefinition

FDO_API FdoFunctionDefinition* FdoFunctionDefinition::Create FdoString name,
FdoString description,
FdoPropertyType  returnPropertyType,
FdoDataType  returnType,
FdoArgumentDefinitionCollection arguments,
FdoFunctionCategoryType  functionCategoryType = FdoFunctionCategoryType_Unspecified
[static]
 

Constructs an instance of an FdoFunctionDefinition using the specified arguments.

Parameters:
name Input the name of the function.
description Input a brief description.
returnPropertyType Input the function return property type
returnType Input the function return data type (ignore it property type is not data)
arguments Input the argument definition list
functionCategoryType Input the category the function belongs to. If not specified the function is categorized as unspecified. Valid values for this parameter are defined in the enumeration FdoFunctionCategoryType.
Returns:
Returns FdoFunctionDefinition

FDO_API FdoFunctionDefinition* FdoFunctionDefinition::Create FdoString name,
FdoString description,
FdoDataType  returnType,
FdoArgumentDefinitionCollection arguments,
FdoFunctionCategoryType  functionCategoryType = FdoFunctionCategoryType_Unspecified
[static]
 

Constructs an instance of an FdoFunctionDefinition using the specified arguments.

Parameters:
name Input the name of the function.
description Input a brief description.
returnType Input the function return type
arguments Input the argument definition list
functionCategoryType Input the category the function belongs to. If not specified the function is categorized as unspecified. Valid values for this parameter are defined in the enumeration FdoFunctionCategoryType.
Returns:
Returns FdoFunctionDefinition

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoReadOnlyArgumentDefinitionCollection* FdoFunctionDefinition::GetArguments  ) 
 

Gets an array of FdoArgumentDefinition objects required for the function.

Returns:
Returns the list of argument definitions

FDO_API FdoString* FdoFunctionDefinition::GetDescription  ) 
 

Gets a brief description of the function.

Returns:
Returns the description of the function

virtual FDO_API FdoFunctionCategoryType FdoFunctionDefinition::GetFunctionCategoryType  )  [inline, virtual]
 

Returns the category for the function described in the current function definition.

Returns:
Returns the category for the function described in the current function

Definition at line 226 of file FunctionDefinition.h.

References FDO_API, and FdoFunctionCategoryType.

FDO_API FdoString* FdoFunctionDefinition::GetName  ) 
 

Gets the name of the function.

Returns:
Returns the name of the function

FDO_API FdoPropertyType FdoFunctionDefinition::GetReturnPropertyType  ) 
 

Gets the FdoPropertyType of the function return value.

Returns:
Returns the function return property type

FDO_API FdoDataType FdoFunctionDefinition::GetReturnType  ) 
 

Gets the FdoDataType of the function return value. This is only valid if the function return property type is FdoPropertyType_DataProperty.

Returns:
Returns the function return data type

FDO_API FdoReadOnlySignatureDefinitionCollection* FdoFunctionDefinition::GetSignatures  ) 
 

Gets an array of FdoSignatureDefinition objects that describe the different signatures supported by the function.

FDO_API bool FdoFunctionDefinition::IsAggregate  ) 
 

Returns true if the function is an aggregate function and false if it is a simple function.


Member Data Documentation

wchar_t* FdoFunctionDefinition::m_description [protected]
 

Definition at line 234 of file FunctionDefinition.h.

FdoFunctionCategoryType FdoFunctionDefinition::m_functionCategoryType [protected]
 

Definition at line 236 of file FunctionDefinition.h.

bool FdoFunctionDefinition::m_isAggregate [protected]
 

Definition at line 232 of file FunctionDefinition.h.

wchar_t* FdoFunctionDefinition::m_name [protected]
 

Definition at line 233 of file FunctionDefinition.h.

FdoReadOnlySignatureDefinitionCollection* FdoFunctionDefinition::m_signatures [protected]
 

Definition at line 235 of file FunctionDefinition.h.


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