Headers
stringlengths
3
162
Content
stringlengths
12
32.8k
The Framework Codes tab contains
The Framework Codes tab contains alternative descriptions for the support codes used by the Supports application. For example, some of the support codes associated with an FT09 support are: FT09-1-1 FT09-2-1 FT09-3-1 FT09-4-1 FT09-5-1 FT09-6-1 FT09-1-2 FT09-2-2 FT09-3-2 FT09-4-2 FT09-5-2 FT09-6-2 FT09-1-3 FT09-2-3 FT09-3-3 FT09-4-3 FT09-5-3 FT09-6-3 FT09-1-4 FT09-2-4 FT09-3-4 FT09-4-4 FT09-5-4 FT09-6-4 FT09-1-5 FT09-2-5 FT09-3-5 FT09-4-5 FT09-5-5 FT09-6-5 FT09-1-6 FT09-2-6 FT09-3-6 FT09-4-6 FT09-5-6 FT09-6-6 FT09-1-1 FT09-2-1 FT09-3-1 FT09-4-1 FT09-5-1 FT09-6-1 FT09-1-2 FT09-2-2 FT09-3-2 FT09-4-2 FT09-5-2 FT09-6-2 FT09-1-3 FT09-2-3 FT09-3-3 FT09-4-3 FT09-5-3 FT09-6-3 FT09-1-4 FT09-2-4 FT09-3-4 FT09-4-4 FT09-5-4 FT09-6-4 FT09-1-5 FT09-2-5 FT09-3-5 FT09-4-5 FT09-5-5 FT09-6-5 FT09-1-6 FT09-2-6 FT09-3-6 FT09-4-6 FT09-5-6 FT09-6-6 The codes are dependent on the steelwork size used and the number of cross bars. In some circumstances the standard may have a different standard code for different steelwork sizes with the same configuration. The settings can be used to print the correct code in the MODEL module, on the ADP drawing and in the material list of the piping isometric if required. For example, if an alternative code of M10A1 is specified for FT09-1-1, for ADP and isometric production, the code FT09-1-1 code is replaced with M10A1. The list of available support codes displays the fixed support codes for the selected framework and the alternative code, if defined. The * character indicates that the fixed code is used, which is the default setting. Edit Selected Row To modify the Alternative Code for the currently selected row in the list of available support codes, input a value in the field to replace the * character. Press Enter to populate the list of available support codes with the modified value. Edit Column An alternative code can be specified for a range of fixed codes, by making appropriate selections in the From and To drop-down lists. Input an Alternative Code in the field to replace the stored values. Press Enter to populate the list of available support codes with the modified value. Framework Codes Edit Selected Row Alternative Code Enter Edit Column From To Alternative Code Enter
Trunnion Data
Sets the available trunnion types that can be used on a project, and which trunnion bore sizes can be used with each pipe bore. The window also allows you to specify the pipe sizes that the selected trunnion can be attached to, and if the trunnion material type appears on the piping isometric. You can also select which trunnion base plate standards are available to the user. Changes are only applied to the database when Apply is clicked. Cancel removes the window. If changes have been made but not applied, a window displays asking if the changes are to be applied before exiting. Apply Cancel
The left hand side of the window
The left hand side of the window displays the list of available trunnion support types (TT series). Filter criteria can be used to specify which trunnion support types are displayed in the list. Refer to GUI Grid Data for further information. When a trunnion is highlighted, the support standard Name, Replacement Name and Description appear at the top of the window. The information is outside of the tabbed areas and displays on all tabs. The plotfile for the selected trunnion displays on the right hand side of the window. To zoom in to an area of the plotfile, click and drag the middle mouse button to create a zoom area. To restore the original size, right-click and select Reset Limits from the drop-down menu. Click Apply before selecting another trunnion type, otherwise any changes are lost. Support Standard The trunnion name selected in the list of available trunnion support types displays, and cannot be changed. The support standard is the code used internally within the software by the Supports application Standard Replacement Name The Standard Replacement Name is used on all windows in the supports application when referring to the support type defined by the support standard. It is also output in place of the support standard name on automatic drawing production drawings. The name can be modified by editing the text in the field. Description The text in this field is configurable to suit each design project, and only displays in the Model module during the creation of Supports. The description in the field does not affect any associated Material Take Off (MTO) details output in automatic drawing production, as the details are stored in the catalog database. Active Allows you to specify which of the available support standards are available for use in the project by the user. Select the check box to include the currently selected support standard in selection lists. Deselect the check box to exclude the currently selected support standard from selection lists. The Active setting overrides any subsequent active setting that displays on the Active/Shop Flag tab. Refer to Active/Shop Flag Tab for further information. Vendor Reference Not available at this release. Elevation Restriction Specifies the elevation (height) at which a trunnion can be created at and above. For example, setting a value of 5000 means the trunnion can be created at any elevation at 5000mm and above. If a value of -1000 is input, the trunnion can be created at any elevation below 1000mm. The default setting is *, indicating that there is no restriction on the elevation at which the trunnion can be created. Pipe Specification Material Code The pipe material is specified here: For example, the text value CS represents the setting stored at a valid PIPE specification, at the uda :MDSPipeMat, for use by the Supports application. These settings are configurable and not restricted to the example display values. SKey The symbol key that is stored against the SDTE of the specification is displayed here. A symbol key specifies a symbol representation for a support type on an isometric drawing. SKey Override You can override the symbol key that is stored against the SDTE of the specification. Input an alternative symbol key value in the field to modify the symbol representation for a support type on an isometric drawing. Support Function The trunnion support function is specified here. For example, TT for a Trunnion. By default, ancillary, hanger and trunnion standards are assigned a default support function corresponding to their standard code. For example, AT, AN, FH, VH, TT, these are fully configurable. To specify a support function for an ancillary, refer to Ancillary Data for further information. To specify a support function for a hanger, refer to Hanger Data for further information To specify a support function for a trunnion, refer to Trunnion Data for further information. Isometric MTOC Flag Determines if the material for the trunnion appears in the material list on the piping isometric. Select the check box to include the material in the isometric material list. Deselect the check box to exclude the material from the isometric material list. The isometric MTOC flag overrides any subsequent shop flag settings that display on the Active/Shop Flag tab. Refer to Active/Shop Flag Tab for further information. Detail Rtext AVEVA provides a library of Multi Discipline Supports (MDS) catalog content in the AVEVA Catalog Project (ACP), that is reissued periodically to accompany product updates. Much of the MDS out-of-the-box content can be customized in local projects using the Application Defaults, and where appropriate updates to these are delivered along with product updates, enabling those local projects to take advantage of new functionality and catalog content. The Detail Rtext functionality allows you to customize the MDS Detail Texts in the Application Defaults, removing the need to modify the ACP directly and maintain them when an update is received. Input a text expression in the Detail Rtext field that will evaluate at the hanger. The following text expressions are valid: The following text expression would not evaluate to a text result: CS Carbon Steel SS Stainless Steel FG Fibre Glass GV Galvanized PL Plastic CN Cupro Nickel ALL represents ANY material, for example, valid for all pipe specifications. CS Carbon Steel CS Carbon Steel SS Stainless Steel SS Stainless Steel FG Fibre Glass FG Fibre Glass GV Galvanized GV Galvanized PL Plastic PL Plastic CN Cupro Nickel CN Cupro Nickel ALL represents ANY material, for example, valid for all pipe specifications. ALL represents ANY material, for example, valid for all pipe specifications. Note: If the Detail Rtext field does not display, make sure Application Defaults updates 00087 and 00088 are installed (refer to Update Existing Client Project Application Defaults Databases for further information) together with the latest version of AVEVA E3D Design and ACP. Active/Shop Flag Tab Ancillary Data Hanger Data Trunnion Data Active/Shop Flag Tab Update Existing Client Project Application Defaults Databases GUI Grid Data Name Replacement Name Description Reset Limits Apply Support Standard Standard Replacement Name Standard Replacement Name Description Active Active/Shop Flag Tab Vendor Reference Elevation Restriction Pipe Specification Material Code SKey SKey Override Support Function Ancillary Data Hanger Data Trunnion Data Isometric MTOC Flag Active/Shop Flag Active/Shop Flag Tab Detail Rtext Detail Rtext Note : Detail Rtext Update Existing Client Project Application Defaults Databases Detail Rtext
chcek boxes
Active The setting of the check boxes determines the pipe bore sizes that the selected trunnion type can be attached to. If the Active check box is selected on the Standard tab, all check boxes are selected by default, you can deselect the required check boxes for the project. If the Active check box is not selected on the Standard tab, this setting overrides all the check box settings, all bore sizes are defined as not active, even if the check box is selected. Shop Flag The setting of the check boxes determines whether the material for a trunnion appears on the piping isometric material list under the FABRICATION MATERIALS (SHOP TRUE) or ERECTION MATERIALS (SHOP FALSE) heading of the Material Take Off (MTO). If the Isometric MTOC Flag check box is selected on the Standard tab, all check boxes are selected by default, you can deselect the required check boxes for the project. If the Isometric MTOC Flag check box is not selected on the Standard tab, this setting overrides all the check box settings, all shop flag settings are defined as not active, even if the check box is selected. Active Active Standard Active Standard Shop Flag Isometric MTOC Flag Standard Isometric MTOC Flag Standard
the available trunnion types
Sets the available trunnion types that can be used on a project, and which trunnion bore sizes and trunnion components are available to the user. Trunnion Bores List The size of the pipe is specified by clicking the Bore up/down arrows. The available trunnion bores for the selected trunnion type and pipe bore display in the Trunnion Bores list. To make a trunnion bore size available to the user, select an item in the Inactive list and click the right arrow at the side of the list. The item is transferred to the adjacent Active list. Click the left arrow to reverse the action. The default trunnion bore displays at the top of the Active list. Trunnion Sizes The trunnion size is the length of the trunnion from the bottom of the trunnion baseplate, (not the bearing plate) to the center of the pipe to which it is welded/clamped. The minimum and maximum trunnion size for the selected trunnion type and pipe bore can be set, as well as the default trunnion size (length). Components for Trunnion Bore List The available ancillary components for the selected trunnion are listed. A list is available for each component type based on support class. Refer to Support Class for further information. The support classes for trunnions are: To make a trunnion component available to the user, select an item in the Inactive list and click the right arrow at the side of the list. The item is transferred to the adjacent Active list. Click the left arrow to reverse the action. The default trunnion component displays at the top of the Active list. Preview The preview part of the Component Selection tab allows you to view a 2D representation of the currently selected trunnion component. Right-Click Menu You can right-click either the list of active trunnion bores or the list of active trunnion bore components to display a drop-down menu. Make default (move to top) Select from the drop-down menu to define the selected trunnion bore/trunnion component as the default. Move up Select from the drop-down menu to move the selected trunnion bore/trunnion component up one position on the list of active trunnion bores/list of active trunnion components. Move down Select from the drop-down menu to move the selected trunnion bore/trunnion component down one position on the list of active trunnion bores/list of active trunnion components. Make default (move to top) Select from the drop-down menu to define the selected trunnion bore/trunnion component as the default. Move up Select from the drop-down menu to move the selected trunnion bore/trunnion component up one position on the list of active trunnion bores/list of active trunnion components. Move down Select from the drop-down menu to move the selected trunnion bore/trunnion component down one position on the list of active trunnion bores/list of active trunnion components. TRUNNION BASE PLATE TRUNNION BEARING PLATE TRUNNION COLLAR PLATE TRUNNION CLAMP ISOLATION BLOCK BREAK OUT PLATES INLINE REINFORCING PLATE TRUNNION BASE PLATE TRUNNION BASE PLATE TRUNNION BEARING PLATE TRUNNION BEARING PLATE TRUNNION COLLAR PLATE TRUNNION COLLAR PLATE TRUNNION CLAMP TRUNNION CLAMP ISOLATION BLOCK ISOLATION BLOCK BREAK OUT PLATES BREAK OUT PLATES INLINE REINFORCING PLATE INLINE REINFORCING PLATE Trunnion Bores List Bore Trunnion Bores Inactive Active Active Trunnion Sizes Components for Trunnion Bore List Support Class Inactive Active Active Preview Component Selection Right-Click Menu Make default (move to top) Move up Move down
Lighting Support Defaults
Sets the available defaults required to create a lighting support. Click Reset to revert the Lighting Support Defaults window to the default values/settings. Changes are only applied to the database when Apply is clicked. Cancel removes the window. If changes have been made but not applied, a window displays asking if the changes are to be applied before exiting. Type The text field is used to identify a lighting support type. Code The PML (Programmable Macro Language) string expression specifies the support code of the lighting support that is used for output in DRAW or reports. Origin Defines the support origin that is used when positioning the support. Any positional attribute or p-point reference can be specified. Replacement Type The alternative support type to be output in DRAW or reports. Max. Height The maximum height at which the support can be created. The value can also be set locally within the support template to provide different maximum values for different conditions (for example, a different zone or elevation). Min. Height The minimum height at which the support can be created. The value can also be set locally within the support template to provide different minimum values for different conditions (for example, a different zone or elevation). Bracket Limit If the support height is less/greater than this value, then bracket(s) are removed from or added to the support. The bracket limit can also be specified locally within the support template. Type Specifies the item within the design database that represents the lighting equipment to be supported. Filter The PML filter expression can be used to specify attributes that define the lighting equipment more precisely. Origin Specifies the origin of the lighting. When the support is created, its origin is placed at the lighting origin. Any positional attribute or p-point reference (for example, DP1, P2) can be specified. The lighting origin is normally positioned in the middle of the support when viewed from the Z (vertical) direction. Y Direction Used during lighting support creation to orientate the support so that the Y axis is aligned with the Y direction of the specified lighting. Any positional attribute, local axis of lighting (for example, Y45N) or p-point reference (for example, DP1 or P1) can be specified. Lighting is assured to be on the horizontal plane. Reset Lighting Support Defaults Apply Cancel Type Code Origin Replacement Type Max. Height Min. Height Bracket Limit Type Filter Origin Y Direction
Area Based ADP Grid Data
The Supports application contains functionality to include GRIDSY grids (available in Model) in the Area Based ADP (ABA) location plan. The use of SCTN based grid definitions is maintained. The functionality enables the use of multiple grid systems across the 3D model. Suitable grid systems are automatically selected in the ABA location plan during drawing generation. In order to include a GRIDSY grid in AVEVA Catalog, it is first necessary to set up a grid in Model. You can define the list of available grids, the pattern for tagging of gridlines (Programmable Macro Language (PML) expression) and origin of support coordinates that display on the drawing. The administration data is stored in the MDSAPPDEFAULTS database below CATA MDS/ABAGRIDDATA/DEFAULTS. The default values/settings indicated on the window are those that exist when the Supports application is first installed. Changes made are only applied to the database when Apply is clicked. To keep the changes the Save Work operation must to be performed. Click Cancel to close the window. If changes have been made, but not applied, a window displays asking if the changes are to be applied before exiting. Gridline Tag Patterns The gridline tag patterns allow you to customise the way in which grid data is tagged within the ABA location plan which is created in the Draw application. PML expressions can be input into the GRDLN Tag and SCTN Tag fields which are evaluated against the selected gridlines. Expressions are evaluated against the X and Y gridlines that are automatically selected when generating the support, such expressions can therefore comprise of any of the gridline attributes or any attribute from the hierarchy above (provided that STRING output is maintained). When the ABA location plan is created, the result is written into the ATEXT attribute of a SLAB. It can contain explicit sequences that have special meanings in Draw, for example '/#' which is interpreted as a newline character and splits the resulting text into two lines. Support Datum Origin Coordinates The support datum origin coordinates settings allow you to define the calculation process for the support datum dimensions used in the ABA location plan in the Draw application. The Support Coordinates Origin drop-down list contains the following types of support datum calculation: List of Valid Grids You can define the available grid systems for use with the ABA location plan. To add a grid to the list of valid grids, select the grid (GRIDSY, Structure (STRU) or Framework (FRMW) grid element) to be added on the Catalog Explorer and click ADD CE. Click Remove Selected to delete the currently selected grid from the list of valid grids. Matching Grid - The origin of the selected grid is used. Zone, Site, World - The origin of the specified element in the hierarchy above the support is used. Named Item - The origin of the specified named item in the design database is used. Matching Grid - The origin of the selected grid is used. Matching Grid - The origin of the selected grid is used. Zone, Site, World - The origin of the specified element in the hierarchy above the support is used. Zone, Site, World - The origin of the specified element in the hierarchy above the support is used. Named Item - The origin of the specified named item in the design database is used. Named Item - The origin of the specified named item in the design database is used. Note: The Supports ABA Grid Data window is not required for REFGRID grids, they take their tag format directly from the grid line data. In order to use REFGRID grids, the location plan task uses the mdsAbaLocPlanRefGrd function. An example can be seen in the AvevaPlantSample project task /mds_aba_location_plan_task. If an attempt is made to include a REFGRID grid, an error message is displayed. This can be safely ignored. Supports Note : Supports ABA Grid Data Supports Apply Save Work Cancel Gridline Tag Patterns GRDLN Tag SCTN Tag Support Datum Origin Coordinates Support Coordinates Origin Matching Grid Zone, Site, World Named Item List of Valid Grids ADD CE Remove Selected
Ancillary Selection Criteria
Sets user defined ancillary selection criteria for the generation of supports. These criteria are used in addition to the standard checks that are performed on ancillaries when they are created. For example bore, temperature and material checks. The administration data is stored in the MDSAPPDEFAULTS database below CATA MDS/SELECTION-CRITERIA. The default values/settings that display on the windows are those are those that exist when the Supports application is first installed. Click Reset to revert the User Defined Ancillary Selection Criteria window to the default values/settings. Changes made are only applied to the database when Apply is clicked. To keep the changes the Save Work operation must be performed. Click Cancel to close the window. If changes are made, but not applied, a window displays asking if the changes are to be applied before exiting. Temperature Check You can override the default temperature check that is performed at branch level. For example, the temperature check can be modified to be carried out at pipe level by changing the expression field to temp of PIPE. The validity of the PML expression is checked by AVEVA Catalog, if an error is detected an error message displays and the Expression field is highlighted. User Defined Criteria You can input customized ancillary checking expressions in the Criteria 1 to 5 fields. For example, the paint code of a branch can be specified, the user is then only able to create the ancillary if the paint code matches that defined in the Programmable Macro Language (PML) expression. Input an ancillary selection criteria description in the Description field. Input a valid PML expression in the Expression field. Tick the Active check box to activate the ancillary selection criteria. The supports hierarchy is separate from the branch and pipe. The initial element expected in the criteria expression is the SUPPO element. The previous component on the selected branch, nearest to the SUPPO element is represented by the compref attribute on the SUPPO. User Defined Functions In addition to the standard expression functionality, it is also possible to create a user defined function to perform more advanced checking. You can assign a user defined check function to the Criteria fields. The value in the expression field is the full function call to the user defined function. For example, the expression can be called !!checkCriteria1(). User Defined Check Function - Creation and Usage Rules The following rules must be observed when assigning a function: User Defined Check Function - Example Listing The example user defined check function enables the user to create a support only when the paint spec of the branch is either '12345-STD-PIP-001-RAL1069' or '12345-STD-PIP-001-RAL1070'. The user defined check function must be created in a standard text file. As the function name is checkCriteria1 the file should be saved as checkcriteria1.pmlfnc It is recommended that check functions are saved in a separate folder to AVEVA E3D Design and that the pmllib environment variable in AVEVA E3D Design startup is modified to point to it. For example: Create a folder called pmllib in c:\userpml\ Save checkcriteria1.pmlfnc to c:\userpml\pmllib\ Modify the environment variable for pmllib to add this new search path. For example: Enter Model, type PML REHASH ALL into the command line and press Enter. The pml index is updated allowing the user defined file to be used. Refer to the Using PML in AVEVA Products for further information regarding PML customization. Define function !!functionName() is BOOLEAN If !!ce.compref.type.eq(‘BRAN’) then !bran = !!ce.compref (if the compref is the branch itself) else !bran = !!ce.compref.owner (if the compref is a branch component) endif define function !!checkCriteria1() is BOOLEAN --get the paint spec of the pipe branch var !paintSpec ptsp of bran of compref --make sure that the paint spec of the of the pipe is one of the types specified below if !paintSpec.neq('12345-STD-PIP-001-RAL1069') and !paintSpec.neq('12345-STD-PIP-001-RAL1070') then return FALSE else return TRUE endif endfunction The function entered in the expression field must be in the correct format. For example, !!functionName() The user defined function file must have a BOOLEAN return type. For example, the function file definition must in the following format: Define function !!functionName() is BOOLEAN The function cannot be called with any arguments. For example, the function brackets must be empty. When the user defined check function is run, the current element is the datum support of the pipe so all processing must be done on this basis. For example, to interrogate the branch the following commands can be used. If !!ce.compref.type.eq(‘BRAN’) then !bran = !!ce.compref (if the compref is the branch itself) else !bran = !!ce.compref.owner (if the compref is a branch component) endif The function entered in the expression field must be in the correct format. For example, !!functionName() The function entered in the expression field must be in the correct format. For example, !!functionName() The user defined function file must have a BOOLEAN return type. For example, the function file definition must in the following format: Define function !!functionName() is BOOLEAN The user defined function file must have a BOOLEAN return type. For example, the function file definition must in the following format: The function cannot be called with any arguments. For example, the function brackets must be empty. The function cannot be called with any arguments. For example, the function brackets must be empty. When the user defined check function is run, the current element is the datum support of the pipe so all processing must be done on this basis. For example, to interrogate the branch the following commands can be used. If !!ce.compref.type.eq(‘BRAN’) then !bran = !!ce.compref (if the compref is the branch itself) else !bran = !!ce.compref.owner (if the compref is a branch component) endif When the user defined check function is run, the current element is the datum support of the pipe so all processing must be done on this basis. For example, to interrogate the branch the following commands can be used. Reset User Defined Ancillary Selection Criteria Apply Save Work Cancel Temperature Check User Defined Criteria Description Expression Active User Defined Functions User Defined Check Function - Creation and Usage Rules !!functionName() Define function !!functionName() is BOOLEAN User Defined Check Function - Example Listing Enter Using PML in AVEVA Products
Compensation Plates
The Supports application contains functionality to enable the creation and modification of compensating plates in order to fill any gaps between frameworks and ancillaries. In order to create compensating plates within Model, it is first necessary to set up a number of administrative options. The administration data is stored in the MDSAPPDEFAULTS database below CATA MDS/COMPENSATING-PLATES/DEFAULTS.
the minimum and maximum gap sizes
Sets the minimum and maximum gap sizes and the calculation process for plate thicknesses and rounding distances. The default values/settings indicated on the window are those that exist when the Supports application is first installed. Click Reset to revert the Supports Compensation Options window to the default values/settings. Changes made are only applied to the database when Apply is clicked. To keep the changes the Save Work operation must be performed. Click Cancel to close the window. If changes have been made, but not applied, a window displays asking if the changes are to be applied before exiting. Gap The gap settings allow you to define when a compensation can be used and which type of compensation to use in a particular situation. It is also possible to define the maximum gap for a plate to be used. If the gap is between the maximum for a plate and the maximum for a profile, then a compensating profile (FIXING) is created. The dimensional value of the Minimum field defines the minimum space required for the user to create a compensating plate. If the gap is less than this value then it is not regarded as a gap and no compensation is created. The dimensional value of the Maximum for Plates field defines the maximum space required for the user to create a compensating plate. If the gap is equal or less than this value (and not less than the Minimum) then plates (PANE) are created to fill the gap. The dimensional value of the Maximum for Profile field defines the maximum space required for the user to create a compensating profile. If the gap is equal or less than this value but greater than the maximum value for plates, then a profile (FIXING) is placed to fill the gap. Plate Thickness The plate thickness settings allow you to define the calculation process for the thickness of the compensating plate. The Calculation Method drop-down list contains the following types of plate thickness calculation: The Visually Accommodate option can be set to either On or Off using the drop-down list. If there is a gap or overlap, the actual thickness of the top plate can be accommodated so that it fits the gap. Adding an extra design parameter to the plate alters the height. Rounding The rounding settings allow you to define the calculation process for the rounding of the compensating plate. The X and Y values for the compensating plate are the length and width values. In order to obtain these sizes a calculation can be performed, refer to Compensation Sizes for further information. After the X or Y size of the compensating plate is calculated, it is rounded according to the specified parameters. The Calculation Method drop-down list contains the following types of rounding calculation: The X-size value and Y-size value fields allow you to define the nearest value to round to. For example, an X-size value of 10mm rounds the result to the nearest 10mm. To disable rounding, set the X and Y size values to 0mm. Greater or equal to the gap - The overall thickness of all plates must either fit the gap or overlap it. There must be no remaining gap. Less or equal to the gap - The overall thickness of all plates must never overlap the gap. Plates either fit the gap or some gap remains. Closest to the Gap - There can be either an overlap or a gap remaining, Plates of thicknesses are selected so the overall thickness is as close to the gap size as possible. Greater or equal to the gap - The overall thickness of all plates must either fit the gap or overlap it. There must be no remaining gap. Greater or equal to the gap - The overall thickness of all plates must either fit the gap or overlap it. There must be no remaining gap. Less or equal to the gap - The overall thickness of all plates must never overlap the gap. Plates either fit the gap or some gap remains. Less or equal to the gap - The overall thickness of all plates must never overlap the gap. Plates either fit the gap or some gap remains. Closest to the Gap - There can be either an overlap or a gap remaining, Plates of thicknesses are selected so the overall thickness is as close to the gap size as possible. Closest to the Gap - There can be either an overlap or a gap remaining, Plates of thicknesses are selected so the overall thickness is as close to the gap size as possible. Always Up - The resulting value from the calculation is always rounded upwards. For example, if the resulting X size is 33mm and the rounding X value is set to 10mm then it is rounded up to 40mm. Always Down - The resulting value from the calculation is always rounded downwards. For example, if the resulting X size is 38mm and the rounding X value is set to 10mm then it is rounded down to 30mm. To Closest Value - The resulting value from the calculation is rounded to the nearest number. For example, if the resulting X size is 38mm and the rounding X value is set to 10mm then it is rounded up to 40mm. Always Up - The resulting value from the calculation is always rounded upwards. For example, if the resulting X size is 33mm and the rounding X value is set to 10mm then it is rounded up to 40mm. Always Up - The resulting value from the calculation is always rounded upwards. For example, if the resulting X size is 33mm and the rounding X value is set to 10mm then it is rounded up to 40mm. Always Down - The resulting value from the calculation is always rounded downwards. For example, if the resulting X size is 38mm and the rounding X value is set to 10mm then it is rounded down to 30mm. Always Down - The resulting value from the calculation is always rounded downwards. For example, if the resulting X size is 38mm and the rounding X value is set to 10mm then it is rounded down to 30mm. To Closest Value - The resulting value from the calculation is rounded to the nearest number. For example, if the resulting X size is 38mm and the rounding X value is set to 10mm then it is rounded up to 40mm. To Closest Value - The resulting value from the calculation is rounded to the nearest number. For example, if the resulting X size is 38mm and the rounding X value is set to 10mm then it is rounded up to 40mm. Compensation Sizes Reset Supports Compensation Options Apply Save Work Cancel Gap Minimum Maximum for Plates Maximum for Profile Plate Thickness Calculation Method Greater or equal to the gap Less or equal to the gap Closest to the Gap Visually Accommodate On Off Rounding Compensation Sizes Calculation Method Always Up Always Down To Closest Value X-size value Y-size value
the rules that are used to calculate both the X and Y sizes of the compensating plate
Sets the rules that are used to calculate both the X and Y sizes of the compensating plate. The default values/settings indicated on the window are those that exist when the Supports application is first installed. Click Reset to revert the Supports Compensation Sizes window to the default values/settings. Changes made are only applied to the database when Apply is clicked. To keep the changes the Save Work operation must be performed. Click Cancel to close the window. If changes have been made, but not applied, a window displays asking if the changes are to be applied before exiting. The Supports Compensation Sizes window contains two tabs for specifying separate rules to calculate the X and Y sizes of the compensating plate. The General Rule is used when a rule for a given support type is not defined. The Default Value field defines the default X and Y sizes of the compensating plate. Rules can be created for specific support types, input the support codes into the support code field, separated by a space. An asterisk can be used to identify all support types. If two rules are defined for the same support type, the first rule in the list for that support type is used and the second is ignored. A rule must always be a Programmable Macro Language (PML) expression that returns a REAL value upon evaluation. If the expression contains references to attributes or properties, the expression is evaluated against the ANCI of the support. Therefore it can contain any attribute or property which is available on the ANCI element. To access the width of the General Section (GENSEC) supporting the ANCI, the syntax 'VVAL( !WIDTH)' can be included into the expression. The profile width in this context is the width of the GENSEC face below the ANCI depending on the profile rotation and may not necessarily correspond to the catalog property WIDT. If the evaluation of the rule expression fails, then the explicitly set default value is used instead. To add a new rule to the list of available rules, click Add Entry to display the Add Entry window. You can populate the Support Codes and X-Size Rule or Y-Size Rule fields with the relevant rule values. Click OK to add the rule to the list of available rules or Cancel to discard any changes and close the Add Entry window. Click Remove Entry to delete the currently selected rule. Reset Supports Compensation Sizes Apply Save Work Cancel Supports Compensation Sizes General Rule Default Value Add Entry Add Entry Support Codes X-Size Rule Y-Size Rule OK Cancel Add Entry Remove Entry
Sets the available materials for a compensating plate.
Sets the available materials for a compensating plate. The default values/settings indicated on the window are those that exist when the supports application is first installed. Changes made are only applied to the database when Apply is clicked. To keep the changes the Save Work operation must be performed. Click Cancel to close the window. If changes have been made, but not applied, a window displays asking if the changes are to be applied before exiting. The Supports Compensation Materials window contains two lists, the first lists the different possible choices of materials and the second lists the available materials. To set a material choice, select the appropriate choice from the list of available choices and then select the material for that choice from the list of available materials. Duplicate choices are omitted from the material selection drop-down list in Model. The default choice is the material that is initially set when a compensation is created. It is not possible to remove the default choice. The available materials that can be assigned to a choice are populated from the MDS/PROP database and only solid materials are available for selection. Apply Save Work Cancel Supports Compensation Materials
Multiple Support Catalogs
Sets the current MDU catalog. Multiple copies of the MDU catalog can be created to support the use of different catalogs in a single session. Select a catalog from the MDU drop-down list. Copy MDU Catalog Copies an existing MDU Catalog to support the use of multiple catalogs in a single session. From Select from the drop-down list to define the source MDU catalog to be copied. To Select from the drop-down list to define the target location of the created MDU catalog. Description Input a name for the created MDU catalog. Messages Describes what actions the application is carrying out. Click Cancel to discard any changes and close the MDU Catalog Copy window. Click Apply to copy the MDU catalog, a Confirm window displays informing you that the operation may take considerable time to complete. Click Yes to continue with the copy process. Support Configuration File By default, support configuration files are read from the default path which is the installation directory. The default path can be overwritten by setting the environment variable MDS_SUPPORT_CONFIG_LOCATION. The standard support configuration file is named SupportConfigurationFile.xml. Multiple support configuration files are supported. New support catalogs must follow a defined folder path: A folder named userSupportConfiguration must be added to the %MDS_SUPPORT_CONFIG_LOCATION% path. All configuration information, for example, image files, the support configuration xml file and any other files specific to that support configuration must be stored in a unique configuration specific folder. This folder uses the naming convention Configuration-<MDU DB CODE>. Plot files must be stored in the plots folder which is located in the configuration specific folder. Specific naming conventions must be used, if the internally referenced MDU DB CODE is A, the naming convention is: Configuration specific folder Configuration-A Support configuration file SupportConfiguration-A.xml Folder for configuration specific plot files plots Image names & plot file names Same naming convention as existing support standards. Configuration specific folder Configuration-A Support configuration file SupportConfiguration-A.xml Folder for configuration specific plot files plots Image names & plot file names Same naming convention as existing support standards. For example, if the %MDS_SUPPORT_CONFIG_LOCATION% is configured to a folder other than the installation directory, the default configuration xml file (SupportConfiguration.xml) must be located alongside the userSupportConfiguration folder. In the example, the %MDS_SUPPORT_CONFIG_LOCATION% folder is D:\localSupportConfigurations\. The userSupportConfiguration folder contains a folder for each specific configuration. The configuration specific folder contains the plots folder, image files and the support configuration file. The plots folder contains the plot files. A new support catalog that uses the key letter K may require a separate support configuration file, named SupportConfigurationFile-K.xml. The new support configuration file is stored in the configuration specific folder. The DimensionsControlConfiguration id value, in the support configuration file, can be set to the defined key letter. For example: Mapping and representation for a specific support type can be defined. For example, AT510 and AT03. For mapping name "AT510", the image id is "at510". The application searches for the image named at510.png. The image is stored in the same path as the support configuration file. For mapping name "AT03", the image id is "at03". An image file is not found, the application uses the support standard image. If an external image or a support standard image is not found, a blank image displays. <DimensionControlConfiguration id="K"> Note: The Multiple Support Catalogs functionality is only available when all the databases, for example, MDS/CATA(DB No.7320), MDS/MDSAPPDEFAULTS(DB No.7351) and MDU/CATA(DB No.7355) are part of the selected MDB. Note: You are prompted to restart the session for the modifications to take effect. Note : MDU Copy MDU Catalog From To Description Messages Cancel MDU Catalog Copy Apply Confirm Yes Note : Support Configuration File userSupportConfiguration <DimensionControlConfiguration id="K">
Modify User Defined Ancillary Geometry
The Supports application allows you to create a set of ancillary standards with their own geometry. Configuration of standards dimensionally is covered in Ancillary Data. The user defined ancillary standards comprise a number of support types. The table displays the user defined ancillary types that have been created that can be configured geometrically: From To AT Ancillary AT500 AT700 201 LT Lug LT500 LT700 201 BT U-Bolt BT500 BT700 201 AN Anchor for shoes AN500 AN569 70 AN Anchor for pipes AN570 AN639 70 AN Anchor for trunnions AN640 GT700 61 GT Guide for shoes GT500 GT569 70 GT Guide for pipes GT570 GT639 70 GT Guide for trunnions GT640 GT700 61 ST Stops for shoes ST500 ST569 70 ST Stops for pipes ST570 ST639 70 ST Stops for trunnions ST640 ST700 61 AC Ancillary Components for Trunnions AC500 AC599 100 AC Plate Component for Trunnions AC600 AC700 101 CA Cable Tray Ancillaries CA500 CA700 201 The ability to create the user defined ancillary types is achieved by supports being configured to use a blank set of ancillaries, so that users can complete their own geometry. A user project called MDU is created; a hierarchy /MDU prefix is used instead of the /MDS prefix where applicable. The example displays how this is implemented into a supports project environment. The MDU project has the geometry and point sets pre-created and linked into the Multi Discipline Supports (MDS) catalog and specification. The geometry sets are empty and the point sets have the minimum p-point requirements. You can then create the geometry within the MDU project and set up any design parameters required for the component. The MDU project only stores geometry, point and data sets for the types and ranges detailed earlier. Ancillary Data Ancillary Data From To
The geometry sets are created in project MDU
The geometry sets are created in project MDU. The examples display what is added and details any properties that are used. You can add geometry using the properties if required and add additional properties as necessary. Simple Box Representation The box is set to a length of 10, and uses the pipe Outside Diameter (OD) as the X and Y length. The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1. All other design parameters are set to 0 (zero), as indicated in the Properties window. No user editable design parameters have been defined. Anchor for Shoes Simple Anchor Representation These user standards ask for a pipe shoe to be identified so it can read the shoe parameters Shoe Height and Flange Width in order to size the anchor. It then asks for a section or box to be identified to read the anchor width across the section of box. The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1, 100, 102 and 133.2. All other design parameters are set to 0 (zero), as indicated in the Properties window. Design parameters 1, 2 and 3 have been declared as user editable (with an allowable range of 0 to 1000) and default values have been added. Anchor for Pipes Simple Box Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1. All other design parameters are set to 0 (zero), as indicated in the Properties window. No user editable design parameters have been defined. Guide for Shoes Simple Guide Representation These user standards ask for a pipe shoe to be identified so it can read the shoe parameters Shoe Height and Flange Width in order to size the guide. The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1, 100 and 102. All other design parameters are set to 0 (zero), as indicated in the Properties window. Design parameters 1, 2, 3 and 4 have been declared as user editable (with an allowable range of 0 to 1000) and default values have been added. Guide for Pipes Simple Guide Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1 and 0. All other design parameters are set to 0 (zero), as indicated in the Properties window. Stop for Shoes Simple Stop Representation These user standards ask for a pipe shoe to be identified so it can read the shoe parameters Shoe Height and Flange Width in order to size the Anchor. It then asks for a section or box to be identified to read the anchor width across the section of box. The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1, 100 102 and 133.2. All other design parameters are set to 0 (zero), as indicated in Properties window. Design parameters 1, 2 and 3 have been declared as user editable (with an allowable range of 0 to 1000) and default values have been added. Stop for Pipes Simple Box Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1. All other design parameters are set to 0 (zero) as indicated in the Properties window. Anchor for Trunnions Simple Anchor Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset. The Plate Length, Plate Width and Plate Thickness are obtained from the identified Base Plate. All other design parameters are set to 0 (zero) as indicated in the Properties window. Design parameters 1, 2 and 3 have been declared as user editable (with an allowable range of 0 to 1000) and default values have been added. Stop for Trunnions Simple Stop Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset. The Plate Length, Plate Width and Plate Thickness are obtained from the identified base plate. All other design parameters are set to 0 (zero) as indicated in the Properties window. Design parameters 1, 2 and 3 have been declared as user editable (with an allowable range of 0 to 1000) and default values have been added. Guide for Trunnions Simple Guide Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset. The Plate Length, Plate Width and Plate Thickness are obtained from the identified base plate. All other design parameters are set to 0 (zero) as indicated in the Properties window. Design parameters 1, 2 and 3 have been declared as user editable (with an allowable range of 0 to 1000) and default values have been added. Ancillary Component for Trunnions Simple Ancillary Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1. All other design parameters are set to 0 (zero), as indicated in the Properties window. No user editable design parameters have been defined. Plate Component for Trunnions Simple Plate Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection Type and 25 design parameters have been created. The list displays the parameters that have been preset, for example, to -1. All other design parameters are set to 0 (zero), as indicated in the Properties window. No user editable design parameters have been defined. Cable Tray Ancillaries Simple Cable Tray Ancillary Representation The three standard catalog parameters have been added, Nominal Bore, Outside Diameter and Connection type and 21 design parameters have been created. The design parameters are set to 0 (zero) as indicated in the Properties window. Cable ancillaries do not include Minimum/Maximum Insulation and Minimum/Maximum Temperature parameters. The Outside Diameter is always set to 0 (zero) for cable tray ancillaries. Properties Properties Properties Properties Properties Properties Properties Properties Properties Properties Properties Properties Properties
These have been created with the minimum points required
These have been created with the minimum points required. These are: P-Point Description 1 Arrive point 2 Leave point 3 Bottom of Pipe (BOP) -5mm. For example, bottom of the ancillary geometry -5mm 9 BOP (Including geometry if required). For example, bottom of the ancillary geometry 10 Left of pipe 11 Right of pipe 12 BOP P-Point Description 1 Arrive point 2 Leave point 3 Bottom of Pipe (BOP) -5mm. For example, bottom of the ancillary geometry -5mm 9 BOP (Including geometry if required). For example, bottom of the ancillary geometry 10 Left of pipe 11 Right of pipe 12 BOP The diagram displays the position and directions of the p-points, P1 and P2 are arriving and leave points along the centerline of the pipe. Note: The default p-points provided cannot be deleted or modified, but additional p-points can be created if required. Note :
created with the minimum number of elements required
These have been created with the minimum number of elements required. These are: /Prefix-DESC Support standard DESC 'AT500' /Prefix-RNAM Standard Replacement Name RNAM (BEF (AFT (ATTRIB PPRO of DATA /MDS/ATTA/DEFAULTS/AT500/GEN/CCOD , ‘(‘’’) , ‘’’ )’ ) ) /Prefix-PA1 Nominal Bore NB PARA 1 /Prefix-PA2 Outside Diameter OD PARA 2 /Prefix-PA3 Connection Type CONN PARA 3 /Prefix-WEIG Component Weight WEIG (ATTRIB DENS of 1 OF 1 of :MDSMatRef * ATTRIB NVOL / 1000 / 1000 / 1000 * VVAL !!MDSWEIUNIT) /Prefix-MATR Component Material MATR (ATTRIB DESC of :MDSMatRef) /Prefix-CODE Support Code CODE (TRIM ( DIST ( NOMBORE ( false , ATTRIB CPAR[1 ] ) , false , false , true , 4 , false ) ) + '-' + ATTRIB PROPRNAM) /Prefix-CDES MDS Configurable Description CDES (BEF (AFT (ATTRIB PPRO of DATA /MDS/ATTA/DEFAULTS/AT500/GEN/DESC , ‘( ‘’’ ) ‘’’ ) ) ) /Prefix-DP1 Design Parameter 1 Unset DESP[1] Where /Prefix is /Standard-DATA-, for example, /AT500-DATA-DESC and the standard used is AT500 You can add/modify the data set as necessary.
The catalog items
The catalog items for the user defined ancillaries have been created in the ranges detailed within the MDU project. The MDU project contains all the catalog elements, For example, SCOM, 3D Geomset Elemen (GMSE), Pointset Element (PTSE), Data Set (DTSE) and SDTE, where the user modifies the GMSE to suit their requirements. The specification components for ALL the user defined ancillaries are in the /MDS specification in the Multi Discipline Supports (MDS) project, which must not be modified by users. From To From To AT Ancillary AT01 AT115 AT500 AT700 LT Lug LT01 LT16 LT500 LT700 BT U-Bolt BT01 BT11 BT500 BT700 AN Anchor AN01 AN18 AN500 AN700 GT Guide GT01 GT50 GT500 GT700 ST Stop ST01 ST33 ST500 ST700 The MDU project catalog hierarchy has been created for a size range of 8mm (1/4") to 1200mm (48") in the bore sizes that display: 8 1/4 13.7 14 15 3/8 21.3 21 20 1/2 26.7 26 25 1 33.4 33 32 1.1/4 42.2 42 40 1.1/2 48.3 48 50 2 60.3 61 65 2.1/2 73 73 80 3 88.9 89 100 4 114.3 115 125 5 141.3 141 150 6 168.3 169 200 8 219.1 220 250 10 273 273 300 12 323.8 324 350 14 355.6 358 400 16 406.4 407 450 18 457 457 500 20 508 508 550 22 559 559 600 24 610 610 650 26 660 660 700 28 711 711 750 30 762 762 800 32 813 813 850 34 864 864 900 36 914 914 950 38 965 965 1000 40 1016 1016 1050 42 1067 1067 1100 44 1118 1118 1150 46 1168 1168 1200 48 1219 1219 MDS MDS
Teh standard pipework in Aveva Catalog
You can use the standard pipework application in AVEVA Catalog to modify the required elements within the MDU catalog database. For example, MDU/CATA <dbnum7355,dbfile%MDU000/mdu7355>. Within the MDU project, the following should not be deleted or modified (including name change): CATREF (Catalog Reference) PTREF (P-Point Set Reference) (refer to the Note for further information) GMREF (Geometry Set Reference) (refer to the Note for further information) DTREF (Data Set Reference) (refer to the Note for further information) CATREF (Catalog Reference) PTREF (P-Point Set Reference) (refer to the Note for further information) GMREF (Geometry Set Reference) (refer to the Note for further information) DTREF (Data Set Reference) (refer to the Note for further information) Note: Although the MDU default p-points provided cannot be deleted or modified, additional p-points can be created. Also, geometry can be added to the geometry sets, and additional properties included as necessary Note :
Support Standards
Various Support Standards are available.
The standards are available in the Supports application
The standards are available in the Supports application, but are automatically created when creating an ancillary standard (refer to Ancillaries for further information). The standards marked with a * are not available in the Supports application. These standards are obsolete and have been replaced by other new standards. AC01* XAC01 Forged eye rod. AC02* XAC02 Fully threaded rod. AC03* XAC03 Turnbuckle. AC04* XAC04 Clevis. AC05* XAC05 Weldless eye nut (bow). AC06* XAC06 Beam welding attachment. AC07* XAC07 Welding lug. AC08* XAC08 Clevis plate. AC09* XAC09 Spherical washer. AC10 XAC10 Pipe clamp (light). AC11* XAC11 Pipe clamp (heavy). AC12* XAC12 Pipe clamp for insulated pipe (light). AC13* XAC13 Pipe clamp for insulated pipe (heavy). AC14* XAC14 Pipe clamp for Cu-Ni pipe. AC15* XAC15 Pipe clamp for insulated Cu-Ni pipe. AC16* XAC16 Riser clamp. AC17 XAC17 Vessel Support Lug AC18A XAC18A Base Plate AC18B XAC18B Base Plate AC19A XAC19A Bearing Plate AC19B XAC19B Bearing Plate AC20 XAC20 Collar AC21 XAC21 Base plate for RTJ Joints AC22 XAC22 Bolt on base support AC24 XAC24 Reinforcing Pad AC25 XAC25 Dummy branch end plate AC27 XAC27 Break Out Plates with Shim AC28 XAC28 Strap On Clamp for RTR Pipe AC29 XAC29 Bolted Clamp Assembly AC30 XAC30 Adjustable Baseplate AC31 XAC31 Anchor Bolted Clamp Assembly AC32 XAC32 Break Out Plates with Shim AC33 XAC33 End Plate for Rod Hanger Trunnion AC34 XAC34 Reinforcing Pad AC35 XAC35 Pipe Clamp AC36 XAC36 U Strap AC37 XAC37 Pipe Riser Clamp AC38 XAC38 Guide Trunnions AC39 XAC39 Isolation Block Acoustic/General for Trunnion XTT23 AC40 XAC40 General Slide Unit for Trunnion XTT23 AC41 XAC41 Cold Isolation Block for Trunnion XTT23 AC44 XAC44 Clamp for Trunnions for Diam 2" to 24" AC45 XAC45 Clamp for Dummy Legs for Diam 2" to 24" AC46 XAC46 LTCS Upper Break Out Plate for Trunnion XTT23 AC47 XAC47 CS Base Plate for Trunnion XTT23 AC48 XAC48 CS Lower Break Out Plate for Trunnion XTT23 AC49 XAC49 Base Plate 1.1/2" to 16" AC50 XAC50 End Plate 2" to 24" AC51 XAC51 Support Plate 2" to 24" AC52 XAC52 Stiffener 2" to 24" AC53 XAC53 GRE Pipe Clamps for diam 1.1/2" to 40" AC54 XAC54 CPVC Pipe Clamps for diam 1.1/2" to 12" AC55 XAC55 4 Bolt Clamp for Trunnions diam 2.1/2" to 24" AC56 XAC56 Base Plate Circular AC57 XAC57 Adjustable Trunnion Base Plate 1.1/2" to 24" AC58 XAC58 Pipe Clamp for Trunnions - DN 20-250 AC59 XAC59 Base Plate for Trunnions - DN 20-250 Ancillaries Ancillaries
The standards are available in the Supports application user defined anchor standard
The standards are available in the Supports application. The standards marked with a * are not available in the Supports application. These standards are obsolete and have been replaced by other new standards. Refer to Modify User Defined Ancillary Geometry for further information on user defined anchor standards. AN01A* XAN01A Pedestal Anchor Type A. AN01B* XAN01B Pedestal Anchor Type B. AN02 XAN02 Pipe Shoe Anchor. AN03 XAN03 Pipe Shoe Anchor. AN04 XAN04 Bolted Anchor shoe for Hot insulated pipe or temp transport NPS 2-36. AN05 XAN05 Temporary restraint NPS 2-20. AN06 XAN06 Bolt on Shoe w/Directional Anchor Cold (Cryogenic) Service (50/100mm Insu) NPS 3 - 48 AN07A XAN07 Anchor U Bolt (AB) Black, NPS 2 - 20. AN07B XAN07 Anchor U Bolt (AG) Galvanised, NPS 2 - 20. AN07C XAN07 Anchor U Bolt (AP) Plastic Coated, NPS 2 - 20. AN08 XAN08 Pipe Clamp Anchor For RTR Pipe NPS 2-24. AN09 XAN09 Overstrap Anchor (C.S./Alloy Pipes) NPS 1/2- 20 AN10 XAN10 Directional Anchor NPS 1-36. AN11 XAN11 Bolt On Anchor For Galvanised Pipe NPS 6-12. AN12A XAN12A Flat Clamp for CS pipes NPS 1.1/2-16. AN12B XAN12B Flat Clamp with Neoprene Sleeve for SS pipes NPS 1.1/2-16. AN13 XAN13 HALFEN Anchor HCS RADV NPS 1" 6" AN17 XAN17 Anchor U Bolt for Cupro Nickel Lines, NPS 1/2- 8. AN18 XAN18 Anchor U Bolt for Carbon Steel Lines, NPS 1/2- 8. AN19 XAN19 Anchor - DN 15-1400 AN20 XAN20 U-Bolt Anchor AN21 XAN21 Anchor Low AN22 XAN22 Anchor Low AN23 XAN23 Anchor Low 2-Sided AN24 XAN24 Anchor Low 2-Sided AN25 XAN25 Anchor High AN26 XAN26 Anchor High 2-Sided AN27 XAN27 Anchor High AN28 XAN28 Anchor High 2-Sided AN29 XAN29 Anchor High AN30 XAN30 Anchor High 2-Sided AN31 XAN31 Anchor Extra High AN32 XAN32 Anchor Extra High 2-Sided AN33 XAN33 Anchor Extra High AN34 XAN34 Anchor Extra High 2-Sided AN35 XAN35 Anchor Extra High AN36 XAN36 Anchor Extra High 2-sided AN37 XAN37 U-Bolt Guide AN38 XAN38 Anchor Low AN39 XAN39 Anchor Low 2-Sided Modify User Defined Ancillary Geometry Modify User Defined Ancillary Geometry
The standards are available in the Supports application User Defined Ancillary Standards.
The standards are available in the Supports application. The standards marked with a * are not available in the Supports application. These standards are obsolete and have been replaced by other new standards. Refer to Modify User Defined Ancillary Geometry for further information on User Defined Ancillary Standards. PIPE-REST XRT01 Pipe Rest PIPE-REST-INLINE XRT02 Pipe Rest Inline for Trunnions AT01 XAT001 Pipe shoe for N.B. 3/4" to 20" AT02 XAT002 Pipe shoe for N.B. 24" to 48" AT03 XAT003 Clamp on pipe shoe for N.B. 3/4" to 20" AT04 XAT004 Clamp on pipe shoe for N.B. for pipe Cu-Ni 2" to 20" AT05 XAT005 Reinforcing plate (cut from pipe) AT06 XAT006 Clamp on pipe shoe for stainless or galvanised pipe AT07 XAT007 Pipe shoe with reinforcing plate for N.B. 3/4" to 20" AT08 XAT008 Pipe shoe with reinforcing plate for N.B. 24" to 48" AT09 XAT009 Reinforcing plate (cut from plate) AT10A* XAT10A Pedestal support for elbows (type A) AT10B* XAT10B Pedestal support for tube (type B) AT11A* XAT11A Adjustable pedestal support for elbows (type A) AT11B* XAT11B Adjustable pedestal support for tube (type B) AT12 XAT012 Shoe for C.S. Pipe. Hot Service (63mm Maximum Insu.) NPS 2"-36" AT13 XAT013 Shoe for C.S. Pipe. Hot Service (75mm/100mm Insu.) NPS 2"-36" AT14 XAT014 Shoe for Low Temp C.S. Pipe. Inter. Service to -46 c (75mm/100mm Insu.) NPS 2"-36" AT15 XAT015 Shoe for Low Temp C.S. Pipe. Inter. Service to -46 c (63mm Maximum Insu.) NPS 2"-36" AT16 XAT016 Bolt on Shoe, Heat Insulated & Uninsulated C.S. NPS 2"-32" AT17 XAT017 Shoe for RTR Pipe, NPS 2-14 AT18 XAT018 Shoe for Low Temp S.S. Pipe. Inter. Service <-46 c (63mm Maximum Insu.) NPS 2"-36" AT19 XAT019 Shoe for Low Temp S.S. Pipe. Inter. Service <-46 c (75mm/100mm Insu.) NPS 2"-36" AT20 XAT020 Clamp on shoe for Cu-Ni NPS 2 - 24 AT21 XAT021 Pipe Guide for reciprocating Compressor Pipe 2" to 24" AT22 XAT022 Temporary Transport Anchor for NPS 6-36 Uninsulated C.S. AT23 XAT023 Welded Cradle Support for Uninsulated Pipe or Shoe, NPS 2 1/2 - 36 AT24 XAT024 Cradle for RTR Pipe NPS 2 - 4 AT25 XAT025 Bolt On Shoe Cold (Cryogenic) Service (25mm/100mm Insu.) NPS 3" - 48" AT26 XAT026 Cradle for Cold Service (30 - 150mm Insulation), NPS 1/2 - 2. AT27 XAT027 Hanger Clamp for RTR Pipe NPS 2 - 24. AT28 XAT028 U Bolt Guide for RTR pipe NPS 2 - 24. AT29A XAT029A Reinforcing Pad for straight pipe for C.S. pipe. AT29B XAT029B Reinforcing Pad for elbow for C.S. pipe. AT30 XAT030 Special Shim Assembly for Sloping Lines NPS 2-36 AT31A XAT031A Reinforcing Pad for straight pipe for High Alloy/SST pipe. AT31B XAT031B Reinforcing Pad for elbow for High Alloy/SST pipe. AT32 XAT032 Pipe Strap (Lined) for Galv. and S.S Lines NPS 1.1/2 - 8 AT33A XAT033A Trunnion Isolation Pad(Type A - 140mm x 140mm) -Acoustic/General - NPS 1/2 - 24 AT33B XAT033B Trunnion Isolation Pad(Type B - 140mm x 250mm) - Acoustic/General - NPS 1/2 - 24 AT33C XAT033C Trunnion Isolation Pad(Type C - 140mm x 300mm) - Acoustic/General - NPS 1/2 - 24 AT33D XAT033D Trunnion Isolation Pad(Type D - 200mm x 200mm) - Acoustic/General - NPS 1/2 - 24 AT33E XAT033E Trunnion Isolation Pad(Type E - 250mm x 250mm) - Acoustic/General - NPS 1/2 - 24 AT33F XAT033F Trunnion Isolation Pad(Type F - Variable Size) - Acoustic/General - NPS 1/2 - 24 AT34A XAT034A Trunnion Slide Unit(Type A - 140mm x 140mm) - General - NPS 1/2 - 24 AT34B XAT034B Trunnion Slide Unit(Type B - 140mm x 250mm) - General - NPS 1/2 - 24 AT34C XAT034C Trunnion Slide Unit(Type C - 140mm x 300mm) - General - NPS 1/2 - 24 AT34D XAT034D Trunnion Slide Unit(Type D - 200mm x 200mm) - General - NPS 1/2 -24 AT34E XAT034E Trunnion Slide Unit(Type E - 250mm x 250mm) - General - NPS 1/2 - 24 AT34F XAT034F Trunnion Slide Unit(Type F - Variable Size) - General - NPS 1/2 - 24 AT35 XAT035 Cold Isolation Block with CS Cage for Trunnion XTT23 AT36 XAT036 Tico Isolation Wrap - Temp. -40 to +100 deg.C (C.S./Alloy/Cu-Ni Pipes) - NPS 1/2 - 24. AT37 XAT037 Tico Isolation Wrap - Temp. +101 to +150 deg.C (C.S./Alloy/Cu-Ni Pipes) - NPS 1/2 - 24. AT38 XAT038 Bonded Neoprene Rubber Isolation Wrap - Temp. -40 to +100 deg.C (CS/Alloy/Cu-Ni Pipes) - NPS 1/2 - 24 AT39 XAT039 Bonded Viton Rubber Isolation Wrap - Temp. +101 to +150 deg.C (CS/Alloy/Cu-Ni Pipes) - NPS 1/2 -24 AT40A XAT040A Isolation Pad(Type A - 140mm x 140mm) - Acoustic/General - NPS 1/2 - 24 AT40B XAT040B Isolation Pad(Type B - 140mm x 250mm) - Acoustic/General - NPS 1/2 - 24 AT40C XAT040C Isolation Pad(Type C - 140mm x 300mm) - Acoustic/General - NPS 1/2 - 24 AT40D XAT040D Isolation Pad(Type D - 200mm x 200mm) - Acoustic/General - NPS 1/2 - 24 AT40E XAT040E Isolation Pad(Type E - 250mm x 250mm) - Acoustic/General - NPS 1/2 - 24 AT40F XAT040F Isolation Pad(Type F - Variable Size) - Acoustic/General - NPS 1/2 - 24 AT41A XAT041A Slide Unit(Type A - 140mm x 140mm) - General - NPS 1/2 - 24 AT41B XAT041B Slide Unit(Type B - 140mm x 250mm) - General - NPS 1/2 - 24 AT41C XAT041C Slide Unit(Type C - 140mm x 300mm) - General - NPS 1/2 - 24 AT41D XAT041D Slide Unit(Type D - 200mm x 200mm) - General - NPS 1/2 - 24 AT41E XAT041E Slide Unit(Type E - 250mm x 250mm) - General - NPS 1/2 - 24 AT41F XAT041F Slide Unit(Type F - Variable Size) - General - NPS 1/2 - 24 AT42 XAT042 PTFE Isolation Pad - Bonded to Steel - NPS 1.1/2 - 24 AT43 XAT043 Pipe Penetration Single Seal (Packed) - Certified A0 & H0 Rating NPS 1/2 - 24 AT44 XAT044 Pipe Penetration Single Seal (Packed) - Certified A60 & H60 Rating - NPS 1/2 - 24 AT45 XAT045 Pipe Penetration Double Seal - Certified A0 & H0 Rating w/o Insulation & A60 H60 & H120 Rating with Insulation, NPS 1/2 - 24 AT46 XAT046 Pipe Penetration Double Seal - Certified upto J100 Jet Fire Resistance & A60 H60 & H120 Rating NPS 1/2 - 24 AT47 XAT047 Cold Isolation Shoe (C.S./Alloy Pipes) NPS 2 - 8 AT48 XAT048 Cold Isolation Shoe (C.S./Alloy Pipes) NPS 10 - 24 AT49 XAT049 2 Bolt Heavy Series Pipe Clamp with Circular Cold Isolation Block (CS/Alloy Pipes) - NPS 1/2 - 24 AT50 XAT050 Reinforcing Pad for Horizontal and Vertical Cu-Ni Pipes - NPS 2.1/2 - 24 AT51 XAT051 Full Encirclement Reinforcing Sleeve for Cu-Ni Pipes - NPS 2.1/2 - 24 AT52A XAT052A Type A Protection Shield for Diam 2" to 24" AT52B XAT052B Type B Protection Shield for Diam 2" to 24" AT52C XAT052C Type C Protection Shield for Diam 2" to 24" AT52D XAT052D Type D Protection Shield for Diam 2" to 24" AT52E XAT052E Type E Protection Shield for Diam 2" to 24" AT52F XAT052F Type F Protection Shield for Diam 2" to 24" AT53A XAT053A Type A 4 Point Shear Lug Bearing for Diam 2" to 24" AT53B XAT053B Type B 2 Point Shear Lug Bearing for Diam 2" to 24" AT54 XAT054 HP Mud and Cement High Pressure Clamps for Diam 2" to 6" AT55A XAT055A Bolt on Shoe type A Uninsulated C.S. NPS 2"-6" AT55B XAT055B Bolt on Shoe type B Uninsulated C.S. NPS 2"-6" AT55C XAT055C Bolt on Shoe type C Uninsulated C.S. NPS 8"-24" AT56 XAT056 Clamp for Vertical support NPS 2" to 8" AT57 XAT057 HALFEN Pipe Shoe HRG-4 NPS 1/2" - 6" AT58 XAT058 HALFEN Pipe Shoe HRG - 4 with Spacer Clip HCS AHS 5/1 NPS 1/2" - 6" AT59 XAT059 Trunnion Cold Isolation Block with Integral Base Plate Light AT60 XAT060 Flanged Supports for FRP/RTR Lines 1" - 32" AT61 XAT061 Plate Attachment - Vertical Pipe (CS, LTCS, SS Pipes) - NPS 12"-48" AT62 XAT062 Adjustable Guide Insert Bolts Parallel NPS 2"-48" AT63 XAT063 Pipe Strap (Lined) for FRP / RTR Lines NPS 1 - 8 AT64 XAT064 Pipe Strap (Lined) for CuNi Lines NPS 1.1/2 - 8 AT65 XAT065 Full Encirclement Wrapper Plate (no longitudinal welding) for Pipes - NPS 2 - 48 AT66 XAT066 Stauff Clamp Heavy Series SPAL **,***,* xxx DPAL-AS NPS 1/2 - 6" AT67 XAT067 Stauff Clamp Heavy Series SPAL/DUB **,***,* xxx DPAL-AS NPS 1/2" - 6" AT68 XAT068 Trunnion Cold Isolation Block with Integral Base Plate Heavy AT69 XAT069 Adjustable Guide Insert Bolts Perpendicular - NPS 2"-48" AT70 XAT070 Adjustable Guide Insert Offset to Pipe Bolts Parallel - NPS 2"-48" AT71 XAT071 Adjustable Guide Insert Offset to Pipe Bolts Perpendicular - NPS 2"-48" AT72 XAT072 CPVC Pipe shoes height 100 to 200 for diam 1-1/2" to 24" AT73 XAT073 GRE Pipe shoes height 100 to 200 for diam 26" to 40" AT74A XAT074A CPVC Protection shield for diam 1/2" to 16" TYPE A AT74B XAT074B CPVC Protection shield for diam 1/2" to 16" TYPE B AT75A XAT075A Anti friction sliding plate for diam 1/2" to 40" TYPE A AT75B XAT075B Anti friction sliding plate for diam 1/2" to 40" TYPE B AT76 XAT076 Pipe Shoe NPS 18"-20" AT87 XAT087 GRE Pipe shoes height 100 to 200 for diam 1-1/2" to 24" AT88 XAT088 DN8 - DN50 - Single sided Pipe Slide AT93 XAT093 GRE Pipe Clamps for diam 1.1/2" to 40" AT94 XAT094 CPVC Pipe Clamps for diam 1.1/2" to 12" AT95A XAT095A GRE Protection shield for diam 1/2" to 16" TYPE A AT95B XAT095B GRE Protection shield for diam 1/2" to 16" TYPE B AT96 XAT096 Welded Shoe for N.P.S. 1" - 36" AT97 XAT097 Clamped Shoe (Unlined) for N.P.S. 1" - 24" AT98 XAT098 Welded Shoe with re-pad for N.P.S. 1" - 36" AT99 XAT099 Clamped Shoe (Lined) for N.P.S. 1" - 24" AT100A XAT100A Trunnion Ptfe Faced Slide Unit (Suitable for Acoustic & Vibration Isolation) Type A - NPS 1/2 - 24 AT100B XAT100B Trunnion Ptfe Faced Slide Unit (Suitable for Acoustic & Vibration Isolation) Type B - NPS 1/2 - 24 AT101A XAT101A Ptfe Faced Slide Unit (Suitable for Acoustic & Vibration Isolation) Type A - NPS 1/2 - 24 AT101B XAT101B Ptfe Faced Slide Unit (Suitable for Acoustic & Vibration Isolation) Type B - NPS 1/2 - 24 AT102 XAT102 Pipe Strap AT103A XAT103A Clamped Pipe Shoe Pihasa 2134 IPE 160 NPS 1/2 - 4 AT103B XAT103B Clamped Pipe Shoe Pihasa 2134 IPE 200 NPS 1/2 - 16 AT103C XAT103C Clamped Pipe Shoe Pihasa 2134 IPE 240 NPS 3 - 16 AT103D XAT103D Clamped Pipe Shoe Pihasa 2134 IPE 270 NPS 5 - 16 AT104A XAT104A Clamped Pipe Shoe Pihasa 2136 Small NPS 1.1/2 - 30 AT104B XAT104B Clamped Pipe Shoe Pihasa 2136 Large NPS 1.1/2 - 30 AT105A XAT105A Reinforcing Pad for straight pipe/elbow for C.S. pipe. AT105B XAT105B Reinforcing Pad for straight pipe/elbow for C.S. pipe. AT108A XAT108A Lisega Type 49xx11 Pipe Clamp Base 0 to 350 deg.C - NPS 15 - 150 AT108B XAT108B Lisega Type 49xx12 Pipe Clamp Base - 0 to 350 deg.C - NPS 15 - 125 AT108C XAT108C Lisega Type 49xx13 Pipe Clamp Base - 0 to 350 deg.C - NPS 175 - 1000 AT108D XAT108D Lisega Type 49xx14 Pipe Clamp Base - 0 to 350 deg.C - NPS 15 - 900 AT108E XAT108E Lisega Type 49xx25 Pipe Clamp Base - 350 to 500 deg.C - NPS 15 - 900 AT108F XAT108F Lisega Type 49xx35 Pipe Clamp Base - 450 to 560 deg.C - NPS 15 - 900 AT108G XAT108G Lisega Type 49xx45 Pipe Clamp Base - 560 to 600 deg.C - NPS 15 - 900 AT108H XAT108H Lisega Type 49xx64 Pipe Clamp Base - 100 to 350 deg.C - NPS 15 - 125 AT108AX XAT108AX Lisega Type 49xx11 (Larger Pipe Outside Diameter) Pipe Clamp Base - 0 to 350 deg.C - NPS 65,100,125,150 - ONLY AT108BX XAT108BX Lisega Type 49xx12 (Larger Pipe Outside Diameter) Pipe Clamp Base - 0 to 350 deg.C - NPS 65,100,125 - ONLY AT108CX XAT108CX Lisega Type 49xx13 (Larger Pipe Outside Diameter) Pipe Clamp Base - 0 to 350 deg.C - NPS 250,350,400 - ONLY AT108DX XAT108DX Lisega Type 49xx14 (Larger Pipe Outside Diameter) Pipe Clamp Base - 0 to 350 deg.C - NPS 65,100,125,150,250,350,400 - ONLY AT108EX XAT108EX Lisega Type 49xx25 (Larger Pipe Outside Diameter) Pipe Clamp Base - 350 to 500 deg.C - NPS 65,100,125,150,250,350,400 - ONLY AT108FX XAT108FX Lisega Type 49xx35 (Larger Pipe Outside Diameter) Pipe Clamp Base - 450 to 560 deg.C - NPS 65,100,125,150,250,350,400 - ONLY AT108GX XAT108GX Lisega Type 49xx45 (Larger Pipe Outside Diameter) Pipe Clamp Base - 560 to 600 deg.C - NPS 65,100,125,150,250,350,400 - ONLY AT108HX XAT108HX Lisega Type 49xx64 (Larger Pipe Outside Diameter) Pipe Clamp Base - 100 to 350 deg.C - NPS 65,100,125 - ONLY AT109 XAT109 Pipe Strap AT111 XAT111 Slider Pad for diam 1/2" to 40" AT112 XAT112 Loose Pipe Strap 1/4" to 36" AT113 XAT113 Pipe Strap 1/4" to 36" AT114 XAT114 Lisega Type 49xx63SP Pipe Clamp base - 0 to 350 deg.C - NPS 175 - 700 AT115 XAT115 Lisega Type 49xx63G Pipe Clamp base - 0 to 350 deg.C - NPS 250,700,900,1000 AT116 XAT116 Double Heavy Vertical Pipe Clamp - DN 15-1400 AT117 XAT117 Double Light Vertical Pipe Clamp - DN 15-1400 AT118 XAT118 Single Light Vertical Pipe Clamp - DN 15-1400 AT119 XAT119 Vertical Pipe Clamp for Spring Cans - DN 15-1400 AT120 XAT120 Single Light Vertical Pipe Clamp - DN 15-1400 AT121 XAT121 Single Heavy Vertical Pipe Clamp - DN15-1400 AT122 XAT122 Double Heavy Vertical Pipe Clamp - DN 15-1400 AT123 XAT123 Single Light Vertical Pipe Clamp - DN 15-1400 AT124 XAT124 Single Light Vertical Pipe Clamp - DN 15-1400 AT125 XAT125 Double Heavy Vertical Pipe Clamp - DN15-1400 AT126 XAT126 Pipe Shoe with Clamps - DN 15-1400 AT127 XAT127 Pipe Shoe with Clamps Cold Insulation - DN 15-800 AT128 XAT128 Pipe Shoe - DN 400-600 AT129 XAT129 Pipe Shoe - DN 650-1000 AT130 XAT130 Pipe Shoe with Clamps - DN 250-450 AT131 XAT131 Pipe Shoe with Clamps - DN 500-1000 AT132 XAT132 Pipe Clamp with Double Shoes - DN 50-1400 AT133 XAT133 Band for Copper Pipe NPS 2.5 - 8 AT134 XAT134 Pipe Strap (lined) NPS 3/8 -1 AT135 XAT135 Sliding Piece (Pipe Welded) NPS 1/2 - 40 AT136 XAT136 Lisega Type 49xx63G1SP Single-sided Pipe Slide - 0 to 350 deg. C - NPS 250,700,900,1000 AT140 XAT140 Clamped Pipe Shoe for S/S,6Mo & Duplex lines. - Temp -130 to 340 deg.C 4" to 24" AT141 XAT141 Welded Pipe Shoe for S/S,6Mo & Duplex lines - Sch10s & below. Heavy Load or Vibration 6" to 24" AT144 XAT144 Welded Pipe Shoe for CS & LTCS lines - 3/4" to 24" AT145 XAT145 Clamped Pipe Shoe for CS & LTCS lines - 3/4" to 36" AT146 XAT146 Welded Pipe Shoe for S/S Lines - 3/4" to 24" AT147 XAT147 Welded Pipe Shoe for Duplex lines - 3/4" to 24" AT148 XAT148 Welded Pipe Shoe for 6Mo lines - 3/4" to 24" AT149 XAT149 Clamped Pipe Shoe for Galv,S/S 6Mo & Duplex lines - 3/4" to 36" AT150 XAT150 Welded Pipe Shoe with Repad for S/S,6Mo and Duplex lines - 3/4" to 24" AT151 XAT151 Welded Pipe Shoe with Repad for CS & LTCS lines - 3/4" to 24" AT152 XAT152 Oglaend Pipe Clamp AISI 316L 1/2" to 2" AT153 XAT153 Oglaend Pipe Clamp AISI 316L 1/2" to 2" AT154 XAT154 Angle bracket for U-Bolt diam 1/2" to 8" AT155 XAT155 Angle bracket for U-Bolt diam 1/2" to 8" AT156 XAT156 Oglaend Pipe Clamp HDG 1/2" to 2" AT157 XAT157 Oglaend Pipe Clamp HDG 1/2" to 2" AT158 XAT158 Clamped Pipe Shoe for FRP Pipe - 2" to 36" AT159 XAT159 Clamped Pipe Shoe for FRP Pipe - 2" to 36" AT160A XAT160 Type A - Clamped Pipe Short Shoe Linestop for FRP Pipe - 2" to 36" AT160B XAT160 Type B - Clamped Pipe Long Shoe Linestop for FRP Pipe - 2" to 36" AT161 XAT161 DN3 - DN20 - Single-sided Pipe Slide AT162 XAT162 DN8 - DN50 - Austenitic Single-sided Pipe Slide AT163 XAT163 DN3 - DN20 - Austenitic Single-sided Pipe Slide AT164 XAT164 Oglaend Single Clamp Shoe - Uninsulated pipe 1" to 6" AT165 XAT165 Oglaend Single Clamp Shoe - Insulated pipe 1/2" to 6" AT166 XAT166 Angle bracket for Pipe Clamp diam 1/2" to 2" AT167 XAT167 Angle bracket for U-Bolt diam 1" to 4" AT168 XAT168 Oglaend Pipe Clamp diam 1/2" to 1.1/2" AT174 XAT174 Full Encirclement Reinforcing pad (cut from pipe) AT175 XAT175 Part Encirclement Reinforcing pad (cut from pipe) AT185 XAT185 Butterfly Valve Support F4 AT211 XAT211 Pipe Slide Low AT212 XAT212 Pipe Slide Low 2-Sided AT213 XAT213 Pipe Slide Low AT214 XAT214 Pipe Slide Low 2-Sided AT215 XAT215 Foot Support A2 AT216 XAT216 Foot Support A3 AT217 XAT217 Pipe Slide Low 3-Sided AT218 XAT218 Pipe Slide Low 3-Sided AT219 XAT219 Foot Support A1 AT220 XAT220 Foot Support B1 AT221 XAT221 Foot Support B2 AT222 XAT222 Foot Support B3 AT223 XAT223 Pipe Slide AT224 XAT224 Pipe Slide AT225 XAT225 Pipe Clamp A AT226 XAT226 Pipe Slide High AT227 XAT227 Pipe Slide High AT228 XAT228 Pipe Slide Low AT229 XAT229 Pipe Slide Low 4-Sided AT230 XAT230 Pipe Slide Low 4-Sided AT231 XAT231 Pipe Slide Extra High AT232 XAT232 Pipe Slide Extra High AT233 XAT233 Pipe Slide High AT234 XAT234 Pipe Slide Extra High AT235 XAT235 Pipe Slide Low 2-Sided AT236 XAT236 Pipe Slide Low 3-Sided AT237 XAT237 Pipe Slide Low 4-Sided AT238 XAT238 Pipe Slide High 2-Sided AT239 XAT239 Pipe Slide High 3-Sided AT240 XAT240 Pipe Slide High 4-Sided AT241 XAT241 Pipe Slide High 2-Sided AT242 XAT242 Pipe Slide High 3-Sided AT243 XAT243 Pipe Slide High 4-Sided AT244 XAT244 Pipe Slide High 2-Sided AT245 XAT245 Pipe Slide High 3-Sided AT246 XAT246 Pipe Slide High 4-Sided AT247 XAT247 Pipe Slide Extra High 2-Sided AT248 XAT248 Pipe Slide Extra High 3-Sided AT249 XAT249 Pipe Slide Extra High 4-Sided AT250 XAT250 Pipe Slide Extra High 2-Sided AT251 XAT251 Pipe Slide Extra High 3-Sided AT252 XAT252 Pipe Slide Extra High 4-Sided AT253 XAT253 Pipe Slide Extra High 2-sided AT254 XAT254 Pipe Slide Extra High 3-sided AT255 XAT255 Pipe Slide Extra High 4-sided AT256 XAT256 Pipe Slide AT257 XAT257 Pipe Slide AT258 XAT258 Pipe Slide AT259 XAT259 Pipe Slide Modify User Defined Ancillary Geometry Modify User Defined Ancillary Geometry
The standards are available in the Supports application BRAN.
The standards are available in the Supports application. BR01 XBR01 2 Way Brace for Open Ended Connection to Pipe. BR02 XBR02 2 Way Brace for Open Ended Connection to Flange. BR03 XBR03 2 Way Bracing for Orifice Connections. BR04 XBR04 4 Way Brace for Open Ended Connection to Pipe. BR05 XBR05 3 Way Brace for Open Ended Connection to Flange. BR06 XBR06 4 Way Brace for Open Ended Connection to Flange. BR07 XBR07 2 Way Brace for Open Ended Connection to Pipe. BR08 XBR08 2 Way Brace for Open Ended Connection to Flange. BR09 XBR09 2 Way Brace for Open Ended Connection to Flange.
The standards are available in the Supports application. Refer to Modify User Defined Ancillary Geometry for further information on user defined U-bolt standards.
The standards are available in the Supports application. Refer to Modify User Defined Ancillary Geometry for further information on user defined U-bolt standards. BT01A XBT01 U Bolt gripped (type A) BT01B XBT01 U Bolt non-gripped (type B) BT02 XBT02 U Bolt tico coated BT03 XBT03 U Bolt PTFE coated insulation BT04A XBT04 U Bolt Guide (GB) Black, NPS 1/2 - 36. BT04B XBT04 U Bolt Guide (GG) Galvanized, NPS 1/2 - 36. BT04C XBT04 U Bolt Guide (GP) Plastic Coated, NPS 1/2 - 36. BT05 XBT05 U Bolt gripped with sleeve, NPS 2 - 24. BT06 XBT06 U Bolt Guide for Cupro Nickel Lines, NPS 1/2 - 8. BT07 XBT07 U Bolt Guide for Carbon Steel Lines, NPS 1/2 - 8. BT09 XBT09 Lined U-Bolt guided 2" TO 8" BT10 XBT10 U Bolt Guide, NPS 1/2 - 36" BT11 XBT11 Loose Type U Bolt Guide, NPS 1/2 - 36" BT12 XBT12 U Bolt for steel pipe, NPS 1/2 - 3" BT13 XBT13 U Bolt for steel pipe, NPS 4 - 32" BT14 XBT14 Expansion U Bolt for steel pipe, NPS 1 - 32" BT15 XBT15 Lined U Bolt NPS 1 1/4 - 2" BT16 XBT16 Lined U Bolt NPS 2 1/2 - 36" BT17 XBT17 U Bolt for use with slip pad NPS 1/2 - 32" BT18 XBT18 U Bolt with Teflon Pad NPS 2 1/2 - 32" BT19 XBT19 Expansion U Bolt with Slip Pad NPS 1 - 32" BT21 XBT21- U Bolt Guide for CS & LTCS Lines - 1/2" to 6" BT22 XBT22- U Bolt Grip for CS & LTCS Lines - 1/2" to 6" BT23 XBT23- U Bolt Guide for Galv,S/S,6Mo & Duplex lines - 1/2" to 6" BT24 XBT24- U Bolt Grip for Galv,S/S,6Mo & Duplex lines - 1/2" to 6" Modify User Defined Ancillary Geometry Modify User Defined Ancillary Geometry
The standards are available in the Supports application for Rack.
The standards are available in the Supports application. RACK-REST XCA01 Rack Rest CA02A XCA02 Cable Clip with Angles CA02B XCA02 Cable Clip
CT01XCT01
The standards are available in the Supports application. CT01 XCT01 'L' Bracket up. CT02 XCT02 'L' Bracket down. CT03 XCT03 'L' Bracket Cantilever. CT04 XCT04 Goal post. CT05 XCT05 Support frame. CT06 XCT06 Cantilever bracket. CT07 XCT07 'T' Post. (Vertical down). CT08 XCT08 'T' Post. (Vertical up).
The standards are available in the Supports application FB01XFB01.
The standards are available in the Supports application. FB01 XFB01 Frame Bracing. FB02 XFB02 Frame Bracing.
The standards are available in the Supports application DT01A1XSU01TICO.
The standards are available in the Supports application. DT01 XDT01 HVAC duct support frame. DT02 XDT02 HVAC duct support frame. DT03 XDT03 HVAC duct cantilever bracket. DT04 XDT04 HVAC duct 'L' bracket.
The standards are available in the Supports application SU01A1XSU01Tico.
The standards are available in the Supports application. SU01A1 XSU01 TICO bondslip unit type A size 1. SU01A2 XSU01 TICO bondslip unit type A size 2. SU01A3 XSU01 TICO bondslip unit type A size 3. SU01A4 XSU01 TICO bondslip unit type A size 4. SU01B1 XSU01 TICO bondslip unit type B size 1. SU01B2 XSU01 TICO bondslip unit type B size 2. SU01B3 XSU01 TICO bondslip unit type B size 3. SU01B4 XSU01 TICO bondslip unit type B size 4. SU01C1 XSU01 TICO bondslip unit type C size 1. SU01C2 XSU01 TICO bondslip unit type C size 2. SU01C3 XSU01 TICO bondslip unit type C size 3. SU01C4 XSU01 TICO bondslip unit type C size 4. SU02A1 XSU02 PTFE. slide unit type A size 1. SU02A2 XSU02 PTFE. slide unit type A size 2. SU02A3 XSU02 PTFE. slide unit type A size 3. SU02A4 XSU02 PTFE. slide unit type A size 4. SU02B1 XSU02 PTFE. slide unit type B size 1. SU02B2 XSU02 PTFE. slide unit type B size 2. SU02B3 XSU02 PTFE. slide unit type B size 3. SU02B4 XSU02 PTFE. slide unit type B size 4. SU02C1 XSU02 PTFE. slide unit type C size 1. SU02C2 XSU02 PTFE. slide unit type C size 2. SU02C3 XSU02 PTFE. slide unit type C size 3. SU02C4 XSU02 PTFE. slide unit type C size 4. SU03 XSU03 Shoe Supports, Teflon Slide Plate (Upper Element) NPS 3-36. SU04 XSU04 Shoe Supports, Teflon Slide Plate NPS 2-36.
The standards are available in the Supports application.
The standards are available in the Supports application. The standards marked with a * are not available in the Supports application. These standards are obsolete and have been replaced by other new standards. TT01* XTT01 Trunnions for straight piping. TT02* XTT02 Trunnions for pipe elbows. TT03* XTT03 Trunnions for CuNi straight piping. TT04 XTT04 Base ELL and Pipe Support NPS 2-36 TT05 XTT05 Base ELL and Pipe Support NPS 2-36 with Bearing Plate TT06 XTT06 Base ELL and Pipe Support Variable NPS 2-36 TT07 XTT07 Base ELL and Pipe Support Variable NPS 2-36 with Bearing Plate TT08 XTT08 Base ELL and Pipe Support for RTJ Spools NPS 2-36 TT09 XTT09 Base ELL and Pipe Support for RTJ Spools NPS 2-36 with Bearing Plate TT10 XTT10 Base Support for RTR Pipe NPS 2-14 TT11 XTT11 Base Support for RTR Pipe NPS 2-14 with Bearing Plate TT12 XTT12 Base Support Bolt On NPS 2-36 TT13 XTT13 Base Support Bolt On with Bearing Plate NPS 2-36 TT14 XTT14 Type A Dummy Extension for Horizontal Pipe NPS 2-36 TT15 XTT15 Type B Dummy Extension for Horizontal Pipe NPS 2-36 TT16 XTT16 Type C Dummy Extension for Horizontal Pipe NPS 2-36 TT17 XTT17 Dummy Extension for Vertical Pipe NPS 2-36 TT18 XTT18 Base Support Adjustable Base NPS 2-24 TT19 XTT19 Base Support Adjustable Base with Bearing Plate NPS 2-8 TT20 XTT20 Support for Relief Valve Discharge Pipe NPS 2-12 TT21 XTT21 Rod Hanger Welded Elbow Trunnion NPS 12-24 TT22 XTT22 Base Support Anchor for RTR Pipe NPS 2-14 TT23 XTT23 Trunnion with an Integral Cold Isolation Block for C.S./Alloy Pipes NPS 1.1/2-20 TT24 XTT24 Trunnion Clamp for Vertical Pipe NPS 2-24 TT25 XTT25 90 Degree Cranked Vertical Dummy Leg for 2" - 24" TT26 XTT26 Vertical Dummy Leg for 2" - 24" TT27 XTT27 Trunnion With Integral Guide for 2" - 24" TT28 XTT28 Base Support Anchor for RTR Pipe NPS 2-14 with Bearing Plate TT29 XTT29 GRE Pipes Vertical Dummy Leg for diam 2" - 24" TT30 XTT30 CPVC Pipes Vertical Dummy Leg for diam 2" - 24" TT31 XTT31 GRE Pipes Trunnion for 2" - 24" TT32 XTT32 CPVC Pipes Trunnion for 2" - 24" TT33 XTT33 GRE Pipes Stanchion for 2" - 24" TT34 XTT34 CPVC Pipes Stanchion for 2" - 24" TT35 XTT35 Vertical Dummy Leg for diam 2" - 24" TT36 XTT36 Trunnion NB 1.1/2" - 30" TT37 XTT37 Adjustable Trunnion NB 2" - 12" TT38 XTT38 Base Support Welded to pipe 2" TO 24" TT39 XTT39 Base Support Welded to elbow 2" TO 24" TT40 XTT40 Trunnion for uninsulated lines - NPS 20-250 TT41 XTT41 Trunnion for uninsulated lines - NPS 20-250 TT42 XTT42- Trunnion for Elbow - 1" to 36" TT43 XTT43- Trunnion for Straight Pipe - 1" to 36" TT44 XTT44- Trunnion with Repad for Straight Pipe - 1" to 36"
The standards are available in the Supports application VT01XVT01.
The standards are available in the Supports application. VT01 XVT01 Support from vessel for 2" to 10" N.B. Pipe. VT02 XVT02 Support from vessel for 12" to 20" N.B. Pipe. VT03 XVT03 Guide from vessel for 8" to 20" N.B. Insulated Pipe. VT04 XVT04 Guide from vessel for 8" to 24" N.B. Pipe. VT05 XVT05 Support from vessel for 2" to 6" N.B. Pipe. VT06 XVT06 Guide from vessel for 2" to 4" N.B. Pipe. VT07 XVT07 Support Bracket Uninsulated Pipe NPS 2 - 10 VT08 XVT08 Support Bracket Insulated/Uninsulated Pipe NPS 6 - 18 VT09 XVT09 Support Bracket Uninsulated Pipe NPS 8 - 18 VT10 XVT10 Support Bracket Uninsulated Pipe NPS 2 - 24 VT11 XVT11 Support Bracket Uninsulated Pipe NPS 2 - 4 VT12 XVT12 Support Bracket Guide for Uninsulated Pipe NPS 16 - 24 VT13 XVT13 Support Bracket Guide for Uninsulated CS Pipe NPS 10 - 14 VT14 XVT14 Support Bracket Guide for Uninsulated CS Pipe NPS 6 - 8 VT15 XVT15 Support Bracket Guide for Uninsulated CS Pipe NPS 1/2 - 4 VT16 XVT16 Special Guide for Vertical Pipe in the Splash Zone NPS 3 - 12 VT17 XVT17 Support Bracket Uninsulated/Insulated Pipe NPS 1/2 - 3 VT18 XVT18 Support Bracket Insulated Pipe NPS 3 - 14 VT19 XVT19 Support Bracket Guide for insulated Pipe NPS 16 - 24 VT20 XVT20 Cantilever support from vertical & horizontal vessel for 2" to 10" N.B. Pipe. VT21 XVT21 Braced cantilever support from vertical & horizontal vessel for 2" to 10" N.B. Pipe. VT22 XVT22 Cantilever support from vertical vessel for vertical pipes with lugs LT13 or LT15 2.1/2" to 20" N.B. Pipe. VT23 XVT23 Cantilever support from vertical vessel for vertical pipes with Trunnions 2.1/2" to 14" N.B. Pipe. VT24 XVT24 Cantilever braced support from vertical vessel for vertical pipes with Trunnions 2.1/2" to 14" N.B. Pipe.
Catalogues
You must use the following conventions for structural catalogues so that the Model applications can recognize them and so that the Paragon applications can use them: The diagrams in the following subsection illustrate the structure of the catalogues. The PURPose of the CATAlogue must be set to one of the following: STL, FITT, JOIN or PFIT. This makes sure that any specifications and applications which are built can recognized the correct catalogue element. Thus the steel Profile specification looks for the purpose STL, the Joint specification looks for the purpose JOIN, the Fitting specification looks for the purpose FITT and the Panel Fitting specification looks for the purpose PFIT. A meaningful DESCription is also beneficial. The PURPose of the STSEction must be set to REF for Reference Data, PRFL for Profiles, FITT for Fittings, JOIN for Joints and PFIT for Panel Fittings. The PURPose of the STCAtegory must be set to REF for Reference Data, PRFL for Profiles, FITT for Fittings, JOIN for Joints and PFIT for Panel Fittings. The GTYPE of the Profile, Fitting, Joint or Panel Fitting must be set. This makes sure that specific restrictions can be applied to Joints and Fittings when building the specifications. For example: any Section with a GTYPE set to BEAM can be used with a Joint which has its GTYPE set to BEAM; any Fitting with a GTYPE set to FITT can be used with any Fitting specification. The purpose of a CSTANdard is to let you define in a text string the type of standard that is being used. It is used purely for information and administration of the Catalogue. For example, the CSTANdard for British Sections is BS 5950. The PURPose of the CATAlogue must be set to one of the following: STL, FITT, JOIN or PFIT. This makes sure that any specifications and applications which are built can recognized the correct catalogue element. Thus the steel Profile specification looks for the purpose STL, the Joint specification looks for the purpose JOIN, the Fitting specification looks for the purpose FITT and the Panel Fitting specification looks for the purpose PFIT. A meaningful DESCription is also beneficial. The PURPose of the CATAlogue must be set to one of the following: STL, FITT, JOIN or PFIT. This makes sure that any specifications and applications which are built can recognized the correct catalogue element. Thus the steel Profile specification looks for the purpose STL, the Joint specification looks for the purpose JOIN, the Fitting specification looks for the purpose FITT and the Panel Fitting specification looks for the purpose PFIT. A meaningful DESCription is also beneficial. The PURPose of the STSEction must be set to REF for Reference Data, PRFL for Profiles, FITT for Fittings, JOIN for Joints and PFIT for Panel Fittings. The PURPose of the STSEction must be set to REF for Reference Data, PRFL for Profiles, FITT for Fittings, JOIN for Joints and PFIT for Panel Fittings. The PURPose of the STCAtegory must be set to REF for Reference Data, PRFL for Profiles, FITT for Fittings, JOIN for Joints and PFIT for Panel Fittings. The PURPose of the STCAtegory must be set to REF for Reference Data, PRFL for Profiles, FITT for Fittings, JOIN for Joints and PFIT for Panel Fittings. The GTYPE of the Profile, Fitting, Joint or Panel Fitting must be set. This makes sure that specific restrictions can be applied to Joints and Fittings when building the specifications. For example: any Section with a GTYPE set to BEAM can be used with a Joint which has its GTYPE set to BEAM; any Fitting with a GTYPE set to FITT can be used with any Fitting specification. The GTYPE of the Profile, Fitting, Joint or Panel Fitting must be set. This makes sure that specific restrictions can be applied to Joints and Fittings when building the specifications. For example: any Section with a GTYPE set to BEAM can be used with a Joint which has its GTYPE set to BEAM; any Fitting with a GTYPE set to FITT can be used with any Fitting specification. The purpose of a CSTANdard is to let you define in a text string the type of standard that is being used. It is used purely for information and administration of the Catalogue. For example, the CSTANdard for British Sections is BS 5950. The purpose of a CSTANdard is to let you define in a text string the type of standard that is being used. It is used purely for information and administration of the Catalogue. For example, the CSTANdard for British Sections is BS 5950.
Piping catalogue
As with the piping catalogue, there are many ways in which you can structure your steelwork catalogues. The same two ways of structuring both types of catalogue are preferred, the difference being the types of administrative elements used. However, whereas for piping there is only one type of catalogue (namely for piping components), the following three types of catalogue are used for steelwork: The basic layout of the catalogues is the same as for piping, for example, where the reference data is stored, but the way in which the data is separated differs. PROFILES JOINTS FITTINGS (FITT and PFIT) PROFILES PROFILES JOINTS JOINTS FITTINGS (FITT and PFIT) FITTINGS (FITT and PFIT) The basic layout of the catalogues is the same as for piping, for example, where the reference data is stored, but the way in which the data is separated differs.
Purpose Catalogue
Purpose Purpose should be the same as the SPEC with which the catalogue is to be used (STL, FITT, JOIN, PFIT etc.) Cstandard Catalogue standard STSEction ‑ Structural Section Description Description of Section Gtype- Generic type of element contained in section; this should be the same as the type of element used in MODEL, e.g.BEAM Description Description of Section Gtype- Generic type of element contained in section; this should be the same as the type of element used in MODEL, e.g.BEAM Purpose Purpose should equate to the STYP of the items as defined in the Spec Function Description Gtype Identifies the Generic element type Skey not applicable Ptref Point set reference Gmref Geometry set reference Ngmref Negative geometry reference DataSetRef Data set reference Pstreference Pline set reference Gstreference Profile set reference CDetail Detail reference Ownconn Owning connection profile type Attconn Attached connection profile type CPlot Plot file for reference used in documentation Icon Icon name Cstandard Standard· PTSE ‑ Point Sets Description Description of point set Gtype Identifies the Generic element type Skey Symbol Key to which point set relates Purpose Purpose of point set Description Description of point set Gtype Identifies the Generic element type Skey Symbol Key to which point set relates Purpose Purpose of point set Gtype Identifies the Generic element type Purpose Purpose of geometry set NGMS ‑ Negative Geometry Sets Description Description of geometry set Gtype Identifies the Generic element type Purpose Purpose of geometry set Description Description of geometry set Gtype Identifies the Generic element type Purpose Purpose of geometry set DTSE - Datasets Description Description of dataset Gtype Identifies the Generic element type Purpose Purpose of dataset Description Description of dataset Gtype Identifies the Generic element type Purpose Purpose of dataset Gtype Identifies the Generic element type Purpose Purpose of point set Gtype Identifies the Generic element type Purpose Purpose of geometry structural set
Datasets
The general purpose of Datasets is twofold: Refer to Catalogues and Specifications Reference Manual Section 3 for further information. To let you query catalogue parameters. To let you input design parameters via simple forms and menus. To let you query catalogue parameters. To let you query catalogue parameters. To let you input design parameters via simple forms and menus. To let you input design parameters via simple forms and menus. Section 3
the profile catalogue
The Profile catalogue should be structured so that the separation of the data is sensible, for example, all sections of the same generic profile should be under the structural section. The segregation beneath the section should be used to associate groups within the generic type; for example, in the case of British Standards, each category should contain sections with the same serial size, whereas in DIN standards the same class should be used (IPE, IPB, etc.). In most instances there will only be one profile set and one geometry set for each generic type of profile.
the fittings catalogue
The Fittings catalogue should be structured so that all fittings of a given generic type are stored beneath the same section, for example, lifting lugs, stiffeners, etc. Within each section the fittings should be broken down into groups relating to the profile on which the fitting can be used, for example, I, H, L, COLU, BEAM. The Panel Fitting catalogue should follow the same format as the Fitting catalogue except that the panel fitting element is called a PFIT. except PFIT
the joints catalogue
The Joints catalogue should be structured so that all joints of a given generic type are stored beneath the same section, for example, cleats, endplates, baseplates. Within each section the joints should be broken down into categories relating to the types of sections to which the joint can be connected, for example, I‑I, I‑Chan, I‑L. The generic types of the sections should be stored against Ownconn and Attconn attributes.
Specifications
The following conventions for structural specifications must be followed to make sure that a correct specification is built. The application follows strict rules when building these specifications and reads the specification in a tabulated format. Description should be given at the correct level and any question of Tanswers must be input for the forms and menus to be correctly built. The steelwork specifications work in a different way to piping specifications, where there can be more than one answer. For example, a typical connection for two beams can either be a bolted or welded connection; hence there can be two answers to one question.
panel thickness
Panel thickness availability in the Model module can be controlled via the catalogue Specification mechanism. Using ‘Ans’ ‘Maxans’ attributes on the SPCO can limit the allowable minimum and maximum panel thicknesses. Type Attribute Data Description SPEC Description { str } display on form spec gadget Question THK question for offspring Purpose PLT spec purpose Tquestions thickness specific question for offspring SPCO Ans real min thickness Maxans real max thickness SPEC Description { str } display on form spec gadget Question THK question for offspring Purpose PLT spec purpose Tquestions thickness specific question for offspring SPCO Ans real min thickness Maxans real max thickness Note: The CATREF is not used as the geometry is defined in the Model module. Note : SPEC str SPCO
attributes for specification elements in hierachical order pupose FITT
Attributes for Specification elements in hierarchical order: SPEC Description { str } display on form spec gadget Purpose FITT spec purpose Question TYPE question for offspring Matref { ref } material reference in Property DB SELE Description { str } information on type of profile Tanswer { word } generic type of profile that can own the fitting. ANY will allow a fitting to be used on any profile type. Questions STYP question for offspring SELE Description { str } display on form stype gadget Tanswer { word } sub-type of fitting, for example, LUG, HOLE. SPCO Catref { ref } pointer to HFIT in catalogue Detref { ref } pointer to detail text str ref str word str word ref ref
attributes for specification elements in hierachical order pupose PFIT
Attributes for Specification elements in hierarchical order: SPEC Description { str } display on form spec gadget Purpose PFIT spec purpose Question TYPE question for offspring Matref { ref } material reference in Property DB SELE Description { str } display generic type on form Question STYP question for offspring Tanswer { word } generic type of fitting SELE Description { str } display on form stype gadget Tanswer { word } sub-type of fitting, for example, Door, Window. SPCO Catref { ref } pointer to PFIT in catalogue Detref { ref } pointer to detail text SPEC str ref SELE SELE str word SPCO ref ref
attributes for specification elements in hierachical order pupose Join
Attributes for Specification elements in hierarchical order: SPEC Description { str } display on form spec gadget Purpose JOIN spec purpose Question OTYP question for offspring Matref { ref } material reference in Property DB SELE Description { str } display on form stype gadget Tanswer { word } generic type of profile which joints can be owned by. ANY will allow joints to be owned by any profile, NONE will allow setting of PJOI specrefs. Question ATYP question for offspring SELE Description { str } information on type of profile Tanswer { word } generic type of profile that can be attached to joint. ANY will allow any type of profile to be attached to the joint. Question STYP question for offspring SPCO Catref { ref } pointer to PFIT in catalogue Detref { ref } pointer to detail text SELE Description { str } information on type of profile Tanswer { word } generic type of profile that can be attached to joint. ANY will allow any type of profile to be attached to the joint. Question STYP question for offspring SPCO Catref { ref } pointer to PFIT in catalogue Detref { ref } pointer to detail text SPEC str ref SELE str word SELE SPCO
Materials in Model
For the materials of a structural element (MATR) to be set in Model, you must be able to see a Properties Database (DB) containing the available materials. To create a Material World, carry out the following steps: If new material densities are required to be added to the system, DENSITY.DAT can be modified to include your new materials. The format of the file is as follows: AL-CAST \Aluminium, cast \2560 Al-WROUGHT \Aluminium, wrought \2700 DURALUMIN \Aluminium, Duralumin \2790 The hash character ( # ) signifies a comment line: any line beginning with it will be ignored. To load the new/modified materials into the system, follow step 4 above. If you moved the file to some other directory, run the macro by passing the full pathname of the file, thus: Note: All densities are in kg/cu m. edit module PARAGON mode PROP rw $m/%PMLUI%/DES/DATA/MLOADPROP Note : $m/%PMLUI%/DES/DATA/MLOADPROP pathname
the ,Net customization
The .NET Customization User Guide gives software engineers, with experience of software development in C# using Visual Studio, guidance on the development of .NET customization for AVEVA products. The AVEVA .NET Customization User Guide is not intended to be used as an introduction to C#.
The introduction of a customization
The introduction of a customization capability using Microsoft .NET technology has opened up a whole new world of customization and is particularly relevant for the integration of AVEVA products with other customer systems. .NET API's provide access to various aspects of the product including Graphical User Interface, Database and Geometry. As part of AVEVA's strategy of 'continual progression' the .NET customization capability has been introduced in such a way that it can be used alongside the existing PML based customization. Through the use of PML.NET, an enhancement to PML which allows the PML programmer to call .NET code, customization which utilizes the strengths of .NET compiled code and PML can be achieved. The above diagram illustrates the two new methods of customization using .NET technology. The first is via the concept of a .NET Addin and the second using PML.NET. Both methods provide a mechanism whereby a .NET assembly (dll) can be dynamically loaded into a module at runtime.
Common Application Framework Interfaces
The Common Application Framework (CAF) is an extensible framework which provides the .NET programmer with access to various services which support both application development and customization. The foundations of the CAF are provided by the two interface assemblies: These interfaces provide the following major services: Simple customization can be achieved by creating User Defined Attributes in Lexicon, delivering them in C# and loading them using the Aveva.ApplicationFramework.dll. Refer to for further information. It may be desirable to introduce extra GUI tools with complex customizations, this can be achieved using the Aveva.ApplicationFramework.Presentation.dll. The Application Framework Interfaces are documented at https://help.aveva.com/API/CAF/index.html. Aveva.ApplicationFramework.dll Aveva.ApplicationFramework.Presentation.dll Aveva.ApplicationFramework.dll Aveva.ApplicationFramework.dll Aveva.ApplicationFramework.Presentation.dll Aveva.ApplicationFramework.Presentation.dll AddinManager: This class provides properties and methods for the management of ApplicationFramework Addins. ServiceManager: This class defines an interface which provides a means by which the various components of the ApplicationFramework can publish their services. The ServiceManager also acts as a service provider responding to requests for services. It can also be used by applications and application addins to publish additional services. SettingsManager: This class provides properties and methods for the management of application settings which are stored in settings groups which are persisted between sessions. AddinManager: This class provides properties and methods for the management of ApplicationFramework Addins. AddinManager: This class provides properties and methods for the management of ApplicationFramework Addins. ServiceManager: This class defines an interface which provides a means by which the various components of the ApplicationFramework can publish their services. The ServiceManager also acts as a service provider responding to requests for services. It can also be used by applications and application addins to publish additional services. ServiceManager: This class defines an interface which provides a means by which the various components of the ApplicationFramework can publish their services. The ServiceManager also acts as a service provider responding to requests for services. It can also be used by applications and application addins to publish additional services. SettingsManager: This class provides properties and methods for the management of application settings which are stored in settings groups which are persisted between sessions. SettingsManager: This class provides properties and methods for the management of application settings which are stored in settings groups which are persisted between sessions. CommandBarManager: This provides access to the ribbon menus and commandbars of a CAF based application. It also has methods to load the definition of menus and commandbars from User Interface customization (UIC) files. CommandManager: This class defines an interface to provide the presentation framework client with a mechanism for the management of command objects which can be associated with Tools or other User interface objects. The action of invoking a tool, for example: clicking a ButtonTool, will cause the execution of the associated command object. It is possible to associate the same command object with a number of different user interface objects, for example: ButtonTool on a Menu and a LinkLabel, thereby allowing for the centralization of these user interface object actions within a command. Various state-like properties of a command, for example: enabled/checked, would also be reflected in all user interface objects associated with a command; disabling a command would cause all associated user interface objects to be disabled. User interface objects are associated with a command via a CommandExecutor derived class. ResourceManager: This class defines an interface to provide Addins with a simplified mechanism to access localizable resources. The ResourceManager provides a number of methods which allows an addin to then access the various types of resources (string, image, cursor, icon etc.) which resource files may contain. WindowManager: This provides access to the main application window, the StatusBar and a collection of MDI and docked windows. It also provides the addin writer with methods to create MDI and docked windows to host user controls. CommandBarManager: This provides access to the ribbon menus and commandbars of a CAF based application. It also has methods to load the definition of menus and commandbars from User Interface customization (UIC) files. CommandBarManager: This provides access to the ribbon menus and commandbars of a CAF based application. It also has methods to load the definition of menus and commandbars from User Interface customization (UIC) files. CommandManager: This class defines an interface to provide the presentation framework client with a mechanism for the management of command objects which can be associated with Tools or other User interface objects. The action of invoking a tool, for example: clicking a ButtonTool, will cause the execution of the associated command object. It is possible to associate the same command object with a number of different user interface objects, for example: ButtonTool on a Menu and a LinkLabel, thereby allowing for the centralization of these user interface object actions within a command. Various state-like properties of a command, for example: enabled/checked, would also be reflected in all user interface objects associated with a command; disabling a command would cause all associated user interface objects to be disabled. User interface objects are associated with a command via a CommandExecutor derived class. CommandManager: This class defines an interface to provide the presentation framework client with a mechanism for the management of command objects which can be associated with Tools or other User interface objects. The action of invoking a tool, for example: clicking a ButtonTool, will cause the execution of the associated command object. It is possible to associate the same command object with a number of different user interface objects, for example: ButtonTool on a Menu and a LinkLabel, thereby allowing for the centralization of these user interface object actions within a command. Various state-like properties of a command, for example: enabled/checked, would also be reflected in all user interface objects associated with a command; disabling a command would cause all associated user interface objects to be disabled. User interface objects are associated with a command via a CommandExecutor derived class. ResourceManager: This class defines an interface to provide Addins with a simplified mechanism to access localizable resources. The ResourceManager provides a number of methods which allows an addin to then access the various types of resources (string, image, cursor, icon etc.) which resource files may contain. ResourceManager: This class defines an interface to provide Addins with a simplified mechanism to access localizable resources. The ResourceManager provides a number of methods which allows an addin to then access the various types of resources (string, image, cursor, icon etc.) which resource files may contain. WindowManager: This provides access to the main application window, the StatusBar and a collection of MDI and docked windows. It also provides the addin writer with methods to create MDI and docked windows to host user controls. WindowManager: This provides access to the main application window, the StatusBar and a collection of MDI and docked windows. It also provides the addin writer with methods to create MDI and docked windows to host user controls. https://help.aveva.com/API/CAF/index.html AddinManager ServiceManager SettingsManager CommandBarManager CommandManager ResourceManager WindowManager https://help.aveva.com/API/CAF/index.html
Database Interfaces
The database related interfaces are provided by the interface assemblies: Interfaces are available to allow customizations to query or write to the program database. Refer to Database Interface for further information. Aveva.Core.Database.dll & Aveva.Core.Database.Filters.dll Aveva.Core.Database.dll & Aveva.Core.Database.Filters.dll Aveva.Core.Database.dll & Aveva.Core.Database.Filters.dll Database Interface Database Interface
Geometry Interfaces
The geometry related interfaces are provided by the interface assembly: This interface has a number of geometry related classes. For example, position, orientation, direction, arc, line and plane. Aveva.Core.Geometry.dll Aveva.Core.Geometry.dll Aveva.Core.Geometry.dll
Maths Interfaces
The maths related interfaces are provided by the interface assembly: This interface has a number of two dimensional and three dimensional low level geometry related classes. Aveva.Core.Maths.Geometry.dll Aveva.Core.Maths.Geometry.dll Aveva.Core.Maths.Geometry.dll
Shared Interfaces
Some general shared interfaces are provided in the interface assembly: This provides current element, selection changed events and Datal listing facilities. You can use Visual Studio to find the classes and methods. Aveva.Core.Shared.dll Aveva.Core.Shared.dll Aveva.Core.Shared.dll
Utilities Interfaces
Utility interfaces are provided in the interface assembly: This provides messaging, string utilities, tracing, undo and units. It also provides access to the command line but this is not supported Aveva.Core.Utilities.dll Aveva.Core.Utilities.dll Aveva.Core.Utilities.dll
Graphics Interfaces
Interfaces to access the drawlist and colours are provided in the interface assembly: The rest of this user guide will cover in detail how to write a .NET addin and an assembly containing classes with methods which are callable from Programmable Macro Language (PML). It will describe the use of the various .NET interfaces via the use of sample code. Aveva.Core3D.Graphics.dll Aveva.Core3D.Graphics.dll Aveva.Core3D.Graphics.dll
Engineering Interfaces
Interfaces to access Engineer API through the Programmable Macro Language (PML) are provided in the interface assembly: This provides functionality to manage lists from macros, add and remove rows from grids, set colours and export to xlsx. All methods are PML callable and can be used with PML or C# (.NET) code. Aveva.Engineering.Tags.Pml.dll Aveva.Engineering.Tags.Pml.dll Aveva.Engineering.Tags.Pml.dll
Zip file sample,zip sample using core/core3D
A zip file (Samples.zip) containing a number of samples using the Core/Core3D interfaces can be found in the installation directory. Each sample directory contains a number of C# source files and a Visual Studio project. Before opening and building a project in Visual Studio, set the environment variable %AVEVA_DESIGN_EXE% to include the product installation directory (this will make sure that all the project's assembly references are correct) and set %CAF_ADDINS_PATH% to include the directory where you want to build the sample (this will make sure that the project builds the example here). When running the product you also need to make sure that %CAF_ADDINS_PATH% is set to the same build directory to make sure that the example addin is loaded from here.
AttributeBrowserAddin
This is a C# addin containing a simple form which displays the attributes for the currently selected element. To use this within a module, copy the module's addins.xml file, for example, DesignAddins.xml, from the product directory to the directory set in CAF_ADDINS_PATH and then modify it to include AttributeBrowserAddin. To access the addin you will need to add the command to a State button on the ribbon or toolbar depending on the User Interface (UI) in the module. To do this in the application, open up the customization window and either create a new tab group/toolbar or use an existing one. Create a new State Button and in its properties specify the command to be "Aveva.ShowAttributeBrowserCommand", then click Apply and close the window. You should be able to open the attribute browser button by clicking on the new button. Apply
ExamplesAddin
This is a C# addin containing a number of code examples that can be run via a command. The command Aveva.Example.Command, is loaded when the addin is started. To add the addin to a module, copy the modules Addins.xml, for example, DesignAddins.xml from the product directory to the directory set in CAF_ADDINS_PATH. Edit this file adding the ExampleAddin to it (There is an example addins file in the ExamplesAddin directory). The command can be run from a ComboBox tool added to the ribbon or toolbar depending on the User Interface (UI) in the module. To do this in the application, create a new Tab group/toolbar using the Customization utility, add a ComboBox tool to it and attach the command to that. Each example can then be run by selecting it in the ComboBox. Since these examples create and claim Model elements they need to be run in a Design multi-write database.
FlexibleExplorerAddin
This is a C# addin which contains a Flexible Explorer control on a window and can be used with any of the modules. You will need to build the Addin inside Visual Studio after updating the references and then copy the DLL (FlexibleExplorerAddin.dll) and the associated XML sample file (FlexibleExplorerSample.xml) to the executable directory. In order to load the addin into the modules you will need to add a reference in the DesignAddins.XML file. Finally, you will need to use the Customization tool to add a state button in the module in order to display the addin. With the sample Flexible Explorer definition file (FlexibleExplorerSample.xml) the addin will display all the elements in the model. Detailed information about the Flexible Explorer is available, refer to Use of Flexible Explorer Control for further information. Use of Flexible Explorer Control Use of Flexible Explorer Control
NetGridExample
Installation for this example is exactly the same as with previous examples (refer to AttributeBrowserAddin or ExamplesAddin for further information). After following these instructions, enter the module you want to use and, once loaded, bring up the customization window. This example differs to the Attributes browser as it doesn't create a command, so in order to load the grid you need to create a state button as before, but the command is done differently. Open the command dialog by clicking on the "…" button to the right of the field. For the type, select Command Class and for the class select DockedWindowStateCommand, finally click OK. Next click on the "…" button in the Arguments field and select the Void .ctor(System.String) constructor. For the window key, enter Grid Control Addin and then click OK to close the dialog. Once this has been done, close the customization window and click on the new state button. The grid control window should appear just like any other form. AttributeBrowserAddin ExamplesAddin AttributeBrowserAddin ExamplesAddin Command Class DockedWindowStateCommand OK Void .ctor(System.String) Grid Control Addin OK
PMLNetExample
This example provides a simple C# class which can be called from within the Programmable Macro Language (PML).
PMLGridExample
An example of an AVEVA Grid Control hosted on a Programmable Macro Language (PML) form can be found in the Samples.zip file.
Tracing and Optimization
Suggestions to minimize the speed of start-up of addins have been made above. There are 2 built-in ways to monitor this and investigate the reasons if poor performance is suspected. Target start-up time for an Addin should be no more than 1 second, if possible. To find out how long your Addin takes to start-up set the following environment variable: Output similar to the following will then be displayed in the Console Window: The standard facilities found in the classes of the Aveva.Core.Utilities.Tracing namespace can be used for tracing performance problems as well as for other general coding investigations. The PdmsTrace class gives access to all the facilities of the Plant Design Management System (PDMS) trace system and provides a means of outputting general trace messages and values during processing. PdmsTrace functions also enable querying and setting of PDMS trace flags; give access to the current state of the call stack; and allow starting and stopping of Central Processor Unit (CPU) time tracing. The TraceEntry class provides the means to trace the entry and exit of functions as processing takes place. As the nesting of function calls gets deeper and deeper the function entry messages are indented further and further. Though this output can quickly get verbose it can frequently give evidence of problems in the code - for example functions being called too frequently … or not at all! To work correctly in C#, TraceEntry needs to know about entry and exit from functions in correct chronological order. There is a difficulty with this in C# because of the way that "garbage collection" works in that language. This means, in particular, it is necessary to make sure that the function exit event occurs at the right moment. This can be achieved by using the Dispose method explicitly: There are still problems with this however as you will need to catch every "return" statement individually. Also the Dispose() method will never be called if an exception occurs. A simpler and more robust way is to do this job using the C# "using" command as follows: If you are using these facilities to investigate the start-up of an addin, you will need to set the chosen trace flag from your code: And, finally, you can use the CPU time profiling options in conjunction with TraceEntry by using: Reviewing Addin Start-up Time set AVEVA_CAF_TRACING=PERFORMANCE AVEVA Everything3D Design Mk2.1.0[10061] (WINDOWS-NT 6.3) Copyright 2012 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. Issued to UKCAMSPLS Loading addins took: 0.282 secs. Starting addin Explorer: 0.984 secs. Starting addin DrawList: 0.024 secs. Starting addin Collections: 1.264 secs. Starting addin History: 0.011 secs. Starting addin ReferenceList: 0.170 secs. Starting addin PipeCheck: 0.447 secs. Starting addin Find: 0.117 secs. Starting addin Links Addin: 0.042 secs. Starting addin Attributes: 0.706 secs. Starting addin Status Controller: 0.016 secs. Starting addin ModelChanges: 0.047 secs. Starting addin SVGCompare: 0.612 secs. Starting addin Aveva.Core.InstrumentationImport.Addin.DataUpdate: 0.114 secs. Starting addin Aveva.Core.AVEVANetExportConfigAddin: 0.237 secs. Starting addin Aveva.Core.ReportingAddin: 0.327 secs. Starting addin MessageAddin: 0.240 secs. Starting addin Integrator: 0.533 secs. Total time starting addins: 5.905 secs. Loading UIC file Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\MyDataAddin.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\StatusController.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\design.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\CoreSchematicMenu.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\SVGCompare.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\AVEVA.design.cabling.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\AVEVA.design.hvac.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\AVEVA.design.MDS.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\AVEVA.design.piping.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1.customisation\AVEVA.design.steelwork.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\MessageWindowCoreMenus.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\AVEVA.design.laser.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\Integrator.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\DiagramViewer.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1\InstrumentationImportAddin.uic Defined new tools Loading UIC file C:\AVEVA\Plant\E3D2.1.customisation\Model.Addin.uic Defined new tools Updating CommandBar Layout: 0.002 secs. Loading CommandBar layout: 0.172 secs. DockManager.LoadFromXML: 2.628 secs. Loading Window Layout: 3.227 secs. TraceEntry tr = TraceEntry.Enter("Start", (TraceNumber)101); // ... // code being traced ... // ... tr.Dispose(); // explicit call on exit using (TraceEntry tr = TraceEntry.Enter("Start", (TraceNumber)101)) { // ... // code being traced ... // ... } // implicit call to Dispose() on exit from the block // even if there are exceptions or multiple return statements PdmsTrace.SetTraceFlag((TraceNumber)101, 1); PdmsTrace.StartCPUTrace(); // ... // code being timed ... // ... PdmsTrace.StopCPUTrace(true); PdmsTrace TraceEntry exit TraceEntry TraceEntry ( "Start" ( TraceNumber ) // ... // code being traced ... // ... // explicit call on exit using ( TraceEntry TraceEntry "Start" , ( TraceNumber ) // ... // code being traced ... // ... // implicit call to Dispose() on exit from the block // even if there are exceptions or multiple return statements PdmsTrace (( TraceNumber ) PdmsTrace // ... // code being timed ... // ... PdmsTrace ( true );
Exception Handling in a Common Application Framework Addin
The code of all components of a Common Application Framework (CAF) Addin is executed within the event loop of the host AVEVA program. Any exception raised within the Addin code, or any code called by it, that is not caught by the addin code itself will have to be handled in the event loop. The AVEVA host has effective ways to handle some classes of exceptions - namely PdmsExceptions and PMLNetExceptions. In the situation where the host program is in the process of executing Programmable Macro Language (PML), then the PML first has an opportunity to handle the exception itself. If the PML does not handle the exception, or if no PML is currently being executed, the host program handles these exceptions by notifying the user of the exception text and number interactively via the Status Bar, MessageBoxes or the CommandLine display as appropriate. Event loop processing then continues normally. For all other classes of exception the host event loop has no standard procedure and the outcome is that the host program terminates untidily. It is therefore very poor programming style to allow general exceptions to escape from the Addin. A relatively easy way to prevent this is to trap exceptions systematically at every entry point between the host event loop and the component interfaces - for example in every Command.Execute function: This recommendation does not, of course, replace the routine practice of handling exceptions at the appropriate points within the Addin code when they are anticipated and can be dealt with effectively. It simply provides a safety net for unanticipated and otherwise unhandled exceptions. /// <summary> /// Execute /// </summary> public override void Execute() { try { // Do the required function. DoTheJob(); } catch (System.Exception ex) { // Pass on PdmsExceptions and PMLNetExceptions. // Handle all others: // (perhaps by raising a PdmsException). } } private void DoTheJob() { // Do the required function... } /// <summary> /// Execute /// </summary> public override void { try catch Exception // Pass on PdmsExceptions and PMLNetExceptions. // Handle all others: // (perhaps by raising a PdmsException). private void DoTheJob() // Do the required function...
Thread safety in a Common Application Framework Addin
C# allows code to use multiple threads and there are situations where this can be useful in an Addin. However this technique should be used with care as the host AVEVA program is not itself multiple thread safe. Thus there can be only one thread at a time which executes functions in DbLayer, Common Application Framework (CAF) or other host core code.
Addins In TTY
TeleTypewriter (TTY) addins that implement the IAddinTty interface can also be defined in the <module>Addins.xml and will be loaded when the application starts. In graphics only those addins which implement the IAddin interface will be loaded and started as before. Addins can implement both interfaces but may need refactoring so that no User Interface (UI) elements are started in TTY mode. User Defined Attributes (UDAs) implemented as pseudo attributes can now be implemented in this way; refer to example implementation of IAddinTty interface below. using System; using System.IO; using System.Windows.Forms; using Aveva.ApplicationFramework; using Aveva.ApplicationFramework.Presentation; using Aveva.Core.Database; using Ps = Aveva.Core.Database.DbPseudoAttribute; using NOUN = Aveva.Core.Database.DbElementTypeInstance; namespace Aveva.Core.Tests.AddinTty /// <summary> /// Summary description for AddinTtyTest /// </summary> public class AddinTty : IAddinTty, IAddin { /// <summary> /// Start the Addin /// </summary> /// <param name="serviceManager"></param> void IAddinTty.Start(ServiceManager serviceManager) { // get uda attribute DbAttribute uda = DbAttribute.GetDbAttribute(":UDADDIN"); if (uda != null) { // Create instance of delegate containing method to evaluate // pseudo attribute Ps.GetStringDelegate dele = new Ps.GetStringDelegate(AddinTtyValue); // and pass delegate instance to core. Ps.AddGetStringAttribute(uda, NOUN.EQUIPMENT, dele); } } void IAddinTty.Stop() { } String IAddinTty.Name { get { return "AddinTty"; } } get { return "AddinTty"; }IAddinTty.Description { get { return "AddinTty"; } } // String delegate for UDA static private string AddinTtyValue(DbElement ele, DbAttribute att, DbQualifier qualifier) { return "AddinTty"; } } } using using using using using using using using namespace /// <summary> /// Summary description for AddinTtyTest /// </summary> public class { /// <summary> /// Start the Addin /// </summary> /// <param name="serviceManager"></param> void // get uda attribute null ) // Create instance of delegate containing method to evaluate // pseudo attribute new // and pass delegate instance to core. void String get { return "AddinTty" ; } get { return "AddinTty" get { return "AddinTty" // String delegate for UDA static private string return "AddinTty"
functionality provided via an addin
User access to functionality provided via an addin is normally provided through the use of ribbon menus and tools on a commandbar. Reference was made earlier, in the User Guide about addin commands, that the Common Application Framework (CAF) provides a mechanism to allow the use of ribbon menus and commandbars for an application to be defined in a User Interface Customization (UIC) file. This section provides details of how a CAF based application can be configured to load a UIC file, and how the UIC file can be edited using the applications interactive user interface customization tool. Newer modules, for example Model and Draw use the Ribbon commandbar, this is configured in the same way as the original toolbar (detailed below).
Configuring a Module to Load a User Interface Customization File
Each Common Application Framework (CAF) based application has an Extensible Markup Language (XML) configuration file which contains a list of User Interface Customization (UIC) files that the application should load at start-up. The default location for this file is in the same directory as the application executable. It has a filename of the form <Module Name>Customisation.xml. By default the UIC files are also expected to be in the same directory as the application executable. You can however specify the full path to the UIC file including the use of UNC pathnames. It is also possible to define a project specific UIC file. The string "$1" in the UIC path will be replaced with the current project name. If during addin development you do not wish to modify the customization configuration file in the install directory (this is particularly likely to be the case if you are using a server based installation) then the default location of the customization configuration file can be overridden using the environment variable CAF_UIC_PATH. You can then edit a copy of the file and point this environment variable at the directory you copy it to. The order of the UIC files in this configuration file is significant. They are loaded in order since it is possible for a UIC file to define a tool which is hosted in a menu or on a commandbar defined in a UIC file already loaded. A new UIC file can be added to a module simply by adding a new line to the corresponding customization configuration file. The actual content of the UIC file will be created using the interactive user interface customization tool described below. As well as adding to the customization configuration file, an addin can also load a UIC file directly using the AddUICustomisationFile method of the CommandBarManager. This UIC file will be loaded before those define in the Customization configuration file, so it must create its own menu or commandbar to host its tools. <?xml version="1.0" encoding="utf-8" ?> <UICustomizationSet xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <DefaultIcon>AvevaSharedIcons:ID_WARNING</DefaultIcon> <UICustomizationFiles> <CustomizationFile Name="Module" Path="design.uic" /> <CustomizationFile Name="SchematicExplorerAddin" Path="CoreSchematicMenu.uic" /> <CustomizationFile Name="Project" Path="$1.uic" Optional="true" /> <CustomizationFile Name="SVGCompare" Path="SVGCompare.uic" /> <CustomizationFile Name="Cabling" Path="AVEVA.design.cabling.uic" /> <CustomizationFile Name="Hvac" Path="AVEVA.design.hvac.uic" /> <CustomizationFile Name="Supports" Path="AVEVA.design.MDS.uic" /> <CustomizationFile Name="Piping" Path="AVEVA.design.piping.uic" /> <CustomizationFile Name="Steelwork" Path="AVEVA.design.steelwork.uic" /> <CustomizationFile Name="MessageAddin" Path="MessageWindowCoreMenus.uic" /> <CustomizationFile Name="Laser" Path="AVEVA.design.laser.uic" /> <CustomizationFile Name="Integrator" Path="Integrator.uic" /> <CustomizationFile Name="DiagramViewer" Path="DiagramViewer.uic" /> <CustomizationFile Name="InstrumentationImportAddin" Path="InstrumentationImportAddin.uic" /> </UICustomizationFiles> </UICustomizationSet> // Load a UIC file for the AttributeBrowser. ICommandBarManager commandBarManager = dependencyResolver.GetImple\-mentationOf<ICommandBarManager>(); commandBarManager.AddUICustomisationFile("AttributeBrowser.uic", "AttributeBrowser"); // Load a UIC file for the AttributeBrowser. "AttributeBrowser.uic" "AttributeBrowser"
Environment Variables for .NET Customization
There are 4 environment variables, with significant values, available for use with the .NET Customization capability. AVEVA_DESIGN_EXE should be set to the product installation directory. CAF_ADDINS_PATH indicates the location of the AddIns. CAF_UIC_PATH indicates the location of files where the GUI is defined. AVEVA_CAF_TRACING can be set to obtain information while developing. AVEVA_DESIGN_EXE should be set to the product installation directory. CAF_ADDINS_PATH indicates the location of the AddIns. CAF_UIC_PATH indicates the location of files where the GUI is defined. AVEVA_CAF_TRACING can be set to obtain information while developing. If this environment variable is unset, the program behaves as if it has been set to the product installation directory. The value can be multiple paths, separated by ';' and the application will search all of them in sequence for AddIns. The application will search for <module_name>Addins.xml in the directories until it finds a matching file. Once a <module_name>Addins.xml file is found, the application searches the directories for files with the same name. The list of addins is read from these xml files, duplicate entries within the matching files are disregarded. When customizing, users will probably want to have the product installation directory in the path list to locate standard AVEVA AddIns delivered with the product. The CAF_UIC_PATH implicitly appends the installation folder. If this environment variable is unset, the program behaves as if it has been set to the product installation directory. The value can be multiple paths, separated by ';' . The application will search for <module_name>Customisation.xml in the directories until it finds a matching file. Once a <module_name>Customization.xml file is found, the application searches the directories for files with the same name. The list of customization files is read from these xml files, duplicate entries within the matching files are disregarded. Each <…>Customization.xml file contains a list of .uic files. The path for which may be a filename, when the uic file is in the same directory, or a full pathname to the where the uic file exists. Files can use the notation '$1.uic'. The application will substitute the current Project Code (E.G. APS) for $1 on start up. An error will be raised if the file is not found unless the Optional="true" has been specified. For example: On start-up, the application will look for the uic files specified. An error will be raised if one is not found unless the optional=’true’ has been specified. The uic files are processed in order. UI containers must have been defined before UI components are added to them. In addition to using the CAF_UIC_PATH to look for <…>Customization.xml files, the application will also use it to locate resource files. <UICustomizationFiles> <CustomizationFile Name="Module" Path="admin.uic" /> <CustomizationFile Name="Project" Path="$1.uic" Optional="true"/> <CustomizationFile Name="MessageAddin" Path="MessageAddinMenu.uic" /> </UICustomizationFiles> </UICustomizationSet>
Edit an UIC File
The content of a User Interface Customization (UIC) file is created using the CAF based applications’ built-in interactive user interface customization tool available from the Customize window. Click to display the Customize window. The customization system supports the concept of multiple configuration files. Any number of levels of customization file can be defined either using the module customization configuration file or the CommandBarManager. AddUICustomizationFile() method, and they are layered on-top of each other in the order they appear in the list. Selecting an entry in the list will update the customize explorer will show command tools with all configuration information defined in the selected file and those above it. Any items in the customize explorer or list of command tools view which are not defined in the currently active customization file are displayed with an italic font in grey. Any customization file which a user does not have write access to does not appear in the drop-down list, but its contents are included in the customize explorer and list of command tools view. The selected customization file will become the active customization file. It will only be possible to edit customization information defined in this file. The Customize Explorer is populated with a representation of the active customization. It shows CommandBars and their contents, Menubars and their entries, Context Menus and their entries and Ribbons and their contents defined in all of the configuration files above and including the currently selected file. It also contains a list of the currently loaded resource files. When a node in the customize explorer is selected, the property grid is updated with the corresponding object so that its properties can be edited. Only objects which are defined in the currently Active Customization File can have their properties modified. Selecting a node in the customize explorer which represents an object defined in a non-active file will update the property grid, but it will be disabled, preventing modification. If the selected node represents a resource file, the Resource Editor will be displayed instead of the property grid. The tools owned by a MenuTool or Ribbon can be re-ordered by dragging the tool to the new desired position. The list of command tools is populated with each of the tools defined in each of the configuration files above and including the currently selected file. Use the functionality available to: The property grid is updated with the corresponding tool object so that its properties can be edited. Only objects which are defined in the currently active customization file can have their properties modified. Selecting a tool which is defined in a non-active file updates the property grid, but it will be disabled thus preventing modification. Tools can be dragged from the list of command tools and dropped into a MenuTool or Ribbon in the customization explorer. It is also possible to add tools to a menu or ribbon defined in a higher level customization file. The functionality can be used to integrate new tools into an existing system defined menu hierarchy and extend system toolbars as well as creating new top level menus and new tabs. One possible risk of adding tools to menus or ribbons defined at a higher level is that the higher level structure might at a later date be modified making these tools ‘orphaned’, or making the data which is stored to indicate their position within the host invalid. To warn of this, these tools are displayed in red within the customization explorer. Use the right-click menu available from the List of Command Tools pane of the Customize window to delete, create a tool or get an image from the clipboard. Delete Deletes the currently selected tool, if the selected tool is not editable then the delete operation is disabled. If the tool has been used then a warning message is displayed to confirm that the delete should be carried out. New Uses the displayed menu to create a new menu tool, create a new tool of the required type with a unique default name (Tool<N>) and add it to the list. New tools can also be created using the icons on the left side of the command tool pane. The properties for the new menu tool are displayed in the properties grid and can be edited. Use the functionality available from the property grid to edit the various properties of the tools. The customize explorer or the list of tools is kept up to date with any property changes. The following properties can be set for all Tools: The following properties are available on some Command Tools: If required, the command property can be modified, click . . . in the Command field to display the Command window. By default the command type is set to Command, other command types available for selection are Macro and Command Class, refer to Macro and Command Class for further information. Here a list of the currently loaded CAF Command objects is displayed for selection. The macro functionality uses a special command class to invoke the entered single PML command. This enables the PML developer to use the interactive customization tool to create their own menus and commandbars without needing to write C# command classes. Use the functionality available from the Command window, to select a command class from populated list: The ribbon section of the explorer enables the creation of tools; application menus, contextual tab groups and tabs, the creation, modification, deletion or group order is identical to that previously described. Refer to Edit an UIC File for further information. Use of the resource editor enables each of the currently loaded resource sets to be edited. It supports String, Icon and Bitmap resources. Each resource set can comprise a number of resource files, with an Invariant Language resource file and any number of locale specific resource files. When a resource file is selected, the Resource Editor is activated. When active, the resource editor command bar contains the following operations: Save Saves the resource file to the default location. Copy Resources Copies a resource file to the clipboard. Paste Resources Pastes a resource file into another resource file. Delete Deletes a resource file. Add New Resource File Adds a new resource file. The resource file name must be typed in the text box adjacent to the icon. Save Saves the resource file to the default location. Copy Resources Copies a resource file to the clipboard. Paste Resources Pastes a resource file into another resource file. Delete Deletes a resource file. Add New Resource File Adds a new resource file. The resource file name must be typed in the text box adjacent to the icon. New resource files (icon or bitmaps) can be added using drag-and-drop from a windows explorer. The resource id is generated from the filename, capitalized and prefixed with "ID_". If there is a clash with an existing resource, a confirmation window is displayed prompting for confirmation of file replacement. Use the property grid to add new string resource(s), double click in the available blank entry in the grid. Once created a new blank row is automatically added to the grid. Use the Edit Formatted Text window to edit existing resource(s), right click the required string resource in the property grid, from the displayed menu select Formatted Text Editor. Use the localisable resources functionality to customize a locale specific resource file or add a new locale specific resource file to the resource file set (this can then be selected for editing). Refer to Resource Manager for further information. Use the standard functionality available for selection from the View Style menu to change how information is displayed in the resource file editor. The icon and bitmap tabs also have a popup menu which provides access to these functions as well as a rename function. Double clicking on a resource also enters the rename mode. Properties of tools which are strings or the icon property can use resources for their value. Reference to a resource is made using the form <ResourceSet Name>:<Resource Id> as shown below: The caption and icon properties can be set on a tool in the tool list by drag-and-drop from the resource editor onto the tool. There is a standalone version of the resource editor available to enable resource files to be created and edited. This program is called "ResourceEditor.exe" and can be found in the installation directory. When started it displays a file selection window which enables the choice of an existing resource file or the addition a new resource file. Select a Node in the List Drag & Drop from the List to the Customization Explorer List Context Menu. Select a Node in the List Select a Node in the List Drag & Drop from the List to the Customization Explorer Drag & Drop from the List to the Customization Explorer List Context Menu. List Context Menu. ApplicationContext Currently unused Arguments List of arguments supplied to the Command Caption Text to display on CommandBar Command Command to run (see below) DisplayStyle Determines how the tool is displayed on the CommandBar Default- The tool is displayed in a default style. DefaultForToolType - The tool is displayed based on the default for the tools type and its location. TextOnlyAlways - The tool is always displayed as text only. TextOnlyInMenus - The Tool is displayed as a graphic when located on a Toolbar, and displayed as text when located on a Menu. ImageAndText - The tool is displayed using its assigned image and text. This setting is ignored when the item is on a top-level menu. ImageOnlyOnToolbars - The Tool is displayed as a graphic when located on a Toolbar, and displayed as image and text when located on a Menu. Icon Icon to display on CommandBar KeyTip Tip is shown on the ribbon when the Alt key is pressed, aids quick navigation Name Unique name for this tool Shortcut Shortcut key to activate this tool Tooltip Plain tool-tip text to display on mouse-over TooltipFormattedText Formatted tool-tip text to display on mouse-over TooltipTitle Title for tool-tip ApplicationContext Currently unused ApplicationContext Arguments List of arguments supplied to the Command Arguments Caption Text to display on CommandBar Caption Command Command to run (see below) Command DisplayStyle Determines how the tool is displayed on the CommandBar Default- The tool is displayed in a default style. DefaultForToolType - The tool is displayed based on the default for the tools type and its location. TextOnlyAlways - The tool is always displayed as text only. TextOnlyInMenus - The Tool is displayed as a graphic when located on a Toolbar, and displayed as text when located on a Menu. ImageAndText - The tool is displayed using its assigned image and text. This setting is ignored when the item is on a top-level menu. ImageOnlyOnToolbars - The Tool is displayed as a graphic when located on a Toolbar, and displayed as image and text when located on a Menu. DisplayStyle Icon Icon to display on CommandBar Icon KeyTip Tip is shown on the ribbon when the Alt key is pressed, aids quick navigation KeyTip Name Unique name for this tool Name Shortcut Shortcut key to activate this tool Shortcut Tooltip Plain tool-tip text to display on mouse-over Tooltip TooltipFormattedText Formatted tool-tip text to display on mouse-over TooltipFormattedText TooltipTitle Title for tool-tip TooltipTitle AutoComplete Sets whether the edit portion is automatically updated to match an item in the list as new characters are typed. Control Control embedded in container Editable Sets if the text is editable by the user MaxLength Maximum number of characters the user is allowed to enter Password Display text in password mode (hidden) ValueList List of values to display Width Tool width on the CommandBar AutoComplete Sets whether the edit portion is automatically updated to match an item in the list as new characters are typed. AutoComplete Control Control embedded in container Control Editable Sets if the text is editable by the user Editable MaxLength Maximum number of characters the user is allowed to enter MaxLength Password Display text in password mode (hidden) Password ValueList List of values to display ValueList Width Tool width on the CommandBar Width DockedWindowStateCommand ModuleSwitchCommand SelectTaskPaneCommand CommandBarStateCommand. DockedWindowStateCommand DockedWindowStateCommand ModuleSwitchCommand ModuleSwitchCommand SelectTaskPaneCommand SelectTaskPaneCommand CommandBarStateCommand. CommandBarStateCommand. Note: Only ribbons and their contents (tabs, groups and menus) are described. Note: Functionality is available for icons and bitmaps only. Note: The functionality available from the formatted text editor is standard. Edit an UIC File Resource Manager Customize Customize CommandBarManager. AddUICustomizationFile() Customize Explorer Active Customization File Resource Editor Note : List of Command Tools Customize Delete New . . . Command Command Command Macro Command Class Command Edit an UIC File Invariant Language Resource Editor Save Copy Resources Paste Resources Delete Add New Resource File Note : Edit Formatted Text Formatted Text Editor Note : Resource Manager View Style resource file editor
database related interfaces
The database related interfaces are provided by the interface assemblies: This interface has the following main classes: Namespace: Aveva.Core.Database The class is valid for system types and User Defined Element Types (UDETs). As well as the class methods there is a lot of functionality that can be accessed via pseudo attributes. The relevant pseudo attributes are listed where relevant. The classes fall into the following groups: Aveva.Core.Database.dll & Aveva.Core.Database.Filters.dll Aveva.Core.Database.dll & Aveva.Core.Database.Filters.dll Aveva.Core.Database.dll & Aveva.Core.Database.Filters.dll DatabaseService: The sole purpose of this class is to open a project. DbAttribute: The class has two purposes: Instances of the class are used to identify and pass around attributes The methods allow the retrieval of metadata about an attribute, for example: type, size, Name, pseudo or not, etc. The class is valid for system attributes and User Defined Attributes (UDAs). DB: This class provides information on the opened Data Bases (DBs). DbElement: Instances of DbElement are used to identify an element. This is the main class for reading and writing to the database. The methods cover element creation element deletion copy getting/setting attributes and rules navigating the DB evaluating database expressions. DbElementType: The class has two purposes: Instances of the class are used to identify and pass around Element types The methods allow the retrieval of metadata about an Element type, for example: Name, description, allowed attributes and members etc. DatabaseService: The sole purpose of this class is to open a project. DatabaseService: The sole purpose of this class is to open a project. DbAttribute: The class has two purposes: Instances of the class are used to identify and pass around attributes The methods allow the retrieval of metadata about an attribute, for example: type, size, Name, pseudo or not, etc. The class is valid for system attributes and User Defined Attributes (UDAs). DbAttribute: The class has two purposes: DB: This class provides information on the opened Data Bases (DBs). DB: This class provides information on the opened Data Bases (DBs). DbElement: Instances of DbElement are used to identify an element. This is the main class for reading and writing to the database. The methods cover element creation element deletion copy getting/setting attributes and rules navigating the DB evaluating database expressions. DbElement: Instances of DbElement are used to identify an element. This is the main class for reading and writing to the database. The methods cover DbElementType: The class has two purposes: Instances of the class are used to identify and pass around Element types The methods allow the retrieval of metadata about an Element type, for example: Name, description, allowed attributes and members etc. DbElementType: The class has two purposes: DbEvents: This class contains the mechanisms for subscribing to database events. It covers savework, getwork, undo, redo, flush, refresh, drop events plus capturing general database changes. DbExpression: Class to hold a database expression. These are the same as Programmable Macro Language (PML) 1 expressions. Methods to evaluate expressions are on the DbElement class. DbPseudoAttribute: This Class allows pseudo attribute code to be plugged in for UDAs. DbRule: Class to hold a database rule DbUserChanges: This is passed through by the 'database change' event. It contains a list of database changes made since the last 'database change' event was raised. Changes may be queried down to the attribute level. MDB: Methods to do operations on an Multiple DataBase (MDB), for example: savework, getwork. Table: Various classes to access the internal Dabacon tables, for example: the name table. Project: The main method is to open the MDB. DbEvents: This class contains the mechanisms for subscribing to database events. It covers savework, getwork, undo, redo, flush, refresh, drop events plus capturing general database changes. DbEvents: This class contains the mechanisms for subscribing to database events. It covers savework, getwork, undo, redo, flush, refresh, drop events plus capturing general database changes. DbExpression: Class to hold a database expression. These are the same as Programmable Macro Language (PML) 1 expressions. Methods to evaluate expressions are on the DbElement class. DbExpression: Class to hold a database expression. These are the same as Programmable Macro Language (PML) 1 expressions. Methods to evaluate expressions are on the DbElement class. DbPseudoAttribute: This Class allows pseudo attribute code to be plugged in for UDAs. DbPseudoAttribute: This Class allows pseudo attribute code to be plugged in for UDAs. DbRule: Class to hold a database rule DbRule: Class to hold a database rule DbUserChanges: This is passed through by the 'database change' event. It contains a list of database changes made since the last 'database change' event was raised. Changes may be queried down to the attribute level. DbUserChanges: This is passed through by the 'database change' event. It contains a list of database changes made since the last 'database change' event was raised. Changes may be queried down to the attribute level. MDB: Methods to do operations on an Multiple DataBase (MDB), for example: savework, getwork. MDB: Methods to do operations on an Multiple DataBase (MDB), for example: savework, getwork. Table: Various classes to access the internal Dabacon tables, for example: the name table. Table: Various classes to access the internal Dabacon tables, for example: the name table. Project: The main method is to open the MDB. Project: The main method is to open the MDB. Data Model Definition Classes Basic database access, query and modification. Filters Iterators Dabacon Tables DBs, MDBs and Projects Events and pseudo attribute plugins Data Model Definition Classes Data Model Definition Classes Basic database access, query and modification. Basic database access, query and modification. Filters Filters Iterators Iterators Dabacon Tables Dabacon Tables DBs, MDBs and Projects DBs, MDBs and Projects Events and pseudo attribute plugins Events and pseudo attribute plugins Data Model Definition Classes Filters Iterators Dabacon Tables DatabaseService DbAttribute DB DbElement DbElementType DbEvents DbExpression DbPseudoAttribute DbRule DbUserChanges MDB Table Project Data Model Definition Classes Filters Iterators Dabacon Tables DBs, MDBs and Projects
Data Model Definition Classes
Four classes are available.
class external to the AVEVA module
There is a single class for all element types. The purpose of the class is to: External to the AVEVA module, the hash value can be used to uniquely identify an Element type. The hash value is a 32 bit integer. In C# a DbElementType object may be obtained in one of three ways: The methods allow the Element type metadata to be accessed. For example: Pseudo attributes that provide similar information on a particular element instance (for example, on a DbElement) are: HLIS DbElementType[] List of all possible types in owning hierarchy LIST DbElementType[] List of all possible member types LLIS DbElementType[] List of all possible types in member hierarchy OLIS DbElementType[] List of all possible owner types REPTXT String Reporter text used for element type ATTLIST DbAttribute[] List of all visible attributes for element PSATTS DbAttribute[] List of pseudo attributes UDALIS DbAttribute[] List of UDAs DbNounManual- Manual category DbType - DB type Instances of the class identify the element type. i.e. methods on other classes take a DbElementType as an argument rather than a string to denote an Element type. The DbElementType has 'value' semantics for comparison purposes. i.e. comparing of two DbElementTypes will always return true if they refer to the same type, even if they are different objects. Access the metadata associated with element types. Instances of the class identify the element type. i.e. methods on other classes take a DbElementType as an argument rather than a string to denote an Element type. The DbElementType has 'value' semantics for comparison purposes. i.e. comparing of two DbElementTypes will always return true if they refer to the same type, even if they are different objects. Instances of the class identify the element type. i.e. methods on other classes take a DbElementType as an argument rather than a string to denote an Element type. The DbElementType has 'value' semantics for comparison purposes. i.e. comparing of two DbElementTypes will always return true if they refer to the same type, even if they are different objects. Access the metadata associated with element types. Access the metadata associated with element types. Name Description BaseType (for User Defined Element Type [UDETs]) List of attributes List of User Defined Attributes (UDAs) Allowed members Allowed owners Types that may appear above this element type Types that may appear below this element type Element types that may be referenced from a given attribute on this element type Database types in which it occurs Name Name Description Description BaseType (for User Defined Element Type [UDETs]) BaseType (for User Defined Element Type [UDETs]) List of attributes List of attributes List of User Defined Attributes (UDAs) List of User Defined Attributes (UDAs) Allowed members Allowed members Allowed owners Allowed owners Types that may appear above this element type Types that may appear above this element type Types that may appear below this element type Types that may appear below this element type Element types that may be referenced from a given attribute on this element type Element types that may be referenced from a given attribute on this element type Database types in which it occurs Database types in which it occurs DbElementType[] DbElementType[] DbElementType[] DbElementType[] String DbAttribute[] DbAttribute[] DbAttribute[]
DbElement type
This is very similar to DbElementType. There is a single class for all attributes. The purpose of the class is to: The class should not be confused with the attribute value. The actual Attribute value for a particular Element can only be accessed via the DbElement class. Comparing two DbAttributes just compares whether they identify the same attribute, the comparison does not look at attribute values in any way. External to the AVEVA module, the hash value can be used to uniquely identify an Attribute. The hash value is a 32 bit integer. In C# a DbAttribute object may be obtained in the following ways: The methods allow the following metadata to be accessed: Attribute Type Units Name Description Category Size Allowed Values Allowed ranges Is a UDA Is a pseudo attribute Whether the attribute may take a qualifier Attribute Type Units Name Description Category Size Allowed Values Allowed ranges Is a UDA Is a pseudo attribute Whether the attribute may take a qualifier Find the type of attribute XLEN. We use the global instance of XLEN on the DbAttributeInstance class. DbAttributeUnit - Type of units, for example: distance or bore or none. DbAttributeType – Type of attribute. One of INTEGER = 1, DOUBLE = 2, BOOL = 3, STRING = 4, ELEMENT = 5, DIRECTION = 7, POSITION = 8, ORIENTATION = 9 DbAttributeQualifier – used to determine what sort of qualifier an attribute has DbAttributeUnit - Type of units, for example: distance or bore or none. DbAttributeType – Type of attribute. One of INTEGER = 1, DOUBLE = 2, BOOL = 3, STRING = 4, ELEMENT = 5, DIRECTION = 7, POSITION = 8, ORIENTATION = 9 DbAttributeQualifier – used to determine what sort of qualifier an attribute has using ATT=Aveva.Core.Database.DbAttributeInstance; DbAttributeType xlenTyp= ATT.XLEN.Type; Access the metadata (i.e. data about data) associated with attributes, for example: type, name, length. Identify attributes. i.e. methods on other classes should always take a DbAttribute rather than a string as an argument to denote the attribute. Any comparison of attribute identity should be done by comparing DbAttribute objects. Access the metadata (i.e. data about data) associated with attributes, for example: type, name, length. Access the metadata (i.e. data about data) associated with attributes, for example: type, name, length. Identify attributes. i.e. methods on other classes should always take a DbAttribute rather than a string as an argument to denote the attribute. Any comparison of attribute identity should be done by comparing DbAttribute objects. Identify attributes. i.e. methods on other classes should always take a DbAttribute rather than a string as an argument to denote the attribute. Any comparison of attribute identity should be done by comparing DbAttribute objects. DbElement class DbAttributes using DbAttributeUnit - Type of units, for example: distance or bore or none. DbAttributeType – Type of attribute. One of INTEGER = 1, DOUBLE = 2, BOOL = 3, STRING = 4, ELEMENT = 5, DIRECTION = 7, POSITION = 8, ORIENTATION = 9 DbAttributeQualifier – used to determine what sort of qualifier an attribute has
class contains instances of DbElement Type
This class contains instances of DbElementType for every element type in the AVEVA module. These instances may be used wherever a DbElementType is expected, for example: if a method MyMethod() takes an DbElementType, then you could write: for example: It is often convenient to add a using statement for these instances, for example: MyMethod(Aveva.Core.Database.DbElementTypeInstance.EQUIPMENT); using NOUN=Aveva.Core.Database.DbElementTypeInstance; MyMethod(NOUN.EQUIPMENT); DbElementType DbElementType MyMethod( ) DbElementType, using
class contains instances of DbAttribute
This class contains instances of DbAttribute for every element type in the AVEVA module. These instances may be used wherever a DbAttribute is expected, for example: if a method MyMethod() takes a DbAttribute, you could write: For example: It is often convenient to add a using statement for these instances. For example: MyMethod(Aveva.Core.Database.DbAttributeInstance.XLEN); using ATT=Aveva.Core.Database.DbAttributeInstance; MyMethod(ATT.XLEN); MyMethod() DbAttribute using
Element Access
Functionality is available to manipulate the access to elements.
section describes the DbElement class
This section describes the DbElement class. The DbElement class is the most widely used class and it covers a large proportion of the database functionality that will be used in practise. The methods fall into the following groups: DbElement is a generic object that represents all database elements regardless of their type. An instance of a DbElement may be obtained as follows: for example. The DbElement object encapsulates the identity of the database object. Any comparison of database objects must be done using DbElements. The DbElement has 'value' semantics for comparison purposes. i.e. comparing of two DbElements will always return true if they refer to the same element, even if they are different objects. DbElement instances should be used in all cases where the identity of an element is being passed or stored. A DbElement can be identified externally to the AVEVA module by a combination of the ref number AND type. The ref number is a two long integer, for example: =123/4567. A DbElement need not represent a 'valid' element. There are a number of reasons why a DbElement might be invalid: There is a IsValid()method to test if a DbElement is valid. If the DbElement is invalid then all attribute access and database navigation will fail for that DbElement. The error handling techniques used are: DbElement has the following basic methods: ToString()- Returns the Name of the element. If unnamed, it returns the constructed name. GetElementType()- Returns the DbElementType. There are a number of pseudo attributes that return slight variations on name and type, as below. Type related: ACTTYPE DbElementType Type of element AHLIS DbElementType (200) List of actual types in owning hierarchy OSTYPE DbElementType Shortcut for "Type of owner" TYPE DbElementType Type of the element, ignoring UDET TYSEQU int Type Sequence Number Name Related: CUTNAM String int Full name of element, truncated to n characters CUTNMN String int Full name of element (without leading slash) truncated to n characters FLNM String Full name of the element FLNN String Full name of the element (without leading slash) ISNAMED Bool True if element is named NAMESQ String Type. sequence number and name of element NAMETY String Type and name of the element NAMN String Name of the element (without leading slash) NAMTYP String Type and full name of element DbElement vess1 = DbElement.GetElement("/VESS1"); Navigation Querying of attributes Database modifications Storage of rules and expressions Comparison across sessions Navigation Navigation Querying of attributes Querying of attributes Database modifications Database modifications Storage of rules and expressions Storage of rules and expressions Comparison across sessions Comparison across sessions There is a static GetElement() method with no arguments to return a 'null' DbElement. There is a static GetElement() method which returns a DbElement given a name. This name should include the '/'. There is a static GetElement() method which returns a DbElement given a ref (two long int array) and type. This is only needed where a reference has been stored externally to the AVEVA module. There are many methods on various classes which return DbElements There is a static GetElement() method with no arguments to return a 'null' DbElement. There is a static GetElement() method with no arguments to return a 'null' DbElement. There is a static GetElement() method which returns a DbElement given a name. This name should include the '/'. There is a static GetElement() method which returns a DbElement given a name. This name should include the '/'. There is a static GetElement() method which returns a DbElement given a ref (two long int array) and type. This is only needed where a reference has been stored externally to the AVEVA module. There is a static GetElement() method which returns a DbElement given a ref (two long int array) and type. This is only needed where a reference has been stored externally to the AVEVA module. There are many methods on various classes which return DbElements There are many methods on various classes which return DbElements The element is in a DB not opened. The element has been deleted. The element is in a DB not opened. The element is in a DB not opened. The element has been deleted. The element has been deleted. DbElement DbElement GetElement() DbElement GetElement() DbElement GetElement() DbElement DbElements DbElement DbElements DbElement DbElements DbElement DbElement IsValid() method DbElement DbElement DbElement DbElement ToString() GetElementType() DbElementType . Type related: DbElementType DbElementType (200) DbElementType DbElementType int Name Related: String int String int String String Bool String String String String
methods to navigate the primary hierarchy
There are basic methods to navigate the primary hierarchy. for example, consider the following hierarchy: If we are sitting at Zone2, we can navigate as follows: Scanning the database is a very common operation. For this reasons there are additional iterator and filter classes that ease this task. These are described in the section on Filters/Iterators. ALLELE DbElement[]) DbElementType All elements in the MDB of a particular type CONNECTIONS DbElement[] Connections CONNECTIONSH DbElement[] Connections for all descendants CONNER String Int Connection error message DDEP Int Database depth within hierarchy (World is 0) FRSTW DbElement String Reference of first world of given DB type in current MDB MAXD Int DB hierarchy depth of lowest level item beneath element MBACK DbElement[] *DbElementType Members in reverse order MCOU Int *DbElementType Number of Element Members of Given type MEMB DbElement[] *DbElementType All members, or members of specific type OWNLST DbElement[] Owning hierarchy PARENT DbElement *DbElementType Reference of ascendant element of specified type SEQU Int Sequence Position in Member List TYSEQU Int Type Sequence Number '*'- qualifier is optional Standard navigation methods do not work for descending a secondary hierarchy. Pseudo attribute SMEMB must be used, for example: to get the design elements below a GPSET, you must query the SMEMB attribute on the GPSET. Pseudo attributes relating to secondary hierarchies are: GPPRXS DbElement[] Group proxy items referring to element GROUPS DbElement[] GPSETs in which element occurs SEXPND DbElement[] Recursive expansion of SMEMB SITEM DbElement Reference from secondary hierarchy SMEMB DbElement[] Immediate members in secondary hierarchy The difference between SMEMB and SEXPND is that SEXPND allows for recursive secondary hierarchies. Where there are no recursive possibilities, SMEMB and SEXPND will be the same. The following example illustrates the difference between SMEMB and SEXPND: In the example there are two secondary nodes S1 and S2. S1 holds element A and C, and S2 holds S1, D and G. For S1, SMEMB returns A,C SEXPND returns A,C For S2, SMEMB returns S1,D, G SEXPND returns A,C, D, G using NOUN=Aveva.Core.Database.DbElementTypeInstance; DbElement zone = DbElement.GetElement("/Zone1") DbElement temp=zone2.Next(); // temp is now Zone3 temp=zone2->Previous(); // temp is now Zone1 temp=zone2->Owner(); // temp is now Site1 temp=zone2->FirstMember(); // temp is now Pipe1 DbElement pipe1=temp; temp=zone2->LastMember(); // temp is now Equi1 DbElement temp=pipe1.Next(NOUN.EQUIPMENT); // temp is Equi1 DbElement temp=pipe1.Previous(); // temp is ‘null’ as there is no previous element. This can only be tested using the ‘IsNull’ method using Attribute Name Data Type Qualifier Description DbElement[]) DbElementType DbElement[] DbElement[] String Int Int DbElement String Int DbElement[] *DbElementType Int *DbElementType DbElement[] *DbElementType DbElement[] DbElement *DbElementType Int Int DbElement[] DbElement[] DbElement[] DbElement DbElement[]
site will have different attributes to a branch
The attributes available on for a DbElement will depend on its type, for example: a site will have different attributes to a branch. For this reason attributes are accessed through generic methods rather than specific methods. These generic methods pass in the identity of the attribute being queried (a DbAttribute object). There are separate methods for each attribute type (int, double etc), plus separate methods for single values or arrays. for example: This call returns the value of attribute XLEN. If 'myEle' is not a BOX then an exception will be raised. If there is any doubt as to whether 'myEle' is a BOX or not, then there are a set of methods that return false if the attribute does not exists. for example: In addition there is a IsAttributeValid() method that can be used to test if an attribute is valid or not. The basic mechanism works for all attributes including UDAs and pseudo attributes. The attribute types supported are: int, int[] double, double[] bool, bool[] string, string[] DbElement, DbElement[] DbElementType, DbElementType[] DbAttribute, DbAttribute[] Position Direction Orientation Expression int, int[] double, double[] bool, bool[] string, string[] DbElement, DbElement[] DbElementType, DbElementType[] DbAttribute, DbAttribute[] Position Direction Orientation Expression There are two lists of valid attributes: Related pseudo attributes are: Attribute Name Data Type Description ATTLIST DbElementType[] List of all visible attributes for element ATTRAW DbElementType[] List of raw attributes PSATTS DbElementType[] List of pseudo attributes RLIS DbElementType[] List of rules set UDALIS DbElementType[] List of UDAs UDASET DbElementType[] List of UDAs set Attribute Name Data Type Description ATTLIST DbElementType[] List of all visible attributes for element ATTRAW DbElementType[] List of raw attributes PSATTS DbElementType[] List of pseudo attributes RLIS DbElementType[] List of rules set UDALIS DbElementType[] List of UDAs UDASET DbElementType[] List of UDAs set Many attributes take a qualifier. The qualifier is the extra information to make the query. Examples of where a qualifier is used are: The definition of what pseudo attributes take what qualifier is described in the data model reference manual. The DbQualifier class represents the qualifier. This can hold any type of qualifier, i.e. int, double,string, DbElementType, Attribute, position, direction, orientation. It can hold multiple qualifier values, although few current attributes require multiple valued qualifiers. There is a separate method to set the WRT element. There is a set of query routines that take a qualifier as an extra argument. for example: to query the bore of ppoint 1: If the attribute value is to go onto a form then the value must be formatted correctly. The correct formatting is not always obvious or available. Therefore there are special methods to return any attribute as a formatted string. This will format the attribute into the form that would appear at the command line. For example if the attribute is a position and we are working in finch unit, then something like 'W 39'4.7/16 N 59'0.85/128 U 4'0.31/128' might be returned. The method to do this is GetAsString(). using ATT=Aveva.Core.Database.DbAttributeInstance; double length=myEle.GetDouble(ATT.XLEN); using ATT=Aveva.Core.Database.DbAttributeInstance; double length; if (!myEle.GetValidDouble(ATT_XLEN,length)) { // handle error in some way } DbQualifier qual=new DbQualifier(); qual.Add(1); double bore=myele.GetDouble(ATT.PPBO, qual); Note: The methods that are called GetAttribute, GetAttributeArray are the 'getattribute' methods that return DbAttributes. Similarly the GetElement, GetElementArray methods are the 'getattribute' methods that return DbElements. This is confusing since GetElement is also the name of the method to return a DbElement given a name. We may change the names of these in the future. Note: There is no generalized method for setting an attribute from a string. DbElement DbAttribute using using A IsAttributeValid() Note : GetAttribute GetAttributeArray DbAttributes GetElement GetElementArray DbElements GetElement DbElement GetAttributes() DbElementType[] DbElementType[] DbElementType[] DbElementType[] DbElementType[] DbElementType[] DbQualifier new W 39'4.7/16 N 59'0.85/128 U 4'0.31/128 GetAsString() Note :
when an element is modified
The following modifications are allowed: When an element is modified, it is not simply the case of directly updating the database. For example, when setting an attribute the following sequence takes place: It can be seen that making what appears to be a simple modification is actually quite complicated. In particularly a lot of errors are possible. Errors may be generated by any of the steps 1-2 plus steps 4-8. If an error occurs the code will raise a PdmsException. The calling code needs to allow for this. Clarification of some of these errors is as follows: Check that the attribute value is the right type For example, if a text attribute then the new value must be text, for example: setting DESC to 99 will raise an error. Check against any valid values or ranges This will check the value against any user provided criteria stored in the dictionary DBs. Check access control An error will be raised if the modification is not allowed. An error will also be raised at this point if the attribute is not valid for the given element. Check that the DB is open in write An error will be raised if 'read only'. Check LOCK flag An error will be raised if the LOCK flag is true. Do claim check, and claim if needed (and implicit claim is allowed) An error will be raised if: Call the legality checking routines to make sure that the modification is valid These checks are made by the plugged in application specific code. Thus potentially any error could be raised. If a DB has been set up to be 'implicit' the user will claim elements as needed without having to do explicit claims. There are some methods on DbElement to claim/release individual elements or a hierarchy of elements. If working on a hierarchy of elements, and errors occur, then the system will still do what it can. There are also methods on the MDB class to claim/release a list of elements. Performance is improved by claiming or releasing elements in bulk, thus in general the MDB methods should be used rather than the ones on DbElement. The granularity of claim is at the level of primary element. This is described in the data management reference manual. Pseudo Attributes Relating to Claims CLMID String Unique system ID of user claiming element CLMNUM int User or extract number claiming element. Extract numbers are negative CLMTIE DbElement[] Reference to elements that are automatically claimed along with this element NPDESC DbElement[] List of non primary offspring OKCLA bool True if element may be claimed OKCLH Bool True if element and hierarchy may be claimed OKREL bool True if element may be released OKRLH Bool True if element and hierarchy may be released PRIMTY Bool True if element is primary PRMMEM bool True if there are any primary elements amongst descendants PRMOWN DbElement Primary owning element (will be itself if primary) USCLHI DbElement[] Elements in descendant hierarchy claimed to this user USERC String User name of user claiming element USNCLH DbElement[] Elements in descendant hierarchy not claimed to this user Set Attribute Create Element Delete Element Copy Element Move Element Change Type Set Attribute Set Attribute Create Element Create Element Delete Element Delete Element Copy Element Copy Element Move Element Move Element Change Type Change Type The DB uses explicit claims and the primary element has not been claimed. The primary element is claimed by another user or extract. The DB uses explicit claims and the primary element has not been claimed. The DB uses explicit claims and the primary element has not been claimed. The primary element is claimed by another user or extract. The primary element is claimed by another user or extract. Set Attribute Create Element Delete Element Copy Element Move Element Change Type Set Attribute Create Element Delete Element Copy Element Move Element Change Type Check that the attribute value is the right type Check against any valid values or ranges Check access control Check that the DB is open in write Check LOCK flag Do claim check, and claim if needed (and implicit claim is allowed) Call the legality checking routines to make sure that the modification is valid DbElement DbElement Pseudo Attributes Relating to Claims String int DbElement[] DbElement[] bool Bool bool Bool Bool bool DbElement DbElement[] String DbElement[]
PML database expression
Database expressions are PML1 expressions, for example: (XLEN * 1000). Expressions are of the following type: Database expressions are stored in various places in the AVEVA module as follows: There is a DbExpression class to hold an expression. An DbExpression may be obtained in one of the following ways: Having got an DbExpression there are two things that can be done with it: The methods to evaluate an expression against an element are on the DbElement class. There are different methods depending on the expected result of the expression. The method names start with 'Evaluate'. The method that returns a double has an argument for the units (distance/bore/none). The result will always be in millimetres (mm), for example: In this case the core system can work out that it is a distance, since DIAM is a distance. Thus although we specified that it was a distance, it was not strictly needed. Thus if the distance units were inch or finch then the '+2' would be interpreted as '+2inches'. However consider: In this case we do not know if "10" is 10mm or 10 inches. We must tell the system that it is a 'distance' unit. The system then interrogates the current distance units to return the result. If the current distance units is mm, then dval will be 10.0. If the current distance units is inch/finch then "10" is interpreted to mean 10 inches and is hence returned as 254. PML.NET rules consist of an expression and a dynamic/static flag. When constructing a rule, the expression type is also needed. There are methods on DbElement to: NRULEE Int Number of rule inconsistencies on element RCOU Int Number of rules on element RULEER String int Text of "nth" rule error RULSET DbAttribute[] List of rules set DbExpression expr = DbExpression.Parse("DIAM OF PREV + 2"); double dval; DbAttributeUnit units = DbAttributeUnit.DIST; dval = nozz1.EvaluateDouble(expr4, units); DbExpression expr = DbExpression.Parse("10"); double dval; DbAttributeUnit units = DbAttributeUnit.DIST; dval = nozz1.EvaluateDouble(expr4, units); Double DbElement Bool String Position Direction Orientation Double Double DbElement DbElement Bool Bool String String Position Position Direction Direction Orientation Orientation As part of a rule Parameterization of the catalogue As part of a rule As part of a rule Parameterization of the catalogue Parameterization of the catalogue Use the static method internalParse() that creates a DbExpression from a string, for example: internalParse("XLEN * 100") Retrieve an expression from a rule Retrieve an expression from a catalogue parameter Use the static method internalParse() that creates a DbExpression from a string, for example: internalParse("XLEN * 100") Use the static method internalParse() that creates a DbExpression from a string, for example: internalParse("XLEN * 100") Retrieve an expression from a rule Retrieve an expression from a rule Retrieve an expression from a catalogue parameter Retrieve an expression from a catalogue parameter Set a rule for any attribute. Get a rule for any attribute Evaluate a rule Verify that the rule result is up to date Set a rule for any attribute. Set a rule for any attribute. Get a rule for any attribute Get a rule for any attribute Evaluate a rule Evaluate a rule Verify that the rule result is up to date Verify that the rule result is up to date Note: If the value is required to be formatted for output, then it must be converted back in all cases. A method will be added to return values in local units at a later point. internalParse() DbExpression internalParse("XLEN * 100") double double Note Int Int String int DbAttribute[]
comparison date in c#
There are no explicit methods exposed in C# which cover comparison across sessions. It is not currently possible to set the comparison date in C#. There are however a number of pseudo attributes that can be accessed as follows: ATTMOD Bool DbAttribute True if specified attribute has been modified this session ATTMODC bool DbAttribute True if specified attribute has been modified since comparison date ATTMODLIST DbAttribute[] int List of attributes modified since given session ATTMODLISTC DbAttribute[] List of attributes modified since comparison date CRINFO string DB creation information DBSESS int Last DB session ELECRE bool int True if created since given session ELECREC bool True if created since comparison date ELEDEL bool int True if deleted since given session ELEDELC bool True if deleted since comparison date ELEMOD bool int True if modified since given session ELEMODC bool True if modified since comparison date EXMOD bool True if element modified in this extract HIST Int[] DbAttribute History of sessions in which element or specified attribute were made LASTM string DbAttribute Date of last modification MSESS int DbAttribute Last session number PRVSES int int Previous Session to that specified RULEMOD bool DbAttribute True if rule modified this session RULEMODC Bool DbAttribute True if rule modified since comparison date RULEMODLIST DbAttribute[] int List of rules modified since given session RULEMODLISTC DbAttribute[] List of rules modified since comparison date SESCLA int Session Of Claim SESSC string int Comment for specified session SESSCA Int[] List of pairs of DB number, last session number for all referenced DBs SESSCH Int[] As for SESSCA, but searches all descendants for referenced DBs SESSD string int Date of specified Session SESSM int DbAttribute Session Of Last Modification SESSNO int Current opened Session SESSU string int User creating specified session USERM string DbAttribute User making last modification Bool DbAttribute bool DbAttribute DbAttribute[] int DbAttribute[] string int bool int bool bool int bool bool int bool bool Int[] DbAttribute string DbAttribute int DbAttribute int int bool DbAttribute Bool DbAttribute DbAttribute[] int DbAttribute[] int string int Int[] Int[] string int int DbAttribute int string int string DbAttribute
Iterators
The DBElementCollection class can be used to iterate through the database hierarchy. The iterator is created with a root element and an optional filter. There are then methods to step through the hierarchy and return the element at the current location. For example: to look for all nozzles below a given element The collection can then be iterated through using foreach The iterator class has been written to avoid unnecessarily scanning parts of the database that will not match the filter, for example: if looking for all boxes then the iterator will not bother to look below pipes. TypeFilter filt = new TypeFilter(DbElementTypeInstance.NOZZLE); DBElementCollection collection; collection = new DBElementCollection(ele, filt); foreach (DbElement ele in collection) { …. Do something } DBElementCollection TypeFilter new TypeFilter(DbElementTypeInstance DBElementCollection new DBElementCollection ele foreach ( DbElement in collection)
Filters
There are a variety of ready built filter classes available. The main ones are: TypeFilter - True for given Element type(s) AttributeFalseFilter - True if given attribute is false AttributeTrueFilter - True if given attribute is true AttributeRefFilter - True if given attribute value matches given DbElement AndFilter - AND two existing filters OrFilter - OR two existing filters BelowFilter - Filter to test if element is below an element for which the given filter is true. TypeFilter AttributeFalseFilter AttributeTrueFilter AttributeRefFilter AndFilter OrFilter BelowFilter
Dabacon Tables
In the Dabacon schema we can define an attribute to be an indexed attribute. Indexed attributes go into a Dabacon table. Tables consist of a list of key/value pairs. The key may be a string (ntable), integer (itable) or reference (ftable). The 'value' part of the pair is always the refno of the element having that attribute value, for example: internally a name table may look something like: ….. Janet = 123/456 John = 321/543 Jonathon = 111/321 … Thus for a given name, the corresponding element can rapidly be found without having to scan the entire Multiple DataBase (MDB). The keys in a name table must be unique. Integer and reference tables may contain the same key many times, for example: internally a reference table may look like: …. =123/456 =234/555 =123/456 =222/333 =123/456 =211/999 =123/458 =203/909 In the above table, element =123/456 has appeared in the table three times. This means that three different elements were all referencing =123/456 for this particular attribute. This is common, for example: catalogue references are reference tables, and for these there may be hundreds of elements referencing the same catalogue component. A further point worth noting with respect to tables: Each Database (DB) has its own table. The entries in that table are for 'values' in that DB. Thus for the above ftable, =234/555 etc must be in this DB. However =123/456, =123/458 may be in a different DB. Indeed there may well be further references to =123/458 from other DBs. Hence to find all references to =123/456 we need to check the tables in each opened DB. Each Database (DB) has its own table. The entries in that table are for 'values' in that DB. Thus for the above ftable, =234/555 etc must be in this DB. However =123/456, =123/458 may be in a different DB. Indeed there may well be further references to =123/458 from other DBs. Hence to find all references to =123/456 we need to check the tables in each opened DB. Each Database (DB) has its own table. The entries in that table are for 'values' in that DB. Thus for the above ftable, =234/555 etc must be in this DB. However =123/456, =123/458 may be in a different DB. Indeed there may well be further references to =123/458 from other DBs. Hence to find all references to =123/456 we need to check the tables in each opened DB.
C# classes to access directly to the Dabacon Tables
There are C# classes that enable direct access to the Dabacon tables. The classes are defined as follows: NameTable - for iterating through name tables RefTable - for iterating through reference tables IntTable - for iterating through integer tables These classes work on a single DB. In most cases, we really want to iterate through all DBs in the MDB as if it was one table. Thus for integer and name tables there are iterator classes that go across the whole MDB as follows: MdbNameTable - for iterating through a name table across entire MDB MdbIntTable - for iterating through an integer table across entire MDB There is no method for iterating through a reference table since the order of references in a table is not meaningful. There are also methods to return all entries for a given key. This is particularly useful for reference tables; these are methods of the MDB class. In C# there is a NameTable class. An example of C# code that looks for all names starting with the letter 'B' is as follows: Dabacon allocates search tokens when scanning tables. It has a limited number of search tokens. If you get to the end of the table then the token is freed automatically. However if you stop the search before you get to the end then you must explicitly free the token. The IDispose method is used to free the underlying Dabacon token. Therefore ALWAYS scan the Dabacon table within a 'using' block to make sure that the Dispose method is called. If the underlying token is not freed then errors will be output to the AVEVA module command line of the form: The error generating code does not actually free the tokens. So typically you will see the number climb as more tokens are used up and not freed. The messages will be generated until the database is closed. string nam1=new string("/B"); string nam2=new string("/C"); NameTable ntable = new MdbNameTable(db, DBAttribute.NAME, nam1, nam2); using (ntable) { foreach (Element ele in ntable) { // Do something here with each element } } "xx dabacon search tokens - Expected none " NameTable RefTable IntTable MdbNameTable MdbIntTable new using foreach in
Multiple DataBase Functionality
The Miltiple DataBase (MDB) class exposes methods that act on the currently opened MDB. This is a singleton class. It contains methods to Related pseudo attributes are: OKDROP bool True if element may be dropped OKRLEX bool True if element may be extract released Open/close an MDB. Save work / quit work. Query claims. Claim/release elements Extract operations, for example: flush, refresh, extract claim, extract release, extract drop. Get opened DataBases (DBs). Return an element(s) of a given name. Return elements with matching values in name and integer tables (as described in previous section. Open/close an MDB. Open/close an MDB. Save work / quit work. Save work / quit work. Query claims. Query claims. Claim/release elements Claim/release elements Extract operations, for example: flush, refresh, extract claim, extract release, extract drop. Extract operations, for example: flush, refresh, extract claim, extract release, extract drop. Get opened DataBases (DBs). Get opened DataBases (DBs). Return an element(s) of a given name. Return an element(s) of a given name. Return elements with matching values in name and integer tables (as described in previous section. Return elements with matching values in name and integer tables (as described in previous section.
DstaBase Functionality
When an Multiple Database (MDB) is opened, a Database (DB) class instance is created for each opened DB. The functionality offered by this class falls into the following categories: ACCEDB string DB access CLAIM String Implicit or explicit claims CLCCNT int Claim list changes count CSESS String int Comment entered for specified session DACC String Database access DBLC DbElement[] List of LOCs belonging to a DB DCLA String Database claim mode DSESS String int Date of specified session EXPIRY String Protected DB Expiry date EXTALS DbElement[] Extract ancestors EXTCLS DbElement[] Extract children EXTDES DbElement[] Extract descendants EXTFAM DbElement[] Extract family FILENAME String DB filename FOREIGN string Originating project HCCNT int Header/Extract list changes count ISDBFR bool True if database is foreign ISDRDB Bool True if database has drawings ISWORK bool True if a working extract LINKSN int Linked session on parent extract LPROT bool Protected DB Flag MDBCLS DbElement[] List of MDBs in which DB is current MDBLS DbElement[] List of MDBs to which DB belongs NACCNT int Non-additive changes count NAMEDB string DB name NXTDBN int Next DB number NXTEXN int Next DB extract number NXTFDB int Next DB file and DB number NXTFLN int Next DB file number PSESS int int Previous session number SIZEDB int Size of DB STPDBS DbElement[] Stamps containing db STPSES Int[] Sessions used in at least one stamp STYPDB string DB sub type TYPEDB string DB type USESS string int User creating session In addition for any DbElement in any DB, the following pseudo attributes provide information on the current DB: DBAC String DB Access, MULTIWRITE or UPDATE DBCL String DB Claim DBCNTL Bool True if element is in a control DB DBEXNO int DB Extract Number DBFI String DB filename DBFN int DB file number DBNA String DB name DBNU int DB Number DBREF DbElement Reference of DB element DBTY String DB type (DESI, CATA etc) DBVAR Bool True if element is in a variant DB DBWRITE Bool True if element is in a writable DB WDBNA STRING Working DB name Query the properties of the DB, for example: number, MULTIWRITE or not Returning the world element for that DB Session information, for example: when was the session written and by whom. There is a DbSession object that holds details on a database session. Return the DbElement in the system DB that represents this DB. This DbElement can then be used to query system attributes and additional pseudo attributes. The additional pseudo attributes available on the DbElement representing the DB are described below: Query the properties of the DB, for example: number, MULTIWRITE or not Query the properties of the DB, for example: number, MULTIWRITE or not Returning the world element for that DB Returning the world element for that DB Session information, for example: when was the session written and by whom. There is a DbSession object that holds details on a database session. Session information, for example: when was the session written and by whom. There is a DbSession object that holds details on a database session. Return the DbElement in the system DB that represents this DB. This DbElement can then be used to query system attributes and additional pseudo attributes. The additional pseudo attributes available on the DbElement representing the DB are described below: Return the DbElement in the system DB that represents this DB. This DbElement can then be used to query system attributes and additional pseudo attributes. The additional pseudo attributes available on the DbElement representing the DB are described below: string String int String int String DbElement[] String String int String DbElement[] DbElement[] DbElement[] DbElement[] String string int bool Bool bool int bool DbElement[] DbElement[] int string int int int int int int int DbElement[] Int[] string string string int String String Bool int String int String int DbElement String Bool Bool STRING
Events
The database events fall into the following groups: General capture of Database changes. Writing Pseudo attributes for User Defined Attributes (UDAs). DB/MDB related events. General capture of Database changes. General capture of Database changes. Writing Pseudo attributes for User Defined Attributes (UDAs). Writing Pseudo attributes for User Defined Attributes (UDAs). DB/MDB related events. DB/MDB related events.
The generalised mechanism in C#
The generalised mechanism in C# is as follows: There is a delegate to define the event signature. There is a method to add a delegate to the list of event handlers to be called. There is a delegate to define the event signature. There is a delegate to define the event signature. There is a method to add a delegate to the list of event handlers to be called. There is a method to add a delegate to the list of event handlers to be called.
Dblayer maintains a change list of Database(DB)
DBlayer maintains a change list of Database (DB) changes. Users can subscribe to this list of changes. The list of changes is encapsulated in the DbUserChanges class. The DbUserChanges class has methods to determine what changes have been made, for example: elements created or deleted or modified. The delegates are: To add a subscriber (handler), the method is: This will be in the DbEvents class. The subscribers receive a DbUserChanges class instance which has a list of elements changed and what the changes are. The events are fired as follows: The event will only be fired if database changes have been made. public delegate void ChangeEventHandler(DbUserChanges changes); public static void AddChangeEventHandler(ChangeDelegate plug) At the end of running in a Programmable Macro Language (PML) macro After the execution of an AVEVA module specific command on the command line When any action on a form has completed. At the end of running in a Programmable Macro Language (PML) macro At the end of running in a Programmable Macro Language (PML) macro After the execution of an AVEVA module specific command on the command line After the execution of an AVEVA module specific command on the command line When any action on a form has completed. When any action on a form has completed. public delegate public static void
Calculate the value of pseudo attributes
Code can be plugged in to calculate the value of pseudo attributes. The code to do this must be registered in the AVEVA module by passing in a C# delegate. Code can be registered in two ways: The same UDA may have multiple delegates registered for different element types. There is a different delegate for each attribute type, for example: for integer attributes the delegate is: These are defined in the DbPseudoAttribute class. The user must write a method that matches the method signature of the delegate, for example: to write pseudo attribute code for a 'double' attribute, the user must write a method that has the signature defined by 'GetDoubleDelegate'. for example, a method that takes a DbElement, a DbAttribute, int and returns a double. For example: the following method would be valid: An instance of the delegate containing the method must then be created and registered with the AVEVA module. There are separate methods to register the different types of delegates. There are also separate methods to add a plugger for a particular element type, for example: the two methods to add a GetDoubleDelegate are: An example of registering a delegate is: Code may be plugged by User Defined Element Type (UDET) as well as the base type. The following criteria are used to locate the right plugged code: for example: you could add three delegates to calculate :WEIGHT. You could add one that calculates the :WEIGHT on a :MYELE, one that calculates the :WEIGHT of SCTN and one that calculates WEIGHT for any other element for which :WEIGHT is valid. A delegate only needs adding once at start up. The events do not allow for errors. Thus if the value can not be calculated then the pseudo attribute code should return a sensible default. public delegate double GetDoubleDelegate(DbElement ele, DbAttribute att, int qualifier); // Double delegate for UDA static private double VolumeCalculation(DbElement ele,DbAttribute att,int qualifier) { // calculate the volume by multiplying the lengths along each side double x=ele.GetDouble(ATT.XLEN); double y=ele.GetDouble(ATT.YLEN); double z=ele.GetDouble(ATT.ZLEN); // Result of UDA must be returned return (x * y * z); } public static void AddGetDoubleAttribute(DbAttribute att,GetIntDelegate plug) public static void AddGetDoubleAttribute(DbAttribute att, DbElementType type, GetIntDelegate plug) using System; using NOUN=Aveva.Core.Database.DbElementTypeInstance; using Ps=Aveva.Core.Database.DbPseudoAttribute; namespace Aveva.Core.Shared.Tests { static public void RegisterDelegate() { // get uda attribute DbAttribute uda=DbAttribute.GetDbAttribute(":VOLUME"); // Create instance of delegate containing "VolumeCalculation" method Ps.GetDoubleDelegate dele=new Ps.GetDoubleDelegate(VolumeCal\-culation); // Pass delegate instance to core PDMS. This will be invoked later // when :VOLUME is queried. // In this case registry for all valid element types. Ps.AddGetDoubleAttribute(uda,dele); } } public delegate 'GetDoubleDelegate' DbElement DbAttribute // Double delegate for UDA static private double // calculate the volume by multiplying the lengths along each side double double double // Result of UDA must be returned return GetDoubleDelegate public static void public static void using using using namespace static public void // get uda attribute // Create instance of delegate containing "VolumeCalculation" method =new // Pass delegate instance to core PDMS. This will be invoked later // when :VOLUME is queried. // In this case registry for all valid element types.
pre actions and post action
The following events can be captured: Except for quit, the pre actions are really called post action but with the Database (DB) in the pre action state. The pre action is only called if the action succeeds. Most of the pre and post actions fall into just two categories: The interested parties are different in the two cases. When changing the database file, the interested parties are 3rd party systems outside of the AVEVA module. When changing our view of the database it is the current session that needs to reflect the changes, for example: update the 3D graphics and explorer. The events raised reflect this split. The events are: CommitPending - This is called to commit any outstanding change to the database. It is called prior to setmark, undo, redo, Savework, quit, Getwork. ClearCache() - This will be called after doing a temporary switch to a different session in a DB, or after doing a Getwork, undo, redo, quit. CommitPending - This is called to commit any outstanding change to the database. It is called prior to setmark, undo, redo, Savework, quit, Getwork. CommitPending - This is called to commit any outstanding change to the database. It is called prior to setmark, undo, redo, Savework, quit, Getwork. ClearCache() - This will be called after doing a temporary switch to a different session in a DB, or after doing a Getwork, undo, redo, quit. ClearCache() - This will be called after doing a temporary switch to a different session in a DB, or after doing a Getwork, undo, redo, quit. Pre and Post events for local changes. i.e. changes affecting the current view of the data. These will be Getwork, undo, redo. Pre and Post events for changes affecting the data on the DB. These will be Savework, refresh, drop, flush, refresh. These will pass the list of changes. For 'global' DBs, if the parent extract is at a different location, the flush event will be raised by the child extract. Pre and Post events for local changes. i.e. changes affecting the current view of the data. These will be Getwork, undo, redo. Pre and Post events for local changes. i.e. changes affecting the current view of the data. These will be Getwork, undo, redo. Pre and Post events for changes affecting the data on the DB. These will be Savework, refresh, drop, flush, refresh. These will pass the list of changes. For 'global' DBs, if the parent extract is at a different location, the flush event will be raised by the child extract. Pre and Post events for changes affecting the data on the DB. These will be Savework, refresh, drop, flush, refresh. These will pass the list of changes. For 'global' DBs, if the parent extract is at a different location, the flush event will be raised by the child extract. Post claim/release events Post failed Getwork/Savework Post claim/release events Post claim/release events Post failed Getwork/Savework Post failed Getwork/Savework Note: ClearCache may be called thousands of times within a single operation. Thus any event handlers must be fast. Note: In this case the flush could still fail at the parent. Alternatively the daemon needs to raise the flush event. CommitPending ClearCache() Note : ClearCache Note :
Units
Real dimensioned quantities may be created or returned as objects of type DbDouble which have a dimension, DbDoubleDimension, current units, DbDoubleUnits, and a real value which may be presented as a string using a format object, DbFormat. Standard dimensions and units are defined by the enumerated types DbDimension and DbUnits returned by DbDoubleDimension and DbDoubleUnits respectively. The DbElement Get/Set interface supports both undimensioned and dimensioned attributes which may be formatted using the DbFormat object. The following classes are available in the Aveva.Core.Database interface.
Represents a standard or compound unit constructed via static constructors
Represents a standard or compound unit constructed via static constructors. For example, construct a compound unit from an expression or construct a standard unit from a standard enumeration There is a static method to get all the defined standard and compound units and properties to get the description, dimension, conversion factor etc. For example, get the dimension of given units DbDoubleUnits u1 = DbDoubleUnits.GetUnits("kg.m.s-2"); DbDoubleUnits u1 = DbDoubleUnits.GetUnits(DbUnits.MM); DbDoubleUnits[] units = DbDoubleUnits.AllUnits(); DbDimension d1 = DbDoubleUnits.GetUnits(DbUnits.MM).Dimension; DbDoubleUnits DbDoubleUnits kg.m.s-2 DbDoubleUnits DbDoubleUnits ( DbUnits DbDoubleUnits DbDoubleUnits DbDimension DbDoubleUnits ( DbUnits
Enumeration fo standard units
Enumeration of standard units. For example: DbUnits.KG DbUnits
Represents a standard or compound dimension constructed via static constructors
Represents a standard or compound dimension constructed via static constructors. For example, construct a compound dimension from an expression or construct a standard dimension from a standard enumeration There are properties to get the current units for given dimension, all units for given dimension etc. For example, get all the units of given dimension DbAttribute also has a property, Dimension, which returns the dimension of given attribute. For example, DbDoubleDimension d1 = DbDoubleDimension.GetDimension("volt/m"); DbDoubleDimension d1 = DbDoubleDimension.GetDimension(DbDimension.DIST); DbDoubleDimension mass = DbDoubleDimension.GetDimension(DbDimension.MASS); DbDoubleUnits[] massUnits = mass.Units; DbAttribute ud1 = DbAttribute.GetDbAttribute(":UD1"); DbDoubleDimension dimension = ud1.Dimension; DbDoubleDimension DbDoubleDimension volt/m DbDoubleDimension DbDoubleDimension DbDimension DbDoubleDimension DbDoubleDimension DbDimension DbDoubleUnits DbAttribute DbAttribute :UD1 DbDoubleDimension
Enumeration fo standard dimensions
Enumeration of standard dimensions. For example DbDimension.MASS DbDimension
Represents a real dimensioned quantity
Represents a real dimensioned quantity which can be constructed from an expression and/or a format or returned from DbElement. For example, create a DbDouble from a real value or create a DbDouble from a string expression or get a dimensioned attribute from DbElement as a DbDouble DbDouble's may also be used to set dimensioned attributes. For example, setting the HBOR of a branch Quantities of dimension BORE may be created as follows from a real value or a string expression and a format returning the nearest nominal bore depending on the current BORE units. There are also properties to return the units, dimension etc. For example, get the units of given DbDouble To return a formatted string, For example and to convert to different units DbDouble also implements the expected binary operator overloads '+', '-', '\', '*', '==', '!=', '<', '<=', '>' and '>=' allowing arithmetic operations and comparison of dimensioned quantities. For example, adding 2 quantities of the same dimension together DbDouble d1 = DbDouble.Create(1.0); DbDouble d1 = DbDouble.Create("1.0kg"); DbElement bran = DbElement.GetElement("/100-B-1-B1"); DbDouble hbor = bran.GetDbDouble(DbAttributeInstance.HBOR); DbElement bran = DbElement.GetElement("/100-B-1-B1"); DbDouble hbor = DbDouble.Create("300", fbore) bran.SetAttribute(DbAttributeInstance.HBOR, hbor); DbDouble bore = DbDouble.CreateBore(300); DbFormat fbore = DbFormat.Create(); fbore.Dimension = DbDoubleDimension.GetDimension(DbDimension.DIST); fbore.Units = DbDoubleUnits.GetUnits(DbUnits.FINC); DbDouble bore = DbDouble.CreateBore("12", fbore); DbDouble d1 = DbDouble.Create("2m"); DbDoubleUnits u1 = d1.Units; DbFormat ftemp = DbFormat.Create(); ftemp.Dimension = DbDoubleDimension.GetDimension(DbDimension.TEMP); ftemp.Units = DbDoubleUnits.GetUnits("degRankine"); ftemp.Label = "degRan"; DbDouble t1 = DbDouble.Create("3 celsius"); String tempStr = t1.ToString(ftemp); DbDouble d1 = DbDouble.Create("1kg"); DbDouble d2 = d1.ConvertUnits(DbDoubleUnits.GetUnits(DbUnits.LB)); d1 = DbDouble.Create("1 kg"); d2 = DbDouble.Create("2.2046 lb"); d3 = d1 + d2; DbDouble DbDouble DbDouble DbDouble 1.0kg DbElement DbElement /100-B-1-B1 DbDouble ( DbAttributeInstance DbElement DbElement /100-B-1-B1 DbDouble DbDouble 300 ( DbAttributeInstance DbDouble DbDouble 300 DbFormat DbFormat DbDoubleDimension DbDimension DbDouble DbDouble 12 DbDouble DbDouble 2m DbDoubleUnits u1 DbFormat DbFormat DbDoubleDimension DbDimension DbDoubleUnits degRankine degRan DbDouble DbDouble 3 celsius String DbDouble DbDouble DbDouble DbDoubleUnits ( DbUnits DbDouble 1 kg DbDouble 2.2046 lb