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

FdoIGetSpatialContexts Class Reference

#include <IGetSpatialContexts.h>

Inherits FdoICommand.

Inheritance diagram for FdoIGetSpatialContexts:

[legend]
List of all members.

Detailed Description

The FdoIGetSpatialContexts interface defines the GetSpatialContexts command, which enumerates the existing spatial contexts.

Definition at line 34 of file IGetSpatialContexts.h.


Public Member Functions

virtual FDO_API FdoISpatialContextReaderExecute ()=0
 Executes the GetSpatialContexts command returning an FdoISpatialContextReader.
virtual FDO_API const bool GetActiveOnly ()=0
 Gets a Boolean flag that indicates if the GetSpatialContexts command will return only the active spatial context or all spatial contexts. The default value of this flag is false, return all spatial contexts.
virtual FDO_API void SetActiveOnly (const bool value)=0
 Sets a Boolean flag that indicates if the GetSpatialContexts command will return only the active spatial context or all spatial contexts. The default value of this flag is false, return all spatial contexts.

Friends

class FdoIConnection

Member Function Documentation

virtual FDO_API FdoISpatialContextReader* FdoIGetSpatialContexts::Execute  )  [pure virtual]
 

Executes the GetSpatialContexts command returning an FdoISpatialContextReader.

Returns:
Returns nothing

virtual FDO_API const bool FdoIGetSpatialContexts::GetActiveOnly  )  [pure virtual]
 

Gets a Boolean flag that indicates if the GetSpatialContexts command will return only the active spatial context or all spatial contexts. The default value of this flag is false, return all spatial contexts.

Returns:
Returns Boolean value

virtual FDO_API void FdoIGetSpatialContexts::SetActiveOnly const bool  value  )  [pure virtual]
 

Sets a Boolean flag that indicates if the GetSpatialContexts command will return only the active spatial context or all spatial contexts. The default value of this flag is false, return all spatial contexts.

Parameters:
value Input the Boolean flag
Returns:
Returns nothing

Friends And Related Function Documentation

friend class FdoIConnection [friend]
 

Reimplemented from FdoICommand.

Definition at line 36 of file IGetSpatialContexts.h.


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