DMObjectsFinder Class

In This Topic

This class allows you to search the Project. It defines a set of methods for retrieving different API objects. If you want the result objects to match one or more conditions, you should use filters.

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.DMObjectsFinder

Syntax

C#
C++/CLI

public class DMObjectsFinder

public ref class DMObjectsFinder

Remarks

List of Function3D classes with their corresponding FunctionCategories:
Area - AreaDefinition
BusBar - CabMechBusBar
Duct - CabMechConduit
MountingRail - CabMechBodyAccessoryInside
BusBarSystem - CabVirtBusbarsystem
Cabinet - CabMechCabinet
Component - ArticlePlacement, CabMechHousing, CabMechSystemAccessory
CopperBundle - CabVirtCopperbundle
Drilling - CabVirtNC
InstallationSpace - AreaDefinition
MountingPanel - CabMechHousing
RoutingAccessory - CabMechRoutingAccessory
RoutingSegment - Routing
RoutingSpline - Routing

Example

The following example shows how to search a project using the DMObjectsFinder class and how to filter your search results:

Project myProject = m_oProject; // A valid project
Page myPage = myProject.Pages[0]; // A valid Page object

DMObjectsFinder objFinder = new DMObjectsFinder(myProject);

// Get all functions in the myProject Project
Function[] functions = objFinder.GetFunctions(null);

// Use a filter to get only functions with category 'Motor'
FunctionsFilter myFunctionsFilter = new FunctionsFilter();
myFunctionsFilter.FunctionCategory = Eplan.EplApi.Base.Enums.FunctionCategory.Motor;
myFunctionsFilter.Page = myPage;

// Place all functions with category 'Motor' on page myPage
functions = objFinder.GetFunctions(myFunctionsFilter);

Public Constructors

	Name	Description
	DMObjectsFinder Constructor	Overloaded.

Top

Public Methods

	Name	Description
	Dispose	Destructor
	GetAll<T>
	GetArticleReferences	Returns ArticleReferences matching given filter.
	GetArticleReferencesWithCF	Returns ArticleReferences matching given filter.
	GetArticleReferencesWithFilterScheme	Returns ArticleReferences matching given filter from bill of materials-navigator.
	GetBoxedDevices	Returns BoxedDevices matching given filter.
	GetBoxedDevicesWithCF	Returns BoxedDevices matching given filter.
	GetCablesWithFilterScheme	Returns Eplan.EplApi.DataModel.EObjects.Cables and shieldings (Functions with category Shielding) matching given filter from cables-navigator.
	GetConnections	Returns Connections matching given filter. If null parameter is passed, all the project's connection objects are returned. Note: In case no filter used, number of objects returned may be bigger than the number of connections visible in the GUI's connection navigator. The GUI's connection navigator by default shows connections of the following placement types only: - Circuit - CircuitSingleLine - Overview - PairCrossReference - ProcessAndInstrumentationDiagram - PanelLayout
	GetConnectionsWithCF	Returns Connections matching given filter.
	GetConnectionsWithFilterScheme	Returns Connections matching given filter from connections-navigator.
	GetFunctions	Overloaded. Returns Functions matching given filter. If "bWithConnectionDefinitionPoints" is true, returns ConnectionDefinitionPoints matching given filter, too.
	GetFunctions3D	Returns Eplan.EplApi.DataModel.E3D.Function3Ds matching given filter.
	GetFunctionsWithCF	Returns Functions matching given custom filter.
	GetFunctionsWithFilterScheme	Returns Function matching given filter from devices-navigator.
	GetHarnesses	Returns Eplan.EplApi.DataModel.EObjects.Harnesses matching given filter.
	GetHarnessesWithCF	Returns Eplan.EplApi.DataModel.EObjects.Harnesses matching given filter.
	GetHarnessesWithFilterScheme	Returns Eplan.EplApi.DataModel.EObjects.Harnesses matching given filter from wire harness navigator.
	GetInterruptionPoints	Returns Functions matching given filter.
	GetInterruptionPointsWithCF	Returns Functions matching given custom filter.
	GetInterruptionPointsWithFilterScheme	Returns InterruptionPoints matching given filter from interruptionpoints-navigator.
	GetNetDefinitionPoints	This function takes objects of class NetDefinitionPoint and filters them with the given filter.
	GetObjectsFromNavigatorList	Returns all items from the list tab of a navigator.
	GetOptionObjectsWithFilterScheme	Returns Options matching given filter from project-options-navigator.
	GetPages	Returns Pages matching given filter.
	GetPagesWithCF	Returns Pages matching given filter.
	GetPagesWithFilterScheme	\Returns Pages matching given filter from pages-navigator(user settings) or if such doesn't exist filter with use of project settings is created. There can be different results when using page filter now and in 1.9 version. For further information please look in P8 help chapter concerning page filter.
	GetPlaceHolders3D	Returns all Eplan.EplApi.DataModel.E3D.PlaceHolder3D from project.
	GetPlaceholdersWithFilterScheme	Returns Eplan.EplApi.DataModel.Graphics.PlaceHolders matching given filter from placeholders-navigator.
	GetPlacements	This function takes objects of classes Placement and inherited from Placement except Page and filters them with the given filter. This method does not return embedded objects (like for example Eplan.EplApi.DataModel.Graphics.Shielding). This method does not return Eplan.EplApi.DataModel.Graphics.PropertyPlacement.
	GetPlacements3D	Returns Eplan.EplApi.DataModel.E3D.Placement3Ds matching given filter.
	GetPlacementsWithCF	Returns all objects of classes Placement and inherited from Placement, except Page, which matches to given filter.
	GetPlanningSegments	Returns Eplan.EplApi.DataModel.Planning.PlanningSegment matching the given filter.
	GetPlanningSegmentsWithFilterScheme	Returns Eplan.EplApi.DataModel.Planning.PlanningSegment matching the given filter.
	GetPLCs	Returns Eplan.EplApi.DataModel.EObjects.PLCs matching given filter.
	GetPLCsWithCF	Returns Eplan.EplApi.DataModel.EObjects.PLCs matching given filter.
	GetPLCsWithFilterScheme	Returns Functions matching given filter from plc-navigator.
	GetPLCTerminalsWithFilterScheme	Returns Eplan.EplApi.DataModel.EObjects.Terminal matching the given filter from PLC navigator.
	GetPlugs	Returns Eplan.EplApi.DataModel.EObjects.Plugs matching given filter.
	GetPlugStrips	Returns Eplan.EplApi.DataModel.EObjects.PlugStrips matching given filter.
	GetPlugStripsWithCF	Returns Eplan.EplApi.DataModel.EObjects.PlugStrips matching given filter.
	GetPlugStripsWithFilterScheme	Returns Eplan.EplApi.DataModel.EObjects.PlugStrips matching given filter from plugs-navigator.
	GetPlugsWithCF	Returns Eplan.EplApi.DataModel.EObjects.Plugs matching given filter.
	GetPlugsWithFilterScheme	Returns Eplan.EplApi.DataModel.EObjects.Plugs matching given filter from plugs-navigator.
	GetPotentialDefinitionsWithFilterScheme	Returns PotentialDefinitions matching given filter from potentials-navigator.
	GetSegmentDefinitions	Returns Eplan.EplApi.DataModel.Planning.SegmentDefinition matching the given filter.
	GetSegmentPlacements	Returns Eplan.EplApi.DataModel.Planning.PlanningSegment matching the given filter.
	GetSegmentTemplates	Returns Eplan.EplApi.DataModel.Planning.SegmentTemplate matching the given filter.
	GetSegmentTemplatesWithFilterScheme	Returns Eplan.EplApi.DataModel.Planning.SegmentTemplate matching the given filter.
	GetStorableObjects	Overloaded. This function takes all objects of classes StorableObject and inherited from StorableObject except Page and filters them with the given filter. This method does not return Eplan.EplApi.DataModel.Graphics.PropertyPlacement and Eplan.EplApi.DataModel.MasterData.Symbol.
	GetStorableObjectsWithCF	Returns all objects of classes StorableObject and inherited from StorableObject, except Page, which matches to given filter.
	GetSymbolsWithFilterScheme	Returns Eplan.EplApi.DataModel.MasterData.Symbols matching given filter from symbols-navigator.
	GetTerminals	Returns Eplan.EplApi.DataModel.EObjects.Terminal matching given filter.
	GetTerminalStrips	Returns Eplan.EplApi.DataModel.EObjects.TerminalStrips matching given filter.
	GetTerminalStripsWithCF	Returns Eplan.EplApi.DataModel.EObjects.TerminalStrips matching given filter.
	GetTerminalStripsWithFilterScheme	Returns Eplan.EplApi.DataModel.EObjects.TerminalStrip matching given filter from terminals-navigator.
	GetTerminalsWithCF	Returns Eplan.EplApi.DataModel.EObjects.Terminals matching given filter.
	GetTerminalsWithFilterScheme	Returns Eplan.EplApi.DataModel.EObjects.Terminal matching given filter from the terminals navigator.
	Initialize	Sets the project used. The same as project parameter in the constructor. Used when accessing API registered as COM.

Top

Reference

DMObjectsFinder Members
Eplan.EplApi.DataModel Namespace
FunctionsFilter Class
PagesFilter Class
ConnectionsFilter Class
PlacementsFilter Class

Send Feedback