Cross-product Development with ArcGIS. Allan Laframboise

Transcription

1 Cross-product Development with ArcGIS Allan Laframboise

2 Overview ArcObjects architecture ArcObjects APIs Performance Extending ArcObjects Development and design patterns Desktop Engine Server

3 Introduction Who am I? Who are you? What is your experience Developing with ArcGIS Desktop, Engine and Server Programming VBA/VB 6.0, VC++,.NET and Java Windows and Unix/Linux Desktop, web and database

4 ArcGIS and ArcObjects ArcGIS is built on software components called ArcObjects ESRI uses ArcObjects to develop the software and applications Developers use ArcObjects to customize the software and build custom applications ArcObjects is the core of ArcGIS

5 ArcGIS products share ArcObjects ArcGIS Desktop ArcGIS Engine ArcGIS Server

6 ArcGIS library architecture ArcGIS Engine

7 ArcObjects APIs ArcObjects components are C++ objects Accessible through different APIs COM,.NET, Java and C++ Native interface is COM

8 Design Pattern I: Use the right ArcObjects API Application performance is directly related to the API implemented Performance is dependent upon the number of fine-grained calls you make to ArcObjects Decision depends on Operating system Functionality desired Deployment model Legacy systems

9 Example of using the ArcObjects APIs Quick test VBA vs VB 6.0 vs VC++ vs.net vs Java And the winner is

10 ArcObjects APIs and interop Process of reallocating data in memory so that it can be access by the native language Required because data types are represented differently in different languages Underlying data is managed differently for each language sub-system system

11 Design Pattern II: Use coarse-grained ArcObjects General rule is to use as many of the existing coarse-grained objects as possible ArcGIS Engine - controls, commands, tools, utility classes ArcGIS Desktop GPFunctions,, extensions ArcGIS Server - Web controls and utility classes...

12 Examples of coarse-grained ArcObjects Desktop GxDialog loads any data source Engine MapDocument - can read/almost write.lyr. files Server WebMap - converts recordset to.net dataset

13 Design Pattern III: Build your own coarse- grained objects The ArcGIS system can be extended by building custom COM components Encapsulates business logic By-passes fine-grained calls to ArcObjects Design concept is already being implemented! ESRI developers External developers

14 How do you build a coarse-grained object? Steps 1. Create a COM project 2. Create a COM class 3. Reference the ArcGIS libraries 4. Compile MyCOMLibrary IUnknown IMyInterface MyCOMClass * Wrapper generation required for.net and Java

15 Generating native wrapper classes Process of creating native classes that call into non-native native code.net simply reference COM library or tlbimp.exe Java JIntegra offers a COM2Java utility Take advantage of high performance components MyNativeWrapperClass (.NET/Java) MyNativeClient MyCOMLibrary IUnknown (.NET/Java) IMyInterface MyCOMClass

16 Design Pattern IV: Extending ArcObjects Virtually every part of the system is extendable Desktop Commands, tools, toolbars, menus, extensions, geodatabase extensions, editor extensions, windows Engine Most of the above minus application-specific items Server Some of the above and all of the Web ADF extensions

17 How do you extend ArcObjects? Build custom COM components Steps 1. Create a COM project 2. Create a COM class 3. Reference the ArcGIS libraries 4. Implement an ArcGIS interface 5. Compile 6. Register in a component category esricontrolcommands ICommand mylibrary IUnknown ControlsMap ZoominTool IUnknown ICommand MyZoomClass

18 Example of custom ArcObjects components IUnknown IUnknown ICommand ITool AddBarrier IUnknown ICommand ITool AddStop ICommand ITool SolveRoute IUnknown IExtension IExtensionConfig IEvactuationExtension Evacuation Extension IUnknown IDockableWindowDef Dockable Window ICommand ITool Clean

19 Extending ArcGIS Desktop Applications support custom framework components Applications load components at runtime Extensions are loaded before all other framework components IUnknown IExtension IExtensionConfig IEvactuationExtension Evacuation Extension

20 ArcObjects extension component Public properties string ActiveFloor IArray Impedances string Impedance IArray Solvers string Solver bool UseRestrictions IArray Restrictions int Seconds bool Initialized IUnknown IExtension IExtensionConfig IEvactuationExtension Evacuation Extension

21 ArcObjects extension component Coarse-grained methods void Initalize(IMap map, IScene m_scene, bool support3d); void Unitialize(); void Solve(bool refresh); void Clean(bool refresh); IExtension IExtensionConfig IEvactuationExtension IUnknown Evacuation Extension void SetActiveSolver(string ssolver, bool refresh); void AddStop(int X, int Y, bool sceneactive, bool refresh); void AddBarrier(int X, int Y, bool sceneactive, bool refresh);

22 Implementing custom objects and custom application behavior Extension is loaded Detects the type of application Sink document events Detects if.mxd/.sxd. is loaded Initializes Evacuation object DockableWindow is created Tools and toolbar are created ExtensionManager shows toolbar and tools Command shows dockable window Dockable window gets passed extension Uninitalized when document is closed

23 Extending ArcGIS Engine Use ArcObjects to extend Engine applications Applications can also load custom components and extensions Applications can load custom commands and tools Needs some special implementation

24 Creating and storing a component in ArcGIS Engine private void Form1_Load(object sender, System.EventArgs e) { //Load documents this.map2d.loadmxfile(sexecutionfolder + m_mxd,null,null); this.map3d.loadsxfile(sexecutionfolder + m_sxd); // Create and initialize the extension here m_evacuationext = new EvacuationRoutesTools.EvacuationExtension(); m_evacuationext.initalize(map2d.map, Map3D.Scene, true); // Store the extension in the controls for the commands and tools IMapControl3 mapctrl = Map2D.Object as ESRI.ArcGIS.MapControl.IMapControl3; mapctrl.customproperty = m_evacuationext; } ISceneControl scenectrl = Map3D.Object as ESRI.ArcGIS.SceneControl.ISceneControl; scenectrl.customproperty = m_evacuationext; IExtension IExtensionConfig IEvactuationExtension IUnknown Evacuation Extension

25 Accessing the component in commands public override void OnMouseDown(int Button, int Shift, int X, int i Y) { if (m_hook is IToolbarControl) // Engine { } IToolbarControl ptoolbarcontrol = m_pscenehookhelper.hook as IToolbarControl; ISceneControl mapctrl = ptoolbarcontrol.buddy as ISceneControl; m_evacuationext = mapctrl.customproperty as IEvacuationExtension; n; m_evacuationext.addstop(x, Y, true, false); } else if (m_hook is IMxApplication) // ArcMap { m_evacuationext.addstop(x,y, false, false); } else if (m_hook is ISxApplication) // ArcScene { m_evacuationext.addstop(x,y, true, false); } m_evacuationext.solve(true); ICommand ITool AddStop IUnknown

26 Extending ArcGIS Server Use ArcObjects to extend the behavior of server objects Re-use custom components from the desktop Calls are made remotely Requires web application development IUnknown IExtension IExtensionConfig IEvactuationExtension Evacuation Extension

27 Creating server custom server components Create all objects in the context of the server Call coarse grained functions Release object when you are done (if pooled)

28 Web application calling a custom component ASP.NET client has a proxy to the component Invokes calls remotely very fast! Server Object Context ASP.NET Application IUnknown MyNativeWrapperrClass (.NET/Java) MyCOMLibrary IUnknown IMyInterface MyCOMClass IMyInterface MyCOMClass

29 Creating and storing a custom component in ArcGIS Server protected void Page_Load(object sender, System.EventArgs e) { if(!page.ispostback) { //Get the server context IEvacuationExtension ext = null; // IDisposable pattern using (WebMap webmap = Map2D.CreateWebMap()) { //Get extension class IServerContext sc = webmap.servercontext; ext = sc.createobject("evacuationroutestools.evacuationextension") ") as IEvacuationExtension; //Add extension to session state IScene scene = new SceneClass(); ext.initalize(webmap.map, scene, false); Session["m_ext"] = ext;

30 Accessing the custom component in ArcGIS Server public void ServerAction(ToolEventArgs args) { ESRI.ArcGIS.Server.WebControls.Map map = args.control as ESRI.ArcGIS.Server.WebControls.Map; using (WebMap webmap = map.createwebmap()) { //Get the point, this point is converted to map units in AddBarrier webmap.applymapdescriptiontoserver(); PointEventArgs pargs = args as PointEventArgs; System.Drawing.Point pt = pargs.screenpoint; //get the extension from the session IEvacuationExtension ext = args.control.page.session["m_ext"] as IEvacuationExtension; ext.addstop(pt.x,pt.y,false,false); ext.solve(true);

31 Cross-product development summary Use the coarse-grained ArcObjects where possible Implement your own custom components with a high performance language such as C++ Generate wrapper classes to call components from.net and Java Interop is expensive Implement core ArcObjects only and use in all products! Design for the future

32 Session Evaluations Reminder Session Attendees: Please turn in your session evaluations.... Thank you