FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Connections::Capabilities::FunctionDefinition Class Reference

Inherits OSGeo::FDO::Runtime::Disposable.

Inheritance diagram for OSGeo::FDO::Connections::Capabilities::FunctionDefinition:

[legend]
List of all members.

Detailed Description

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


Public Member Functions

 FunctionDefinition (System::String *name, System::String *description, System::Boolean isAggregate, OSGeo::FDO::Connections::Capabilities::SignatureDefinitionCollection *signatures)
 Constructs an instance of a FunctionDefinition using the specified arguments.
 FunctionDefinition (System::String *name, System::String *description, OSGeo::FDO::Schema::DataType returnType, OSGeo::FDO::Connections::Capabilities::ArgumentDefinitionCollection *arguments)
 Constructs an instance of a FunctionDefinition using the specified arguments.
__property OSGeo::FDO::Connections::Capabilities::ReadOnlyArgumentDefinitionCollectionget_Arguments ()
 Gets an array of ArgumentDefinition objects required for the function.
__property System::Boolean get_CanSetName ()
 Indicates that this object allows its name to change. This function is defined so that this class can be a NamedCollection element.
__property System::String * get_Description ()
 Gets a brief description of the function.
__property System::Boolean get_IsAggregate ()
 Returns true if the function is an aggregate function and false if it is a simple function.
__property System::String * get_Name ()
 Gets the name of the function.
__property OSGeo::FDO::Schema::PropertyType get_ReturnPropertyType ()
 Gets the PropertyType of the function return value.
__property OSGeo::FDO::Schema::DataType get_ReturnType ()
 Gets the DataType of the function return value.
__property OSGeo::FDO::Connections::Capabilities::ReadOnlySignatureDefinitionCollectionget_Signatures ()
 Gets an array of SignatureDefinition objects that describe the different signatures supported by the function.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Connections::Capabilities::FunctionDefinition::FunctionDefinition System::String *  name,
System::String *  description,
OSGeo::FDO::Schema::DataType  returnType,
OSGeo::FDO::Connections::Capabilities::ArgumentDefinitionCollection arguments
 

Constructs an instance of a FunctionDefinition 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
Returns:
Returns FunctionDefinition

OSGeo::FDO::Connections::Capabilities::FunctionDefinition::FunctionDefinition System::String *  name,
System::String *  description,
System::Boolean  isAggregate,
OSGeo::FDO::Connections::Capabilities::SignatureDefinitionCollection signatures
 

Constructs an instance of a FunctionDefinition using the specified arguments.

Parameters:
name Input the name of the function.
description Input a brief description.
isAggregate Input the flag indicating whether or not this is an aggregate function
signatures Input the list of possible function signatures
Returns:
Returns FunctionDefinition

Member Function Documentation

__property OSGeo ::FDO ::Connections ::Capabilities ::ReadOnlyArgumentDefinitionCollection* OSGeo::FDO::Connections::Capabilities::FunctionDefinition::get_Arguments  ) 
 

Gets an array of ArgumentDefinition objects required for the function.

Returns:
Returns the list of argument definitions

__property System::Boolean OSGeo::FDO::Connections::Capabilities::FunctionDefinition::get_CanSetName  ) 
 

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

Returns:
Returns true if the name of the object can be changed.

__property System::String* OSGeo::FDO::Connections::Capabilities::FunctionDefinition::get_Description  ) 
 

Gets a brief description of the function.

Returns:
Returns the description of the function

__property System::Boolean OSGeo::FDO::Connections::Capabilities::FunctionDefinition::get_IsAggregate  ) 
 

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

__property System::String* OSGeo::FDO::Connections::Capabilities::FunctionDefinition::get_Name  ) 
 

Gets the name of the function.

Returns:
Returns the name of the function

__property OSGeo ::FDO ::Schema ::PropertyType OSGeo::FDO::Connections::Capabilities::FunctionDefinition::get_ReturnPropertyType  ) 
 

Gets the PropertyType of the function return value.

Returns:
Returns the function return property type

__property OSGeo ::FDO ::Schema ::DataType OSGeo::FDO::Connections::Capabilities::FunctionDefinition::get_ReturnType  ) 
 

Gets the DataType of the function return value.

Returns:
Returns the function return type

__property OSGeo ::FDO ::Connections ::Capabilities ::ReadOnlySignatureDefinitionCollection* OSGeo::FDO::Connections::Capabilities::FunctionDefinition::get_Signatures  ) 
 

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

System::Void OSGeo::FDO::Connections::Capabilities::FunctionDefinition::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.


Comments or suggestions? Send us feedback.