Getting Started

• Obtain an Ocean developer license
• Follow the installation instructions of the Ocean SDK

This simple plugin provides a way to fetch the type of a selected data object in the Petrel panes. This is very useful when developing plugins so you can find the matching data objects in Ocean to interact with in more complex plugins.

1. Search for the Ocean Plug-in template

2. Select Ocean Plug-in and click Next

   

3. Give your project a name and click Create

   

1. Give your plugin class a valid name

Recommend providing a unique class name as you may come back later and add more plugins to your solution. The other metadata can be modifed later on in the code.

2. Check Create new module and Register modules in this solution

3. Click Next

   

4. Ensure your new module is checked and click Next

   

5. Provide a unique name for the new module which will contain a new command handler for the code to be executed.

6. Check New Command and provide a unique name for the command handler.

7. Click Next

   

In this step you need to register the command that will be executed when you click on Get Object Type in the context menu

8. Click on the Add new command button to insert a new command under the Commands item.

9. Select the command and update the Id to an appropriate name.

10. Update the Caption so it is more descriptive of the action it will perform, this will be the text shown in the context menu.

11. Click Next

    

12. Click Finish

    

Once your project is created, the Solution Explorer should look something like this:

1. Open the Module class and under the IntegratePresentation method, register the context menu item like so:

   SimpleCommandContextMenuHandler<object> otHandler = new SimpleCommandContextMenuHandler<object>(new CommandItem(ObjectTypeCommandHandler.ID));
   PetrelSystem.ToolService.AddCommandContextMenuHandler(otHandler);

   

2. Open the CommandHandler class and implement the logic that will run when the user clicks on the Get Object Type item in the context menu.

   This will loop through the selected objects in the data trees and print the type to the message log in Petrel.

   foreach (object obj in context.GetSelectedObjects<object>())
   {
       PetrelLogger.InfoOutputWindow("Object type: " + obj.GetType().ToString());
   }

   

3. Then you can build the project, and if all goes well the plugin will be created and added to Petrel automatically.

4. Launch Petrel and test the plugin

You have successfully created your first plugin!