Specification for semantic information and CXF

[anandkp92]

• updated specification for including semantic information
• added new page for CXF specification (including classes and properties used in CXF)

[anandkp92]

@mwetter can you take a look at the changes to CDL semantic information and the CXF specification?

[mwetter]

@anandkp92 : Please see inline comments.

[mwetter]

How does this affect the translation from CXF to CDL, if the block is in CDL
Buildings.Controls.OBC.ASHRAE.G36.VentilationZones.ASHRAE62_1.Setpoints?
In CXF, with this convention, this becomes Buildings_Controls_OBC_ASHRAE_G36.VentilationZones_ASHRAE62_1_Setpoints but there is no package 1 and translating it to CDL would give an error and a different structure.

[anandkp92]

So this specification <instanceName>, does not affect CXF.
It only affects the semantic model extracted from a CDL class, and that too only the instance name. The class name, if used in the semantic model, will remain as is, but it's the name of the instance that will be appended with _.

So in your example, if the file structure is

model A
    B controller; 
    ...
end A;

model B
    Buildings.Controls.OBC.ASHRAE.G36.VentilationZones.ASHRAE62_1.Setpoints heaSet
        annotation(__cdl(semantic(metadataLanguage="Brick 1.3 text/turtle" 
                "bldg:<instanceName> a brick:Heating_Septoint .")));
end B;

The semantic model will have the following content:

bldg:controller_heaSet a brick:Heating_Setpoint .

where <instanceName> was replaced by controller_heaSet

[mwetter]

You also need to add in normative text how an assignment is serialized. See https://fmi-standard.org/docs/3.0/ section 2.2.7.1 for the order used to serialize a matrix into a one-dimensional string.

[anandkp92]

I'm a bit unclear about this. In CDL, if someone is assigning values to individual elements of a matrix using indices, such as M[1,2] = a12, in CXF, wouldn't this become M_1_2=a12 anyway?

[mwetter]

You write that the expressions are preserved. In other parts you also write that aa.bb is converted to aa_bb. So if the expression is preserved, it contains a reference to aa.bb but if we indeed use underscores (as separate discussion) then we have invalid references.

[anandkp92]

As mentioned earlier, the changing the name of instances only happens in the semantic model and not for CXF. The parameters will remain aa.bb and the separator will not be replaced with _.

[anandkp92]

@mwetter I've made necessary changes and resolved most of your comments. I do have some questions for the remaining comments.