nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

The Finder (Part 1)

medini_1024169437

The Finder is an essential part of the Scripting API and the basics are well described in the scripting guideline. So this topic outlines a few things that go beyond the official guide.

Function findByType

The findByType function requires a mandatory type as first argument and a bool value strict as second argument. The second is optional. So in most cases you can call the function with just a class from the Metamodel like:

finder.findByType(Metamodel.sysml.SySMLPart);
// same as ...
finder.findByType(Metamodel.sysml.SySMLPart, false);

As you can see, the second arguments defaults to false, meaning the finder will return all direct instances of the given type and all derived types. In most cases this will work for you, however, there are a few use cases where you want to set strict to true.

// just packages
finder.findByType(Metamodel.sysml.SysMLContainerPackage, true);

// packages, but also parts, blocks etc.
finder.findByType(Metamodel.sysml.SysMLContainerPackage, false);

The example shows that a search with a type like container package may return different results, depending on the strict parameter. If you do a strict search you will only find real packages. If the query is not strict, also parts and other elements may be returned because they inherit from SysMLContainerPackage. Check the metamodel guide for inheritance or ask questions in this topic.

Find more posts tagged with

medini

medini legacy

Accepted answers

All comments

medini_1025781457

Hi Jan,

I am wondering if it is normal that I can't use Metamodel types within profiling scripting?

I just even try with the most simple stuff like:

console.log(Metamodel.safetygoals.SafetyGoal);

But I got an error that Metamodel is not defined, however this works within "normal" scripts.

Also I am wondering, it is possible to call a script, that lives within scripts folder, from a profiler script?

medini_1024169437

Hi Miguel,

unfortunately your investigation is correct, the Metamodel singleton and a few more other things are not available when you script profile properties. Same is for "load", it does not work in profiles just because the original script is not loaded from a file and file resolution does not work well.

I am not fully sure for the reason but I will investigate. I know that there are some enhancements planned for this area and I need to check whether we will release something with R19.2

Happy Scripting

Jan

medini_1025781457

Hi Jan,

I tried to use load() to have access to a constructor function I made to create some kind of class and create objects to use the get and set methods I created on the constructor function and it seems to work properly but obviously it needs the script path, so what I am doing is some kind of work-around here by creating a common path for the scripts that we want to call from profiles, so any one at Magna just run a batch file after synchronizing the packages form our control version tool in order to create the path and copy the scripts there.

Obviously the metamodel singleton is not available even with the loaded scripts, however I think that probably it is not necessary to have access to it within the profiles, right? because in that way the functionality there is limited to use the accessible properties instead of having access to everything that could lead to a more difficult approach on qualifying the tool I think, I was just curious of what was accessible from there to know the limitations of profiles so I can plan what will be implemented on our side to cover our needs.

Have a great weekend!

Best Regards.

medini_1024169437

Hi Miguel,

glad that you found a quick solution for the load() issue. Note that we meanwhile improved here and with upcoming R19.2 loading scripts via relative paths in the same project should work(relatives paths are always resolved against "config/scripts" of the project.

Well, the Metamodle singleton is of quite some help, is for example can be used to make sure an element is of a certain type as explained in another article (https://medini.freshdesk.com/support/discussions/topics/1000088905). So I think having it also for profile scripts is of value and we will try to improve here and make it available.

Happy Scripting

Jan

medini_1035403171

Hi Jan,

You once mentioned that it is possible to use regular expressions with findByType(). How is the syntax for that? And does it also work for find()?

Thanks,

Johannes

medini_1024169437

Hi Johannes,

there is some support for regular expressions, however, not for "findByType". Do you have some details on what you want to achieve?

For normal "find" there is some support, however, not for the native JS RegExp but for Java regular expressions:

// no support for native RegExp yet
var n = finder.find("name", /.*Foo.*/);
alert(n.size()); // always 0

// but support for Java RegExp yet
var Pattern = Packages.java.util.regex.Pattern;
var n = finder.find("name", Pattern.compile(".*Foo.*"));
alert(n.size());

Hope that helps

Jan

medini_1035403171

Hi Jan,

Thanks! This is what I was looking for.

> there is some support for regular expressions, however, not for
"findByType". Do you have some details on what you want to achieve?

No, I just had that in my notes. Applying the regex'es for find() makes more sense though :-)

Cheers,

Johannes

medini_1064531972

Hello Team,

I'm trying to write a script which finds a package (contains FTAModels) inside another package using below.

var myFTs = myPrjFinder.find("name", "SoftwareFunction").asArray(); //Package in project

var myFtFinder = Global.getFinder(myFTs[0]); // 0th element in the array

var myFTmodels = myFtFinder.findByType(Metamodel.FTA.FTAModel, false).asArray(); //all FTAs models in the identified package.

The problem I'm facing is that that the string "SoftwareFunction" is found multiple times (System Design, Safety Goals etc.) which results that the required package (which contains FTAs) is not always in the 0th element.

Instead I'm trying to identify the parent package ("Software FTA Models" --> which contains only FTAs) first and then look for my specific package of "SoftwareFunction".

I'm not familiar with scripting at all but trying to play with the code what I already have from the forum based on my need.

Please let me know if I'm not clear.

Regards,

Rakesh S.

medini_1024169437

Rakesh,

maybe somethingk like:

var myPackage = finder.findByType(Metamodel.projectmodel.PJPackage).and("name", "SoftwareFunction").first();

would be a better start. If that still gives you the wrong package try to use filter(9 as well, check the scripting guide for how filter can be used.

Happy Scirpting

Jan