Command Method: Static Or Not Static

csharp

Command Method: Static Or Not Static

When starting to use AutoCAD .NET API, the very first code people would be writing is the the command method in a class, e.g. a public method decorated with [CommandMethod()] attribute. However, the command method can be either "static/Shared" (C#/VB.NET) or not "static/Shared" (instance method). Also, in most smaple code one can find, there is rarely one that show the class' constructor is used.


It also puzzles some beginners if the command method is not a "static" one: why an instance method (non-static method) can be called in command without the code creating an object instance of the class?


Here is what the AutoCAD .NET API document has to say:

For an instance command method, the method's enclosing type is instantiated separately for each open document. This means that each document gets a private copy of the command's instance data. Thus there is no danger of overwriting document-specific data when the user switches documents. If an instance method needs to share data globally, it can do so by declaring static or Shared member variables.
For a static command method, the managed wrapper runtime module does not need to instantiate the enclosing type. A single copy of the method's data is used, regardless of the document context. Static commands normally do not use per-document data and do not require special consideration for MDI mode.

  
With a few lines of very simple code, we can see what the difference betweem static method and instance command method.
  
Here is the code:

2. 
   
3. using Autodesk.AutoCAD.ApplicationServices;
   
4. using Autodesk.AutoCAD.Runtime;
   
5. namespace CommandClassTest
   
6. {
   
7.     public class MyCommand
   
8.     {
   
9.         private static int _staticCount = 0;
   
10.         private int _instanceCount = 0;
    
11.         public MyCommand()
    
12.         {
    
13.             Document dwg = Application.DocumentManager.MdiActiveDocument;
    
14.             dwg.Editor.WriteMessage("\n**************");
    
15.             dwg.Editor.WriteMessage("\nConstructing...");
    
16.             dwg.Editor.WriteMessage("\n**************");
    
17.         }
    
18.         [CommandMethod("StaticCommand", CommandFlags.Session)]
    
19.         public static void RunThisMethod1()
    
20.         {
    
21.             _staticCount++;
    
22.             Document dwg = Application.DocumentManager.MdiActiveDocument;
    
23.             dwg.Editor.WriteMessage("\n----------------------------");
    
24.             dwg.Editor.WriteMessage("\n" + dwg.Name);
    
25.             dwg.Editor.WriteMessage("\nStatic command executed.");
    
26.             dwg.Editor.WriteMessage("\nStatic command count: {0}", _staticCount);
    
27.         }
    
28.         [CommandMethod("InstanceCommand", CommandFlags.Session)]
    
29.         public void RunThisMethod2()
    
30.         {
    
31.             _instanceCount++;
    
32.             Document dwg = Application.DocumentManager.MdiActiveDocument;
    
33.             dwg.Editor.WriteMessage("\n----------------------------");
    
34.             dwg.Editor.WriteMessage("\n" + dwg.Name);
    
35.             dwg.Editor.WriteMessage("\nInstance command executed.");
    
36.             dwg.Editor.WriteMessage("\nInstance command count: {0}", _instanceCount);
    
37.         }
    
38.     }
    
39. }

<br /> using Autodesk.AutoCAD.ApplicationServices;<br /> using Autodesk.AutoCAD.Runtime;<br /> namespace CommandClassTest<br /> {<br />     public class MyCommand<br />     {<br />         private static int _staticCount = 0;<br />         private int _instanceCount = 0;<br />         public MyCommand()<br />         {<br />             Document dwg = Application.DocumentManager.MdiActiveDocument;<br />             dwg.Editor.WriteMessage("\n**************");<br />             dwg.Editor.WriteMessage("\nConstructing...");<br />             dwg.Editor.WriteMessage("\n**************");<br />         }<br />         [CommandMethod("StaticCommand", CommandFlags.Session)]<br />         public static void RunThisMethod1()<br />         {<br />             _staticCount++;<br />             Document dwg = Application.DocumentManager.MdiActiveDocument;<br />             dwg.Editor.WriteMessage("\n----------------------------");<br />             dwg.Editor.WriteMessage("\n" + dwg.Name);<br />             dwg.Editor.WriteMessage("\nStatic command executed.");<br />             dwg.Editor.WriteMessage("\nStatic command count: {0}", _staticCount);<br />         }<br />         [CommandMethod("InstanceCommand", CommandFlags.Session)]<br />         public void RunThisMethod2()<br />         {<br />             _instanceCount++;<br />             Document dwg = Application.DocumentManager.MdiActiveDocument;<br />             dwg.Editor.WriteMessage("\n----------------------------");<br />             dwg.Editor.WriteMessage("\n" + dwg.Name);<br />             dwg.Editor.WriteMessage("\nInstance command executed.");<br />             dwg.Editor.WriteMessage("\nInstance command count: {0}", _instanceCount);<br />         }<br />     }<br /> }

1. Start AutoCAD and "NETLOAD" to DLL;
2. With current drawing "Drawing1.dwg", enter command "InstanceCommand", the command line shows:

Command: instancecommand

**************
Constructing...
**************
----------------------------
Drawing1.dwg
Instance command executed.
Instance command count: 1

As you can see, the class' constructor is called due to the instance (non-static) command method.

3. Now, run "InstanceCommand" command again with "Drawing1.dwg". We now can guess that the constructor of the class will not run again since the class instance has already been created with this drawing (Drawing1.dwg), and the count for instance command will increment to 2. Here is the command line response, as expected:

Command: instancecommand
-------------------------------
Drawing1.dwg
Instance command executed.
Instance command count: 2

4. Let's run the static command. The command line shows:
   
Command: staticcommand
--------------------------
Drawing1.dwg
Static command executed.
Static command count: 1
   
5. Now, open a new drawing in AutoCAD: Drawing2.dwg.
6. Run the static command. we would expect the static command count to increment to 2, like this:
   
Command: staticcommand

--------------------------
Drawing2.dwg
Static command executed.
Static command count: 2

7. Run instance command in Drawing2.dwg. the command shows:
   
Command: instancecommand

**************
Constructing...
**************
----------------------------
Drawing2.dwg
Instance command executed.
Instance command count: 1


As we can see, the class' constructor is called again, because the instance command runs in drawing2.dwg the first time.
   
8. Now go back to drawing1.dwg.
9. Run static command. we surely know the static command count will be 3, in spite of drawing switching:
   
Command: staticcommand

--------------------------
Drawing1.dwg
Static command executed.
Static command count: 2

10. Run instance command in drawing1.dwg, expecting that the instance command count in drawing1.dwg will be 3 and no class' constructor is called. Here is command line shows:
   
Command: instancecommand

-------------------------------
Drawing1.dwg
Instance command executed.
Instance command count: 3

Summery:
   
If your class/class method needs to manipulate data/object accross drawings in an AutoCAD session, you use static method and the data/object can be static data/object member of the class. If your static data/object member of the class has to be initialized, you cannot do it in the class' constructor. In this case, you usually delare the static data/object to a default value/null like this:
   
private static int _count=0;
   
or
   
private static MyObject _obj=null;
   
Then, in the static command method, you do:
   
if (_count==0)
{
     //Initialize to other value if necessary
}
//then use the static data accross drawings
   
or
   
if (_obj==null)
{
     _obj=new MyObject(); //instantiate the data object if it hasn't been.
}
//the use the static object accross drawings
   
If the data/object to be manipulated by the class/class method is drawing specific, for example a drawing tracking/index data object, then you can declare the data/object as the class' data/object member (non-static), and initilize it in the class' constructor. You use instance method to manipulate the data/object