HasModelParameter

Now reading version 3.1. For the latest, read: HasModelParameter for version 4
Applies to NEXUS Client versions: 2.0, 2.1, 3.0, 3.1 and 3.2

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

Parent page: Library Query Functions - Components

Summary

Returns each component that is linked to (or references) a domain model, containing a parameter object whose Parameter Name and Value properties comply with the Query.

Each component can be linked to models of Footprint, Simulation, PCB3D, Ibis, and Signal Integrity types. It is possible to link a component to more than one model of the same type, but only one model of each type can be selected as a component's Current Model.

Syntax

HasModelParameter(Parameter Name : String,Value : String,CurrentModelOnly : Boolean) : Boolean/Boolean_String

The CurrentModelOnly parameter specifies whether or not the linked model (which contains a compliant parameter) has to be a Current Model of each component. When this is False, the linked model does not have to be a Current Model (but it still can be); when this is True, the linked model does have to be a Current Model.

Example Usage

HasModelParameter('Inductance A','1mH',False)
HasModelParameter('Inductance A','1mH',False) = True
HasModelParameter('Inductance A','1mH',False) = 'True'

Returns all components that are linked to a model that contains a parameter object whose Parameter Name property is Inductance A, and whose Value property is 1mH. That model does not have to be a Current Model of each component (but it can be).

HasModelParameter('Coupling Factor','0.999',True)
HasModelParameter('Coupling Factor','0.999',True) = True
HasModelParameter('Coupling Factor','0.999',True) = 'True'

Returns all components that are linked to a model that contains a parameter object whose Parameter Name property is Coupling Factor, and whose Value property is 0.999. That model must be a Current Model of the component.

Tips

  1. Ensure that the scope of the search is set to Components, using the Search in field in the File Libraries Search dialog.
  2. When searching components, all SchLib and IntLib libraries - available, or along a defined search path - will be interrogated.
  3. All results are listed in the Query Results listing, back in the Components panel.