Upgrade a Project for SDNF


Pline	mapped to	Pline	which is	Cardinal Point
RBOS		SNFA		1
BOS		SNFB		2
SS		SNFB		2
LBOS		SNFC		3
RIGH		SNFD		4
NARO		SNFD		4
AA		SNFD		4
MM		SNFF		6
NALO		SNFF		6
LEFT		SNFF		6
RTOS		SNFG		7
GG		SNFH		8
TOS		SNFH		8
LTOS		SNFI		9
NA		SNFJ		10

Angles


Pline	mapped to	Pline	which is	Cardinal Point

TOAX		SNFA		1
TOAY		SNFA		1
RTTA		SNFC		3
LBOA		SNFG		7
NA		SNFJ		10
NAT		SNFK		11
NAL		SNFL		12

Channels


Pline	mapped to	Pline	which is	Cardinal Point
LTOC		SNFA		1
RTOC		SNFC		3
FOC		SNFD		4
ROC		SNFF		6
LBOC		SNFG		7
RBOC		SNFI		9
NA		SNFJ		10
TOC		SNFK		11
BOC		SNFN		14

For further explanation of the reasons why the mapping may seem inconsistent, see the section describing the assumed default profile orientations in the SDNF file and Cardinal Point locations in the SDNF User Guide, and the Structural Design User Guide. In particular the user’s attention is drawn to the different handedness of the coordinate systems as illustrated below.

The main differences arise from the mapping of the profile orientations in the AVEVA E3D™ Catalogue onto the agreed SDNF format. The difference is most apparent in channel and angle profiles. The diagram below illustrates the mappings of the Plines to Cardinal Points.

Note:

The different Y directions to match the default angle orientations in each system.

If the user wants to create profiles, the user must provide a Pline set similar to the ones provided here to map onto the Cardinal Point Pline set. If they are named differently, there must be a mapping to SDNF Cardinal Points as shown above. This is performed in the file sdnfloadcpdata.pmlfnc in the PMLLIB\SDNF\functions folder in the installation folder. Further, the user may have to manage the orientation of the profile with regard to the SDNF intermediate arrangement by using the Profile Orientation mapping file (External Mapping Files).

A sample extract of the Pline mapping in the file sdnfloadcpdata.pmlfnc is given here.

-- Cardinal point Pkeys

!!SDNFCPPkeys.delete( )

handle( 2,751 )

-- Variable does not exist

endhandle

!!SDNFCPPkeys = ARRAY( )

!!SDNFCPPkeys[ 1 ] = |SNFA|

!!SDNFCPPkeys[ 2 ] = |SNFB|

!!SDNFCPPkeys[ 3 ] = |SNFC|

-- Angles

!!SDNFCPBMTOAX = |SNFA|

!!SDNFCPBMTOAY = |SNFA|

!!SDNFCPBMRTTA = |SNFC|

!!SDNFCPBMLBOA = |SNFG|

In the above example, the Pline, whose Pkey is TOAX, is mapped to the Pline whose Pkey is SNFA and which is equivalent to the Cardinal Point number 1; RTTA is equivalent to SNFC (Cardinal Point 3). The user must not alter in any way the array which maps Pline names to Cardinal Point Pkey values, i.e. the array !!SDNFCPPkeys.

Thus, if the user has a new Pline, whose Pkey is RTOP, which is to be equivalent to Cardinal Point 3, the user must insert a line similar to the following in the mapping list:

!!SDNFCPBMRTOP = |SNFC|

i.e. in general, the format is…

!!SDNFCPBM<Pline PKEY> = |SNF[A-N]|

the user will then be able to use the RTOP Pline for their own positioning functions, but the interface will know that it is equivalent to the SNFC Pline (i.e. Cardinal Point 3). Thus, importing new items positioned using Cardinal Point 3 will appear in the AVEVA E3D™ model to have been positioned using the RTOP Pline.

Note:

Pline mapping on Import is subject to the constraint that the map will take the first equivalent it finds. In some circumstances the Pline TOAY (Cardinal Point 1) may be Imported as Pline TOAX (also Cardinal Point 1) because the TOAX mapping is the first suitable one the system finds. Unfortunately, there is no way that the interface can determine which Pline the system originally used.

Update Catalogues not supplied by AVEVA

Important:

The naming conventions and database structure for the Pline sets should be similar to those used in the AVEVA supplied Catalogues.

This section gives details on how the user can update the steel catalogues to include the Plines necessary for the SDNF interface.

The macro file, sdnfusercataupgr.pmlfnc in the SDNF\dflts\user\upgrade folder in the user data folder provides the basis on which the user may build their own mechanism for updating the catalogues automatically. In order to use this function, the whole containing user folder should be copied to the user's own work space as defined by AVEVA_DESIGN_USER and modified there. When the changes are complete the user should perform a PML REHASH ALL operation in a command window. We have indicated where the user may have to modify this file with lines prefixed by:

>>>> User…

The macro must be run for each catalogue (CATA element) the user wants to update. The user may have to modify it in a different way for each catalogue. (Details about how the file should be modified are given in following sections.)

The user can write a macro which will call all the modified files in turn and so upgrade all their catalogues at once. The macro takes one argument which is the DBREF (the database reference number) of the catalogue to be updated.

To update individual catalogues, run the upgrade macro as follows:

Enter the PARAGON module with write access to all the relevant catalogue databases.

Set the catalogue (CATA) the user wants to update as the current element and give the command in a Command Window:

call !!SDNFUserCataUpgr( !!CE )

Repeat for as many catalogues as required.

Save work and exit from PARAGON.

Generic Catalogue Shapes

The supplied catalogue contains profiles of 8 standard generic shapes which are detailed in the manual Structural Design User Guide. That manual explains the parameterisation method for these shapes. As a result, there are 8 generic macros in the PMLLIB\SDNF\upgrade folder in the installation folder, one for updating the Pline set of each standard shape. These are:


Profile Shape	Macro
Tee shape	sdnfupgradet.pmlfnc
I shape	sdnfupgradei.pmlfnc
O, Tube, CHS shape	sdnfupgradeo.pmlfnc
C, Channel shape	sdnfupgradec.pmlfnc
L, Angle shape	sdnfupgradel.pmlfnc
RHS shape	sdnfupgraderhs.pmlfnc
Japanese Bulb shape	sdnfupgradejbulb.pmlfnc
DIN Bulb shape	sdnfupgradedbulb.pmlfnc

If the user has other additional shapes, or have parameterised them in a different way from the supplied AVEVA E3D™ catalogues, the user will have to write their own macro for their own shape based on the most suitable one provided. Please take note of the catalogue profile orientation with regard to the SDNF format.

Customise the SDNF Pline Generating Macros

In order to customise the generic SDNF Pline generating macros listed above, or to create their own, the user will need to understand fully how the profile in question is parameterised in their catalogue database, and how the profile shape is positioned relative to the Neutral Axis and the X/Y origin in the catalogue. Below is an extract of the supplied sdnfupgradel.pmlfnc macro, including parts of the header.

------------------------------------------------------------------------

--

-- Significant Catalogue Parameters:

--  [#] [Description]                  [Specials]

--   1  Vertical leg length (Y)

--   2  Horizontal leg length (X)

--   3  Thickness                      Vertical leg   (JIS-PTSS-JANG)

--   4  Cy (X offset)

--   5  Cx (Y offset)

--   6  Unit weight                    Horizontal leg (JIS-PTSS-JANG)

--

------------------------------------------------------------------------

-- Define function

define function !!SDNFUpgradeL( ) is REAL

  -- Initialisation

  !error  = !!SDNFCPErrOK

  !origin = ( ref )

  -- Build map of existing PLINes

  !plineMap = ARRAY()

  var !coll collect all PLIN with (substring((PKEY ),1,3) eq |SNF|)for CE

  if( not !coll.empty( ) )then

      -- Build a map indexed on PKEY - don't delete them

      do !i values !coll

$!i

          !pkey = PKEY

          var !pkeyString hash( |$!pkey| )

          !index = !pkeyString.real( )

          !plineMap[ !index ] = !i.dbref( )

      enddo

  endif

  -- Create all new SDNF PLINes necessary

  !pkeysHashed = ARRAY( )

  do !i to !!SDNFCPPkeys.size( )

      !pkey = !!SDNFCPPkeys[ $!i ]

      var !pkeyString hash( |$!pkey| )

      !index = !pkeyString.real( )

      !pkeysHashed[ $!i ] = !index

      -- Try going to PLINe called SNF[A-N]

      $!plineMap[ $!index ]

      handle( 2,109 )( 2,752 )

        -- Failed - create it

        NEW PLIN $!!SDNFCPData

        PKEY $!pkey

        !ref = ( ref )

        !plineMap[ !index ] = !ref

      endhandle

  enddo

  -- Set Pline dimensions

  !YOff  =  |( ATTRIB CPARA[ 4 ] )|

  !nYOff = |( ATTRIB CPARA[ 4 ] - ATTRIB CPARA[ 1 ] )|

  !YCOff = |( ATTRIB CPARA[ 4 ] - ( ATTRIB CPARA[ 1 ] / 2.0 ) )|

  !XOff  =  |( ATTRIB CPARA[ 2 ] - ATTRIB CPARA[ 5 ] )|

  !XCOff = |( ( ATTRIB CPARA[ 2 ] / 2.0 ) - ATTRIB CPARA[ 5 ] )|

  !nXOff = |( -1.0 * ATTRIB CPARA[ 5 ] )|

  -- All requisite PLINes exist now

  -- Cardinal point 1  - Pkey = SNFA

  $!plineMap[ $!pkeysHashed[ 1 ] ]

  PX $!nXOff PY $!YOff PLAX -Y

  -- Cardinal point 2  - Pkey = SNFB

  $!plineMap[ $!pkeysHashed[ 2 ] ]

  PX $!XCOff PY $!YOff PLAX -Y

  -- Cardinal point 3  - Pkey = SNFC

  $!plineMap[ $!pkeysHashed[ 3 ] ]

  PX $!XOff PY $!YOff PLAX ‑Y

… and so on.

The structure of all the supplied macros is similar.

Note:

We record our interpretation of the catalogue parameters in the header.

The macro first builds a list of any SDNF Plines that already exist. Any SDNF Plines that are not available and are needed by the SDNF interface as listed in the !!SDNFCPData array, are then created. Doing this makes sure the latest configuration is being used.

We then need to define the SDNF Cardinal Point Pline location parameters related to the method of catalogue parameterisation. These are Xoff, YOff, nYOff and nXOff. We also need to work out the location of the geometric centre relative to the method of profile definition. These location parameters are XCOff and YCOff. The user will see above that the definition is in terms of a text string which describes a formula. Later on in the macro, this text string is inserted into the command line. This use of PML allows the user to insert formulae into the Pline definition, rather than the immediately evaluated formula.

Using these SDNF Pline location parameters, all the Cardinal Point Plines required for the SDNF interface can be located. Refer to Cardinal Points for further information.

If the user is extending or modifying SDNF, all the user should need to do is to modify the part of the macro which calculates the location parameters. The user should, however, pay close attention to the default profile orientations within SDNF.

The structure of the upgrade process allows the user to run the macro during the project as well as at project initiation. Any database relationships that refer to the old Plines will be maintained, e.g. dimensions.

Map Pline Set Names to Profile Shapes

Once the user has defined their generic shapes the user needs to be able to map the Pline set names to that shape. This is done by filling in a mapping file of PML objects in the sdnfusercataupgr.pmlfnc macro file. The first set in the UserMap array may have to be modified, and the user may have to extend the list for their own additional specific shapes.

For example, a complete mapping for a Pline set consists of the following:

  -- Map Shapes to generic update macros

    !TShape             = |!!SDNFUpgradeT( )|

    !IShape             = |!!SDNFUpgradeI( )|

    !OShape             = |!!SDNFUpgradeO( )|

    !CShape             = |!!SDNFUpgradeC( )|

    !LShape             = |!!SDNFUpgradeL( )|

    !RHSShape           = |!!SDNFUpgradeRHS( )|

    !JBULBShape         = |!!SDNFUpgradeJBULB( )|

    !DBULBShape         = |!!SDNFUpgradeDBULB( )|

-- >>>> User to add any specific shapes here

--    !USERAShape         = |!!SDNFUpgradeUSERA( )|

  -- >>>> User Map definition between PTSS and Shape code

    !UserMap = ARRAY( )

    !UserMap[ 1 ]         = object SDNFMAPOBJ( )

    !UserMap[ 1 ].Name   = |/USER-PTSS-I|

    !UserMap[ 1 ].Macro   = !IShape

This means that the Pline set (PTSS) named /USER-PTSS-I is to be modified using the PML macro represented by the variable !Ishape. Further up, the user can see that the !IShape variable is associated with the macro !!SDNFUpgradeI( ).

Catalogue Upgrade Step-by-Step

Below are instructions to create and upgrade the Catalogue based on the requirement to create a new profile shape in both Design and the external steel detailing package. Any operations that require changes to system mapping files, should be preceded by backing up the files first.

New Profile Shape Definition

With each package the user will need to create the new 2D profile shape. Determine the generic shape and parameterisation best suited to the required profile.

At this point do not include SDNF Plines in the Pline set just place other Plines the user will find useful and name them accordingly. Do not include any Plines with PKEY values SNFA to SNFN as these will be added in the upgrade process. Build the new catalogue, recording which parameters apply to which dimension.

In the steel detailing package create the profile such that its default orientation will be the same as that in Design when laid out from start to end.

With predefined profiles, such as unequal angles, the default orientation may be different. In this case, the user may need to use mirroring and/or rotation transformations to get to the correct "starting position". Mirroring represents a transformation about the Y axis: rotation is about the Z axis, following the "Right Hand Screw Rule". Keep a record of these necessary transformations as they will go into the orientation mapping file.

On the 2D profile in each package locate where the Cardinal Points and their Pline equivalents will be. In the PARAGON module, place any other Plines that the user may find useful. Record the correspondence between Cardinal Points and Pline names. Remember also that any mirroring and rotation will affect the Cardinal Point locations.

Note:

The coordinate system in AVEVA E3D™ is right handed, whereas in Frameworks it is left handed. The Cardinal Point : Pline equivalencing by superposition is illustrated above for an unequal angle profile. Using this kind of diagram the user will be able to determine the mappings between Plines and Cardinal Points.

If the new profile is not one of the existing types, the user may need to assign a new profile integer type code to it for use in the profile mapping file.

Also, if the new profiles are for a new country standard, the user may need to assign a new country code to this. This three letter abbreviation is stored in the internal steel standards file. This abbreviation is also used in the profile mapping file.

Upgrade the Catalogue for SDNF

Upgrading the Catalogue involves adding SDNF Plines to be equivalent to the Cardinal Points.

In PARAGON determine the parameterised geometry and Pline positioning for the Cardinal Points.

If the user is extending an existing generic shape use the existing upgrade file provided. Or if the profile can be based on an existing generic shape, use a customised copy of the sdnfupgrade<*>.pmlfnc macro. Modify the profile upgrade macro to account for the new parameterisation to create and locate the SDNF Plines for the Cardinal Points. Use an existing example as a guide.

Any new Pline names, as set in the PKEY attribute, must be mapped to Cardinal Points in the sdnfloadcpdata.pmlfnc macro. PML is a language that enables the user to construct variable names from string components and then use them. This is how the Pline mapping is managed. Inspect the current file for directions on how to extend this file. Modify it then run it.

-- Cardinal point Pkeys

!!SDNFCPPkeys.delete( )

handle( 2,751 )

-- Variable does not exist

endhandle

!!SDNFCPPkeys = ARRAY( )

!!SDNFCPPkeys[ 1 ] = |SNFA|

!!SDNFCPPkeys[ 2 ] = |SNFB|

!!SDNFCPPkeys[ 3 ] = |SNFC|

-- Angles

!!SDNFCPBMTOAX = |SNFA|

!!SDNFCPBMTOAY = |SNFA|

!!SDNFCPBMRTTA = |SNFC|

!!SDNFCPBMLBOA = |SNFG|

Run sdnfcataupgr.pmlfnc macro for upgrading standard catalogues.

Inspect the macro sdnfusercataupgr.pmlfnc to extend any lists to include the new profile shape, associating it with any new profile upgrade macro. Once modified, perform a PML REHASH ALL command in a Command window, if necessary, then run this macro.

!Ishape = |sdnfupgradei()|

!UserMap[ 1 ] = object SDNFMAPOBJ( )

!UserMap[ 1 ].Name = |/USER-PTSS-I|

!UserMap[ 1 ].Macro = !Ishape

Modify the Orientation Mapping File

For the chosen profile in the chosen standard, if any transformations are to be applied to convert from Design to the SDNF default system, they are to be recorded in the orientation mapping file for the target detailing package. If the profile requires no transformations, it should not be listed in this file. In the example below, the British type 9 profiles are orientated by mirroring (1) and then rotating by 180 degrees. British type 8 profiles are not mirrored (0) and just rotated by 180 degrees.

Modify the Profile Mapping File

Any new profiles requiring mapping between Design and the external steel detailing system should be entered in the mapping file appropriate to the detailing package. For example:

AVEVA XSTEEL

HE280A HEA280 EUR 20

HE280B HEB280 EUR 21

Re-initialise the System and Save the UI Binaries

On the SDNF Export or Import main forms use Control > Re-initialise for resetting the configuration data only.

Or execute call !!sdnfimpexp() in a command window

to re-initialise the system. However this last option is very brutal as all settings will be lost because the windows and menus are regenerated. The user will then have to regenerate UI binaries after this.

Installation of User Defined Attributes

Before the user starts designing steelwork, the interface requires a set of User Defined Attributes (UDAs) specifically for storing SDNF related information. These are installed by performing the following actions:

Enter the LEXICON module with write access to all the relevant Dictionary databases.

Execute the upgrade macro by the following command:

call !!SDNFUDAUpgrade( )

Exit from LEXICON, saving the changes.

Note:

This upgrade may be run even if the UDAs exist already. In this way the user may upgrade the system whenever necessary; for example, to include more UDAs needed for a later version of the interface.

More UDAs are required in this version, so the user will need to upgrade their current projects if they are to use this later version. The macro has been configured to keep existing UDA definitions so that the user will not lose data.

Special SDNF SITES

When the SDNF application installs itself in the Design database, some SITE elements will be created. Typically these will be called something like /SDNF-CONFIG-DEMO-SYSTEM and /SDNF-OLD-DEMO-SYSTEM. The first is a SITE to store information about the Import and Export processes, default Header information, and Transfer and Revision numbers. The second is a SITE to store items which have been 'deleted' from the model during the Export/Import design cycle. This latter site will be created only when needed. The user can always recover elements from this area if they need to later on.

The name of the configuration and deleted element SITEs are built up of the following components::


/SDNF-	the system prefix
CONFIG-	identification of a Configuration SITE
OLD-	identification of a SITE for ‘deleted’ elements
<mdb name>	the current MDB, e.g. /DEMO
<user name>	the current user name, e.g. SYSTEM

SDNF will check that the user has read/write access to their specific SITEs, since the user and the interface may need to edit certain attributes.

The SITE for deleted elements, named in a similar manner to the Configuration object and described in more detail in the User Guide, will store the 'deleted' elements in STRUs according to the Import revision, so that the user can quickly isolate which items were deleted at which time.

The user will note that the SITE names contain the current MDB and the current user name. This is to facilitate multi-user working, and multiple accesses to the database. There may be several of these, depending on which MDB and/or user has access to the particular database. During the Import and Export processes, all these elements are inspected to determine the latest transfer information.