OPC Studio User's Guide and Reference
FilterMappings<TMapping> Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.LiveMapping.Extensions Namespace > AbstractMapperExtension Class : FilterMappings<TMapping> Method
The type of mapping. Only mapping of this type, or its subclasses, will be returned.
The mapper object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

The object being targeted. null for any target.

The value of this parameter can be null (Nothing in Visual Basic).

The operation will be performed only on mappings whose mapping tags satisfy this predicate.

The value of this parameter cannot be null (Nothing in Visual Basic).

true to operate on sub-targets (mapped members of the target) recursively; false otherwise.
Filter the mappings available on the mapper by the given criteria.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function FilterMappings(Of TMapping As Class)( _
   ByVal mapper As AbstractMapper, _
   ByVal targetObject As Object, _
   ByVal mappingTagsPredicate As Predicate(Of IEnumerable(Of String)), _
   ByVal recurse As Boolean _
) As IEnumerable(Of TMapping)
'Usage
 
Dim mapper As AbstractMapper
Dim targetObject As Object
Dim mappingTagsPredicate As Predicate(Of IEnumerable(Of String))
Dim recurse As Boolean
Dim value As IEnumerable(Of TMapping)
 
value = AbstractMapperExtension.FilterMappings(Of TMapping)(mapper, targetObject, mappingTagsPredicate, recurse)
[Extension()]
[NotNull()]
public:
static IEnumerable<TMapping^>^ FilterMappingsgeneric<typename TMapping>
( 
   AbstractMapper^ mapper,
   Object^ targetObject,
   Predicate<IEnumerable<String^>^>^ mappingTagsPredicate,
   bool recurse
) 
where TMapping: ref class

Parameters

mapper
The mapper object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

targetObject
The object being targeted. null for any target.

The value of this parameter can be null (Nothing in Visual Basic).

mappingTagsPredicate
The operation will be performed only on mappings whose mapping tags satisfy this predicate.

The value of this parameter cannot be null (Nothing in Visual Basic).

recurse
true to operate on sub-targets (mapped members of the target) recursively; false otherwise.

Type Parameters

TMapping
The type of mapping. Only mapping of this type, or its subclasses, will be returned.

Return Value

Returns an "enumerable" of mappings that are of given type, fulfill the specified predicate, and belong to the given target object (if specified).

This method never returns null (Nothing in Visual Basic).

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also