Reclaiming memory of erased objects

eachy

Reclaiming memory of erased objects                                                                                                        By Balaji Ramamoorthy
In AutoCAD, when an object is erased, it is marked as "erased" and the memory is not reclaimed until AutoCAD is closed. It is sometimes necessary to reclaim the memory  of such erased objects without having to close AutoCAD, especially when large number of entities are being created and erased.
Please note that reclaiming the memory shoud not be used unless you absolutely need to. Also, please refer to the ObjectARX documentation regarding its usage.
Here is a sample to that uses the "Database.ReclaimMemoryFromErasedObjects" to reclaim the memory. As explained in the ObjectARX documentation, in some scenarios, AutoCAD may not be able to reclaim memory of erased objects. To check if the reclaim was successful, a simple test is to try and open the reclaimed object. If the object was actually reclaimed, AutoCAD throws a "Autodesk.AutoCAD.Runtime.Exception" with the ErrorStatus set to "ErrorStatus.PermanentlyErased".
Here is a sample code. To try this, first run the "SetupHeavyModel" command that creates about 5000 spheres at random locations. These spheres can be erased and the memory reclaimed using the "CleanDb" command. Just to ensure that this code does not stall your system, I suggest changing the number of entities to a smaller number (say 200) and then increase it if you do not see a visually detectable amount of memory getting allocated in the system resource monitor.

1. [CommandMethod("SetupHeavyModel")]
   
2. static public void SetupHeavyModel()
   
3. {
   
4.     Document document =
   
5.             Application.DocumentManager.MdiActiveDocument;
   
6.     Editor editor = document.Editor;
   
7.     Database db = document.Database;
   
8.     using (Transaction tr
   
9.         = document.TransactionManager.StartTransaction())
   
10.     {
    
11.         BlockTable bt = tr.GetObject(
    
12.                                         db.BlockTableId,
    
13.                                         OpenMode.ForRead
    
14.                                     ) as BlockTable;
    
15.         BlockTableRecord btr
    
16.                         = tr.GetObject(
    
17.                                         db.CurrentSpaceId,
    
18.                                         OpenMode.ForWrite
    
19.                                     ) as BlockTableRecord;
    
20. 
    
21.         for (int cnt = 0; cnt < 5000; cnt++)
    
22.         {
    
23.             Solid3d sphere = new Solid3d();
    
24.             sphere.SetDatabaseDefaults();
    
25.             Random randomGen = new Random(cnt + 1);
    
26.             double radius = randomGen.NextDouble() * 50.0;
    
27.             sphere.CreateSphere(radius);
    
28.             Matrix3d randomMover;
    
29.             double xVec = randomGen.NextDouble() * 800;
    
30.             double yVec = randomGen.NextDouble() * 700;
    
31.             double zVec = randomGen.NextDouble() * 600;
    
32.             randomMover
    
33.                 = Matrix3d.Displacement(
    
34.                                 new Vector3d(
    
35.                                                 xVec,
    
36.                                                 yVec,
    
37.                                                 zVec
    
38.                                             )
    
39.                                        );
    
40.             sphere.TransformBy(randomMover);
    
41.             btr.AppendEntity(sphere);
    
42.             tr.AddNewlyCreatedDBObject(sphere, true);
    
43.         }
    
44.         tr.Commit();
    
45.     }
    
46. }
    
47. 
    
48. [CommandMethod("CleanDb")]
    
49. static public void CleanupDbMethod()
    
50. {
    
51.    Document document =
    
52.             Application.DocumentManager.MdiActiveDocument;
    
53.     Editor editor = document.Editor;
    
54.     Database db = document.Database;
    
55.     using (ObjectIdCollection erased = new ObjectIdCollection())
    
56.     {
    
57.         using (Transaction tr
    
58.                 = document.TransactionManager.StartTransaction())
    
59.         {
    
60.             BlockTable bt = tr.GetObject(
    
61.                                             db.BlockTableId,
    
62.                                             OpenMode.ForRead
    
63.                                         ) as BlockTable;
    
64.             BlockTableRecord btr = tr.GetObject
    
65.                                         (
    
66.                                             db.CurrentSpaceId,
    
67.                                             OpenMode.ForRead
    
68.                                         ) as BlockTableRecord;
    
69.             foreach(ObjectId oid in btr)
    
70.             {
    
71.                 Entity ent = tr.GetObject(
    
72.                                             oid,
    
73.                                             OpenMode.ForWrite
    
74.                                          ) as Entity;
    
75.                 if (ent != null)
    
76.                 {
    
77.                     ent.Erase(true);
    
78.                     erased.Add(oid);
    
79.                 }
    
80.             }
    
81.             tr.Commit();
    
82.         }
    
83.         db.ReclaimMemoryFromErasedObjects(erased);
    
84.         //// Test for reclaimed objects
    
85.         //using (Transaction tr
    
86.         //        = document.TransactionManager.StartTransaction())
    
87.         //{
    
88.         //    foreach (ObjectId oid in erased)
    
89.         //    {
    
90.         //        try
    
91.         //        {
    
92.         //            Entity ent = tr.GetObject
    
93.         //                            (
    
94.         //                                oid,
    
95.         //                                OpenMode.ForRead
    
96.         //                            ) as Entity;
    
97.         //        }
    
98.         //        catch (Autodesk.AutoCAD.Runtime.Exception ex)
    
99.         //        {
    
100.         //            if (ex.ErrorStatus !=
     
101.         //                        ErrorStatus.PermanentlyErased)
     
102.         //            {
     
103.         //                editor.WriteMessage
     
104.         //                    (
     
105.         //                        "Not permanently erased !!"
     
106.         //                    );
     
107.         //            }
     
108.         //        }
     
109.         //    }
     
110.         //    tr.Commit();
     
111.         //}
     
112.         erased.Clear();
     
113.     }
     
114. }
     

[CommandMethod("SetupHeavyModel")]<br /> static public void SetupHeavyModel()<br /> {<br />     Document document =<br />             Application.DocumentManager.MdiActiveDocument;<br />     Editor editor = document.Editor;<br />     Database db = document.Database;<br />     using (Transaction tr<br />         = document.TransactionManager.StartTransaction())<br />     {<br />         BlockTable bt = tr.GetObject(<br />                                         db.BlockTableId,<br />                                         OpenMode.ForRead<br />                                     ) as BlockTable;<br />         BlockTableRecord btr<br />                         = tr.GetObject(<br />                                         db.CurrentSpaceId,<br />                                         OpenMode.ForWrite<br />                                     ) as BlockTableRecord;<br /> <br />         for (int cnt = 0; cnt < 5000; cnt++)<br />         {<br />             Solid3d sphere = new Solid3d();<br />             sphere.SetDatabaseDefaults();<br />             Random randomGen = new Random(cnt + 1);<br />             double radius = randomGen.NextDouble() * 50.0;<br />             sphere.CreateSphere(radius);<br />             Matrix3d randomMover;<br />             double xVec = randomGen.NextDouble() * 800;<br />             double yVec = randomGen.NextDouble() * 700;<br />             double zVec = randomGen.NextDouble() * 600;<br />             randomMover<br />                 = Matrix3d.Displacement(<br />                                 new Vector3d(<br />                                                 xVec,<br />                                                 yVec,<br />                                                 zVec<br />                                             )<br />                                        );<br />             sphere.TransformBy(randomMover);<br />             btr.AppendEntity(sphere);<br />             tr.AddNewlyCreatedDBObject(sphere, true);<br />         }<br />         tr.Commit();<br />     }<br /> }<br /> <br /> [CommandMethod("CleanDb")]<br /> static public void CleanupDbMethod()<br /> {<br />    Document document =<br />             Application.DocumentManager.MdiActiveDocument;<br />     Editor editor = document.Editor;<br />     Database db = document.Database;<br />     using (ObjectIdCollection erased = new ObjectIdCollection())<br />     {<br />         using (Transaction tr<br />                 = document.TransactionManager.StartTransaction())<br />         {<br />             BlockTable bt = tr.GetObject(<br />                                             db.BlockTableId,<br />                                             OpenMode.ForRead<br />                                         ) as BlockTable;<br />             BlockTableRecord btr = tr.GetObject<br />                                         (<br />                                             db.CurrentSpaceId,<br />                                             OpenMode.ForRead<br />                                         ) as BlockTableRecord;<br />             foreach(ObjectId oid in btr)<br />             {<br />                 Entity ent = tr.GetObject(<br />                                             oid,<br />                                             OpenMode.ForWrite<br />                                          ) as Entity;<br />                 if (ent != null)<br />                 {<br />                     ent.Erase(true);<br />                     erased.Add(oid);<br />                 }<br />             }<br />             tr.Commit();<br />         }<br />         db.ReclaimMemoryFromErasedObjects(erased);<br />         //// Test for reclaimed objects<br />         //using (Transaction tr<br />         //        = document.TransactionManager.StartTransaction())<br />         //{<br />         //    foreach (ObjectId oid in erased)<br />         //    {<br />         //        try<br />         //        {<br />         //            Entity ent = tr.GetObject<br />         //                            (<br />         //                                oid,<br />         //                                OpenMode.ForRead<br />         //                            ) as Entity;<br />         //        }<br />         //        catch (Autodesk.AutoCAD.Runtime.Exception ex)<br />         //        {<br />         //            if (ex.ErrorStatus !=<br />         //                        ErrorStatus.PermanentlyErased)<br />         //            {<br />         //                editor.WriteMessage<br />         //                    (<br />         //                        "Not permanently erased !!"<br />         //                    );<br />         //            }<br />         //        }<br />         //    }<br />         //    tr.Commit();<br />         //}<br />         erased.Clear();<br />     }<br /> }<br />