FDO API Reference Feature Data Objects

CommandType.h

Go to the documentation of this file.
00001 #ifndef _COMMANDTYPE_H_
00002 #define _COMMANDTYPE_H_
00003 // 
00004 
00005 //
00006 // Copyright (C) 2004-2006  Autodesk, Inc.
00007 // 
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 // 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 // Lesser General Public License for more details.
00016 // 
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 //
00021 
00022 #ifdef _WIN32
00023 #pragma once
00024 #endif
00025 
00026 /// \brief
00027 /// The FdoCommandType enumeration defines the list of abstract commands a feature
00028 /// provider can support.
00029 /// <param name="FdoCommandType_Select">
00030 /// Represents the Select command
00031 /// </param>
00032 /// <param name="FdoCommandType_Insert">
00033 /// Represents the Insert command
00034 /// </param>
00035 /// <param name="FdoCommandType_Delete">
00036 /// Represents the Delete command
00037 /// </param>
00038 /// <param name="FdoCommandType_Update">
00039 /// Represents the Update command
00040 /// </param>
00041 /// <param name="FdoCommandType_DescribeSchema">
00042 /// Represents the DescribeSchema command
00043 /// </param>
00044 /// <param name="FdoCommandType_DescribeSchemaMapping">
00045 /// Represents the DescribeSchemaMapping command
00046 /// </param>
00047 /// <param name="FdoCommandType_ApplySchema">
00048 /// Represents the ApplySchema command.
00049 /// </param>
00050 /// <param name="FdoCommandType_DestroySchema">
00051 /// Represents the DestroySchema command.
00052 /// </param>
00053 /// <param name="FdoCommandType_ActivateSpatialContext">
00054 /// Represents the ActivateSpatialContext command.
00055 /// </param>
00056 /// <param name="FdoCommandType_CreateSpatialContext">
00057 /// Represents the CreateSpatialContext command.
00058 /// </param>
00059 /// <param name="FdoCommandType_DestroySpatialContext">
00060 /// Represents the DestroySpatialContext command.
00061 /// </param>
00062 /// <param name="FdoCommandType_GetSpatialContexts">
00063 /// Represents the GetSpatialContexts command.
00064 /// </param>
00065 /// <param name="FdoCommandType_CreateMeasureUnit">
00066 /// Represents the CreateMeasureUnit command.
00067 /// </param>
00068 /// <param name="FdoCommandType_DestroyMeasureUnit">
00069 /// Represents the DestroyMeasureUnit command.
00070 /// </param>
00071 /// <param name="FdoCommandType_GetMeasureUnits">
00072 /// Represents the GetMeasureUnits command.
00073 /// </param>
00074 /// <param name="FdoCommandType_SQLCommand">
00075 /// Represents the SQLCommand command.
00076 /// </param>
00077 /// <param name="FdoCommandType_AcquireLock">
00078 /// Represents the AcquireLock command.
00079 /// </param>
00080 /// <param name="FdoCommandType_GetLockInfo">
00081 /// Represents the GetLockInfo command.
00082 /// </param>
00083 /// <param name="FdoCommandType_GetLockedObjects">
00084 /// Represents the GetLockedObjects command.
00085 /// </param>
00086 /// <param name="FdoCommandType_GetLockOwners">
00087 /// Represents the GetLockOwners command.
00088 /// </param>
00089 /// <param name="FdoCommandType_ReleaseLock">
00090 /// Represents the ReleaseLock command.
00091 /// </param>
00092 /// <param name="FdoCommandType_ActivateLongTransaction">
00093 /// Represents the ActivateLongTransaction command.
00094 /// </param>
00095 /// <param name="FdoCommandType_CommitLongTransaction">
00096 /// Represents the CommitLongTransaction command.
00097 /// </param>
00098 /// <param name="FdoCommandType_CreateLongTransaction">
00099 /// Represents the CreateLongTransaction command.
00100 /// </param>
00101 /// <param name="FdoCommandType_GetLongTransactions">
00102 /// Represents the GetLongTransactions command.
00103 /// </param>
00104 /// <param name="FdoCommandType_FreezeLongTransaction">
00105 /// Represents the FreezeLongTransaction command.
00106 /// </param>
00107 /// <param name="FdoCommandType_RollbackLongTransaction">
00108 /// Represents the RollbackLongTransaction command.
00109 /// </param>
00110 /// <param name="FdoCommandType_ActivateLongTransactionCheckpoint">
00111 /// Represents the ActivateLongTransactionCheckpoint command.
00112 /// </param>
00113 /// <param name="FdoCommandType_CreateLongTransactionCheckpoint">
00114 /// Represents the CreateLongTransactionCheckpoint command.
00115 /// </param>
00116 /// <param name="FdoCommandType_GetLongTransactionCheckpoints">
00117 /// Represents the GetLongTransactionCheckpoints command.
00118 /// </param>
00119 /// <param name="FdoCommandType_RollbackLongTransactionCheckpoint">
00120 /// Represents the RollbackLongTransactionCheckpoint command.
00121 /// </param>
00122 /// <param name="FdoCommandType_ChangeLongTransactionPrivileges">
00123 /// Represents the ChangeLongTransactionPrivileges command.
00124 /// </param>
00125 /// <param name="FdoCommandType_GetLongTransactionPrivileges">
00126 /// Represents the GetLongTransactionPrivileges command.
00127 /// </param>
00128 /// <param name="FdoCommandType_ChangeLongTransactionSet">
00129 /// Represents the ChangeLongTransactionSet command.
00130 /// </param>
00131 /// <param name="FdoCommandType_GetLongTransactionsInSet">
00132 /// Represents the GetLongTransactionsInSet command.
00133 /// </param>
00134 /// <param name="FdoCommandType_FirstProviderCommand">
00135 /// Represents the index of the first provider specific command.
00136 /// </param>
00137 /// <param name="FdoCommandType_SelectAggregates">
00138 /// Represents the SelectAggregate command.
00139 /// </param>
00140 /// <param name="(See Description note)">
00141 /// \note
00142 /// The following parameters are not supported in this release. 
00143 /// They are provided here for informational use only. Autodesk 
00144 /// reserves the right to change the software related to the content herein.
00145 /// </param>
00146 /// <param name="FdoCommandType_NetworkShortestPath">
00147 /// Represents the NetworkShortestPath command (see <b>Note</b>).
00148 /// </param>
00149 /// <param name="FdoCommandType_NetworkAllPaths">
00150 /// Represents the NetworkAllPaths command (see <b>Note</b>).
00151 /// </param>
00152 /// <param name="FdoCommandType_NetworkReachableNodes">
00153 /// Represents the NetworkReachableNodes command (see <b>Note</b>).
00154 /// </param>
00155 /// <param name="FdoCommandType_NetworkReachingNodes">
00156 /// Represents the NetworkReachingNodes command (see <b>Note</b>).
00157 /// </param>
00158 /// <param name="FdoCommandType_NetworkNearestNeighbors">
00159 /// Represents the NetworkNearestNeighbors command (see <b>Note</b>).
00160 /// </param>
00161 /// <param name="FdoCommandType_NetworkWithinCost">
00162 /// Represents the NetworkWithinCost command (see <b>Note</b>).
00163 /// </param>
00164 /// <param name="FdoCommandType_NetworkTSP">
00165 /// Represents the NetworkTSP command (see <b>Note</b>).
00166 /// </param>
00167 /// <param name="FdoCommandType_ActivateTopologyArea">
00168 /// Represents the ActivateTopologyArea command (see <b>Note</b>).
00169 /// </param>
00170 /// <param name="FdoCommandType_DeactivateTopologyArea">
00171 /// Represents the DeactivateTopologyArea command (see <b>Note</b>).
00172 /// </param>
00173 /// <param name="FdoCommandType_ActivateTopologyInCommandResult">
00174 /// Represents the ActivateTopologyInCommandResult command (see <b>Note</b>).
00175 /// </param>
00176 /// <param name="FdoCommandType_DeactivateTopologyInCommandResults">
00177 /// Represents the DeactivateTopologyInCommandResults command (see <b>Note</b>).
00178 /// </param>
00179 /// <param name="FdoCommandType_CreateDataStore">
00180 /// Represents the CreateDataStore command.
00181 /// </param>
00182 /// <param name="FdoCommandType_DestroyDataStore">
00183 /// Represents the DestroyDataStore command.
00184 /// </param>
00185 /// <param name="FdoCommandType_ListDataStores">
00186 /// Represents the ListDataStores command.
00187 /// </param>
00188 
00189 enum FdoCommandType{
00190     /// Represents the Select Command.
00191     FdoCommandType_Select,
00192 
00193     /// Represents the Insert Command.
00194     FdoCommandType_Insert,
00195 
00196     /// Represents the Delete Command.
00197     FdoCommandType_Delete,
00198 
00199     /// Represents the Update Command.
00200     FdoCommandType_Update,
00201 
00202     /// Represents the DescribeSchema Command.
00203     FdoCommandType_DescribeSchema,
00204 
00205     /// Represents the DescribeSchemaMapping Command.
00206     FdoCommandType_DescribeSchemaMapping,
00207 
00208     /// Represents the ApplySchema command.
00209     FdoCommandType_ApplySchema,
00210 
00211     /// Represents the DestroySchema command.
00212     FdoCommandType_DestroySchema,
00213 
00214     /// Represents the ActivateSpatialContext command.
00215     FdoCommandType_ActivateSpatialContext,
00216 
00217     /// Represents the CreateSpatialContext command.
00218     FdoCommandType_CreateSpatialContext,
00219 
00220     /// Represents the DestroySpatialContext command.
00221     FdoCommandType_DestroySpatialContext,
00222 
00223     /// Represents the GetSpatialContexts command.
00224     FdoCommandType_GetSpatialContexts,
00225 
00226     /// Represents the CreateMeasureUnit command.
00227     FdoCommandType_CreateMeasureUnit,
00228 
00229     /// Represents the DestroyMeasureUnit command.
00230     FdoCommandType_DestroyMeasureUnit,
00231 
00232     /// Represents the GetMeasureUnits command.
00233     FdoCommandType_GetMeasureUnits,
00234 
00235     /// Represents the SQLCommand command.
00236     FdoCommandType_SQLCommand,
00237 
00238     /// Represents the AcquireLock command.
00239     FdoCommandType_AcquireLock,
00240 
00241     /// Represents the GetLockInfo command.
00242     FdoCommandType_GetLockInfo,
00243 
00244     /// Represents the GetLockedObjects command.
00245     FdoCommandType_GetLockedObjects,
00246 
00247     /// Represents the GetLockOwners command.
00248     FdoCommandType_GetLockOwners,
00249 
00250     /// Represents the ReleaseLock command.
00251     FdoCommandType_ReleaseLock,
00252 
00253     /// Represents the ActivateLongTransaction command.
00254     FdoCommandType_ActivateLongTransaction,
00255 
00256     /// Represents the DeactivateLongTransaction command.
00257     FdoCommandType_DeactivateLongTransaction,
00258 
00259     /// Represents the CommitLongTransaction command.
00260     FdoCommandType_CommitLongTransaction,
00261 
00262     /// Represents the CreateLongTransaction command.
00263     FdoCommandType_CreateLongTransaction,
00264 
00265     /// Represents the GetLongTransactions command.
00266     FdoCommandType_GetLongTransactions,
00267 
00268     /// Represents the FreezeLongTransaction command.
00269     FdoCommandType_FreezeLongTransaction,
00270 
00271     /// Represents the RollbackLongTransaction command.
00272     FdoCommandType_RollbackLongTransaction,
00273 
00274     /// Represents the ActivateLongTransactionCheckpoint command.
00275     FdoCommandType_ActivateLongTransactionCheckpoint,
00276 
00277     /// Represents the CreateLongTransactionCheckpoint command.
00278     FdoCommandType_CreateLongTransactionCheckpoint,
00279 
00280     /// Represents the GetLongTransactionCheckpoints command.
00281     FdoCommandType_GetLongTransactionCheckpoints,
00282 
00283     /// Represents the RollbackLongTransactionCheckpoint command.
00284     FdoCommandType_RollbackLongTransactionCheckpoint,
00285 
00286     /// Represents the ChangeLongTransactionPrivileges command.
00287     FdoCommandType_ChangeLongTransactionPrivileges,
00288 
00289     /// Represents the GetLongTransactionPrivileges command.
00290     FdoCommandType_GetLongTransactionPrivileges,
00291 
00292     /// Represents the ChangeLongTransactionSet command.
00293     FdoCommandType_ChangeLongTransactionSet,
00294 
00295     /// Represents the GetLongTransactionsInSet command.
00296     FdoCommandType_GetLongTransactionsInSet,
00297 
00298     /// Represents the NetworkShortestPath command.
00299     FdoCommandType_NetworkShortestPath,
00300 
00301     /// Represents the NetworkAllPaths command.
00302     FdoCommandType_NetworkAllPaths,
00303 
00304     /// Represents the NetworkReachableNodes command.
00305     FdoCommandType_NetworkReachableNodes,
00306 
00307     /// Represents the NetworkReachingNodes command.
00308     FdoCommandType_NetworkReachingNodes,
00309 
00310     /// Represents the NetworkNearestNeighbors command.
00311     FdoCommandType_NetworkNearestNeighbors,
00312 
00313     /// Represents the NetworkWithinCost command.
00314     FdoCommandType_NetworkWithinCost,
00315 
00316     /// Represents the NetworkTSP command.
00317     FdoCommandType_NetworkTSP,
00318 
00319     /// Represents the ActivateTopologyArea command.
00320     FdoCommandType_ActivateTopologyArea,
00321 
00322     /// Represents the DeactivateTopologyArea command.
00323     FdoCommandType_DeactivateTopologyArea,
00324 
00325     /// Represents the ActivateTopologyInCommandResult command.
00326     FdoCommandType_ActivateTopologyInCommandResult,
00327 
00328     /// Represents the DeactivateTopologyInCommandResults command.
00329     FdoCommandType_DeactivateTopologyInCommandResults,
00330 
00331     /// Represents the SelectAggregates command.
00332     FdoCommandType_SelectAggregates,
00333 
00334     /// Represents the CreateDataStore command.
00335     FdoCommandType_CreateDataStore,
00336 
00337     /// Represents the DestroyDataStore command.
00338     FdoCommandType_DestroyDataStore,
00339 
00340     /// Represents the ListDatastores command
00341     FdoCommandType_ListDataStores,
00342 
00343     /// Represents the index of the first provider specific command.
00344     FdoCommandType_FirstProviderCommand
00345 
00346 };
00347 
00348 
00349 #endif
00350 
00351 

Comments or suggestions? Send us feedback.