| | 1 | = FDO RFC 32 - !GetSpatialContexts cleanup = |
| | 2 | |
| | 3 | This page contains a request for comments document (RFC) for the FDO Open Source project. |
| | 4 | More FDO RFCs can be found on the [wiki:FDORfcs RFCs] page. |
| | 5 | |
| | 6 | == Status == |
| | 7 | |
| | 8 | ||RFC Template Version||(1.0)|| |
| | 9 | ||Submission Date||April 4, 2009|| |
| | 10 | ||Last Modified||Steve Dang [[Timestamp]]|| |
| | 11 | ||Author||Steve Dang|| |
| | 12 | ||RFC Status||draft (draft, proposed, frozen for vote, adopted, retracted, or rejected)|| |
| | 13 | ||Implementation Status||pending (pending, under development, completed)|| |
| | 14 | ||Proposed Milestone||3.5|| |
| | 15 | ||Assigned PSC guide(s)||Orest Halustchak|| |
| | 16 | ||'''Voting History'''||(vote date)|| |
| | 17 | ||+1|| || |
| | 18 | ||+0|| || |
| | 19 | ||-0|| || |
| | 20 | ||-1|| || |
| | 21 | ||no vote|| || |
| | 22 | |
| | 23 | == Overview == |
| | 24 | |
| | 25 | This RFC is to deprecate the Spatial Context active flag that is obsolete and no longer in use by: |
| | 26 | |
| | 27 | * The FdoIGetSpatialContexts derived classes (to retrieve the spatial contexts in the feature source). |
| | 28 | * The FdoISpatialContextReader derived classes (to retrieve the spatial context data). |
| | 29 | |
| | 30 | == Motivation == |
| | 31 | |
| | 32 | * Make the !GetSpatialContexts API consistently reliable across all providers. |
| | 33 | * Clean up legacy code and make existing code more readable. |
| | 34 | |
| | 35 | == Proposed Solution == |
| | 36 | |
| | 37 | * Update existing code to discontinue usages of the obsolete Spatial Context active flag where applicable. |
| | 38 | |
| | 39 | == Implications == |
| | 40 | |
| | 41 | * The following APIs will be deprecated in the future, and therefore, should be avoided to be used: |
| | 42 | |
| | 43 | {{{ |
| | 44 | FDO_API virtual const bool FdoIGetSpatialContexts::GetActiveOnly() = 0; |
| | 45 | |
| | 46 | FDO_API virtual void FdoIGetSpatialContexts::SetActiveOnly(const bool value) = 0; |
| | 47 | |
| | 48 | FDO_API virtual const bool FdoISpatialContextReader::IsActive() = 0; |
| | 49 | }}} |
| | 50 | |
| | 51 | * The documentation will be updated accordingly. |
| | 52 | |
| | 53 | == Test Plan == |
| | 54 | |
| | 55 | * The existing !GetSpatialContexts API should work as before. |
| | 56 | * Existing unit tests should all pass. |
| | 57 | |
| | 58 | == Funding/Resources == |
| | 59 | |
| | 60 | Autodesk |
