Headers
stringlengths
3
162
Content
stringlengths
12
32.8k
Performance Considerations
A new session is created for every flush operation. Thus it is much better to flush a large number of elements in one go rather than flush them individually.
Global Working
Global allows Databases (DBs) to be spread across different locations. Global propagates changes from one location to another. The Global daemon does the propagation. With global, there may be copies of a database or extract at multiple locations, but only one copy may be writeable. A database is said to be primary at a given location if it is writeable there, and secondary if it is not. A DB may be made primary at any location. Different extracts from the same extract family may be primary at different locations. This allows multiple different locations to modify the same DB.
Global Propagation
Changes made to a primary database (DB) are propagated to the read only secondary DBs. The propagation algorithm just sends the new sessions. For example: If this case the propagation algorithm will send the sessions 20 to 39 to the secondary location.
Extract Claim/Release with Global
If the two extracts are primary at the same location, then the extract claim/release operations are the same as for non global projects. If the two extracts are primary at different locations then the claim/release goes via the daemon. For example: The extract claim operation is thus asynchronous. You have to wait to discover if the claim succeeded or not.
Flush with Global
If the two extracts are primary at the same location, then the flush operation is the same as for non global projects. If the two extracts are primary at different locations then the steps are as follows: The steps are: Step 2 could fail for normal reasons, e.g. a name clash. If so the primary child extract needs to be informed so that next time it uses the correct base session for comparison purposes. At the command level this is the 'EXTRACT FLUSH RESET' command.
Merge Changes for Global Extracts
In the Global environment MERGE CHANGES will only be allowed where all lower extracts are also primary on this location.
Undo Capabilities
Information is provided on the undo/redo and Backtrack/rewind behavior within the session.
Undo/Redo within a Session
The AVEVA E3D Design database has a built in undo/redo capability. Applications may define a start/end transaction and wind back to the start of that transaction. Internally this is implemented using 'micro' sessions. Each micro session represents the start of each transaction. An undo can not be done across a SAVEWORK.
Backtrack/Rewind
The system administrator may remove the last one or many sessions from the Database (DB).
Database Navigation and Query Syntax
This section covers aspects of database navigation. Many examples are given during a Model´session but are also relevant to the Draw module.
Current Element
The database has a concept of current element. This is often referred to as the Current Element (CE). The current element is highlighted in the explorer. In the 3D view the current element is shown in a different colour. Many Programmable Macro Language (PML) commands work on the current element. The current element can be changed in the following ways: By picking an element in the explorer By picking an element in the 3D view By typing an element name into the name box By typing a navigation command at the command line By picking an element in the explorer By picking an element in the explorer By picking an element in the 3D view By picking an element in the 3D view By typing an element name into the name box By typing an element name into the name box By typing a navigation command at the command line By typing a navigation command at the command line
Current Position
There is also a concept of a current position. The concept of current position is only used when creating elements or when navigating down to the next level. By default the current position is before the first member. This is described further in Climb Up. Climb Up Climb Up
PML DBRef Object
Programmable Macro Language (PML) supports a Database Reference (DBREF) object. A DBREF object identifies an element in the AVEVA E3D Design database. There are various methods available on the DBREF object. The methods for a DBREF are described in the software customization manual.
PML !!CE Variable
There is a global Programmable Macro Language (PML) Database Reference (DBREF) variable called !!CE that tracks the database current element. This object may be used/queried at any time.
Specify the Standard Name
This is the simplest way of navigating around the database. Just enter the name of the element at the command line. A name is always preceded by a slash. For example: /PUMP99 /BRANCH2 /BRANCH2 will now be the CE.
Specify the Constructed Name
Unnamed elements always have a constructed name. The constructed name consists of: If the constructed name is given, that element will become the CE. For example: If the element is a UDET then the UDET name must be used instead of the system type. For example: the type and relative position in its owners list. the OF keyword the constructed name of its parent the type and relative position in its owners list. the type and relative position in its owners list. the OF keyword the OF keyword the constructed name of its parent the constructed name of its parent
Specify the World
The following syntax accesses the world element by name, type:
Specify the Refno
The reference number can always be used to navigate to an element.
Use the BACKREf attribute
The BACKREf attribute brings the back pointer reference for Reference Table Attributes and answer the question "what references me (ce)". The syntax is: For example, standing on a Specific Component (SPCO) and querying for BACKREf (attname SPREF ) will return all elements referencing that SPCO. Excluding the argument will list all Reference Table Attributes referencing Current Element (CE). For example: Q BACKREF [(ATTNAME att1 [, ATTNAME att2] )] Q BACKREF( attname SPCO) Q BACKREF
Specify a Relative Position in the Hierarchy
Relative navigation can be done using a number of commands as follows: Climb up Move within current level Move to next lower level Climb up Climb up Move within current level Move within current level Move to next lower level Move to next lower level
Climb Up
The following syntax is valid: OWNER climb to owning element. The owning element becomes the Current Element (CE). The current position is then before the first member END climbs to owning element. The owning element becomes the CE. The current position is at the previous element <Element type> climb to element of that type. This element becomes the new CE. This leaves the current position at the immediate member element that was climbed through. OWNER climb to owning element. The owning element becomes the Current Element (CE). The current position is then before the first member END climbs to owning element. The owning element becomes the CE. The current position is at the previous element <Element type> climb to element of that type. This element becomes the new CE. This leaves the current position at the immediate member element that was climbed through. For example, consider the following hierarchy: If the CE is /MYBOX, then: OWNER The CE becomes /MYEQUI. The current position is now before the first member. END Also climbs to /MYEQUI, but leaves the current position at /MYBOX EQUI Also climbs to /MYEQUI, and leaves the current position at /MYBOX SITE Climbs to /MYSITE, and leaves the current position at /MYZONE OWNER The CE becomes /MYEQUI. The current position is now before the first member. END Also climbs to /MYEQUI, but leaves the current position at /MYBOX EQUI Also climbs to /MYEQUI, and leaves the current position at /MYBOX SITE Climbs to /MYSITE, and leaves the current position at /MYZONE OWNER climb to owning element. The owning element becomes the Current Element (CE). The current position is then before the first member END climbs to owning element. The owning element becomes the CE. The current position is at the previous element <Element type> climb to element of that type. This element becomes the new CE. This leaves the current position at the immediate member element that was climbed through. OWNER The CE becomes /MYEQUI. The current position is now before the first member. END Also climbs to /MYEQUI, but leaves the current position at /MYBOX EQUI Also climbs to /MYEQUI, and leaves the current position at /MYBOX SITE Climbs to /MYSITE, and leaves the current position at /MYZONE OWNER END <Element type> OWNER END EQUI SITE
Move within the Current Level
Next Goes to next element in at current level Next int Goes to next nth element at current level Next <element type> Goes to next element of given type at current level Next int <element type> Goes to next nth element of given type at current level Prev Goes to prev element at current level Prev int Goes to prev nth element at current level Prev <element type> to previous element of given type at current level Prev int<element type> to previous nth element of given type at current level First Goes to first element at current level First int Goes to nth element at current level First <element type> Go to first element of given type First int <element type> Go to nth element of given type Last Go to last element at current level Last int Go to nth from last element at current level Last <element type> Go to last element of given type Last int <element type> Go to nth last element of given type <element type> int This is the same as ‘First int <element type>’ Next Goes to next element in at current level Next int Goes to next nth element at current level Next <element type> Goes to next element of given type at current level Next int <element type> Goes to next nth element of given type at current level Prev Goes to prev element at current level Prev int Goes to prev nth element at current level Prev <element type> to previous element of given type at current level Prev int<element type> to previous nth element of given type at current level First Goes to first element at current level First int Goes to nth element at current level First <element type> Go to first element of given type First int <element type> Go to nth element of given type Last Go to last element at current level Last int Go to nth from last element at current level Last <element type> Go to last element of given type Last int <element type> Go to nth last element of given type <element type> int This is the same as ‘First int <element type>’ If a UDET, then the UDET type must be given. The Current element is /MyCylC, as highlighted. Moves CE to /MyBoxB Moves CE to /MyCylD Moves CE to /MyCylD Moves CE to /MyBoxD Moves CE to /MyRtorA Moves CE to /MyCylB Moves CE to /MyBoxA Moves CE to /MyCylA Moves CE to /MyBoxA Moves CE to /MyCylA Moves CE to /MyCylA Moves CE to /MyCylC This is the same as FIRST 2 BOX. Moves CE to /MyBoxB. Moves CE to /MyBoxD Moves CE to /MyCylD Moves CE to /MyCylD Moves CE to /MyCylB Next Goes to next element in at current level Next int Goes to next nth element at current level Next <element type> Goes to next element of given type at current level Next int <element type> Goes to next nth element of given type at current level Prev Goes to prev element at current level Prev int Goes to prev nth element at current level Prev <element type> to previous element of given type at current level Prev int<element type> to previous nth element of given type at current level First Goes to first element at current level First int Goes to nth element at current level First <element type> Go to first element of given type First int <element type> Go to nth element of given type Last Go to last element at current level Last int Go to nth from last element at current level Last <element type> Go to last element of given type Last int <element type> Go to nth last element of given type <element type> int This is the same as ‘First int <element type>’ NEXT Moves CE to /MyBoxB NEXT 3 Moves CE to /MyCylD NEXT CYL Moves CE to /MyCylD NEXT 3 BOX Moves CE to /MyBoxD PREV Moves CE to /MyRtorA PREV 2 Moves CE to /MyCylB PREV BOX Moves CE to /MyBoxA PREV 2 CYL Moves CE to /MyCylA FIRST Moves CE to /MyBoxA FIRST 2 Moves CE to /MyCylA FIRST CYL Moves CE to /MyCylA FIRST 3 CYL Moves CE to /MyCylC BOX 2 This is the same as FIRST 2 BOX. Moves CE to /MyBoxB. LAST Moves CE to /MyBoxD LAST 2 Moves CE to /MyCylD LAST CYL Moves CE to /MyCylD LAST 3 CYL Moves CE to /MyCylB Next Next int Next <element type> Next int <element type> Prev Prev int Prev <element type> Prev int<element type> First First int First <element type> First int <element type> Last Last int Last <element type> Last int <element type> <element type> int 5 CYL /MyCylC NEXT NEXT 3 NEXT CYL NEXT 3 BOX PREV PREV 2 PREV BOX PREV 2 CYL FIRST FIRST 2 FIRST CYL FIRST 3 CYL BOX 2 LAST LAST 2 LAST CYL LAST 3 CYL
Move to Next Lower Level
The syntax for moving down a level shares much of the syntax for moving within the level. Int descend to nth child First Member Goes to 1st member Last Member Goes to last member First <element type>, FirstMember<element type> Goes to first member of given type First int <element type> Go to nth element of given type in members list Last <element type>, LastMember<element type> Goes to last member of given type Last int <element type> Go to nth last element of given type in members list Next <element type> Goes to next element in member list from current position Next int <element type> Goes to next nth element in member list of given type from current position Prev <element type> Goes to next element in member list from current position Prev int <element type> Goes to previous nth element in member list of given type from current position <element type> int descend to nth child of given type Int descend to nth child First Member Goes to 1st member Last Member Goes to last member First <element type>, FirstMember<element type> Goes to first member of given type First int <element type> Go to nth element of given type in members list Last <element type>, LastMember<element type> Goes to last member of given type Last int <element type> Go to nth last element of given type in members list Next <element type> Goes to next element in member list from current position Next int <element type> Goes to next nth element in member list of given type from current position Prev <element type> Goes to next element in member list from current position Prev int <element type> Goes to previous nth element in member list of given type from current position <element type> int descend to nth child of given type We can use the same example as before but in this case we are positioned at the owning equipment, say /MYEQUI. The current position is defaulted to the start of the list. The member list being: Moves CE to /MyCylC (5th member) Moves CE to /MyBoxA Moves CE to /MyBoxD Moves CE to /MyCylA Moves CE to /MyCylC Moves CE to /MyCylD Moves CE to /MyCylC Moves CE to /MyCylA (same as FIRST CYL) Moves CE to /MyCylB (same as FIRST 2 CYL) Invalid as there are no cylinders before the current position Moves CE to /MYBoxD In the above examples, the use of NEXT had the same result as using FIRST. The use of PREV was invalid. This is because the current position was off the start. We can change the current position using the END syntax to give more meaningful examples For example: The CE is /MyEqui as before, but with the current position at /MyCylB Moves CE to /MyCylC Moves CE to /MyCylD Moves CE to /MyCylA Int descend to nth child First Member Goes to 1st member Last Member Goes to last member First <element type>, FirstMember<element type> Goes to first member of given type First int <element type> Go to nth element of given type in members list Last <element type>, LastMember<element type> Goes to last member of given type Last int <element type> Go to nth last element of given type in members list Next <element type> Goes to next element in member list from current position Next int <element type> Goes to next nth element in member list of given type from current position Prev <element type> Goes to next element in member list from current position Prev int <element type> Goes to previous nth element in member list of given type from current position <element type> int descend to nth child of given type 5 Moves CE to /MyCylC (5th member) FIRST MEMBER Moves CE to /MyBoxA LAST MEMBER Moves CE to /MyBoxD FIRST CYL Moves CE to /MyCylA FIRST 3 CYL Moves CE to /MyCylC LAST CYL Moves CE to /MyCylD LAST 2 CYL Moves CE to /MyCylC NEXT CYL Moves CE to /MyCylA (same as FIRST CYL) NEXT 2 CYL Moves CE to /MyCylB (same as FIRST 2 CYL) PREV CYL Invalid as there are no cylinders before the current position BOX 4 Moves CE to /MYBoxD NEXT CYL Moves CE to /MyCylC NEXT 2 CYL Moves CE to /MyCylD PREV CYL Moves CE to /MyCylA /MyCylB END Int First Member Last Member First <element type>, FirstMember<element type> First int <element type> Last <element type>, LastMember<element type> Last int <element type> Next <element type> Next int <element type> Prev <element type> Prev int <element type> <element type> int 5 FIRST MEMBER LAST MEMBER FIRST CYL FIRST 3 CYL LAST CYL LAST 2 CYL NEXT CYL NEXT 2 CYL PREV CYL BOX 4 NEXT CYL NEXT 2 CYL PREV CYL
Syntax Ambiguity Between Moving Across and Down
In most cases there is no ambiguity with having some of the same syntax for moving down and moving across. This is because it is rare to have the same element type as a sibling and a member. However there are some situations where this does occur. In these cases, the default is to move down rather than across. For example. If the CE is /SUBE1, then BOX 1 Moves CE to /BoxX (NOT /BoxA) NEXT BOX Moves CE to /BoxX (NOT /BoxB) LAST BOX Moves CE to /BoxY (NOT /BoxB) BOX 1 Moves CE to /BoxX (NOT /BoxA) NEXT BOX Moves CE to /BoxX (NOT /BoxB) LAST BOX Moves CE to /BoxY (NOT /BoxB) BOX 1 Moves CE to /BoxX (NOT /BoxA) NEXT BOX Moves CE to /BoxX (NOT /BoxB) LAST BOX Moves CE to /BoxY (NOT /BoxB) BOX 1 NEXT BOX LAST BOX
Climb up by Default
The commands to move to an element at the same level, may also be used for elements at any higher level. which means, if the command is invalid at the CE, AVEVA E3D Design will keep on climbing until the command becomes valid. For example, for the previous example, with the Current element (CE) at /BoxY: SUBE 2 Moves CE to /SUBE2 LAST SUBE Moves CE to /SUBE2 FIRST ZONE Moves CE to /Zone1 (assuming that this is the first zone) SUBE 2 Moves CE to /SUBE2 LAST SUBE Moves CE to /SUBE2 FIRST ZONE Moves CE to /Zone1 (assuming that this is the first zone) SUBE 2 Moves CE to /SUBE2 LAST SUBE Moves CE to /SUBE2 FIRST ZONE Moves CE to /Zone1 (assuming that this is the first zone) SUBE 2 LAST SUBE FIRST ZONE
Use the ‘OF’ Syntax
The commands described so far all work on the Current Element (CE). It is allow able to do a navigation relative to any element by using the ‘OF’ syntax. For example: The ‘constructed’ name is actually an example of the use of the ‘OF’ syntax. The ‘OF’ syntax can be nested as much as required. For example: FIRST MEMBER OF /ZONE1 FIRST MEMBER OF FIRST BOX OF NEXT EQUI
Other Syntax
Information provided on the GOTO Syntax and how to return to the previous current element..
Use the GOTO Syntax
The GOTO command can be used to go to any reference attribute. For example: This will go to the element pointed to by the CREF of the Current Element (CE). As with other navigation commands, the ‘OF’ syntax may be used to go to reference on a different element. For example: Pseudo attributes can be specified after GOTO. A particularly useful pseudo attribute is FRSTW. This goes to first world of a given type. For example: This will go to the first catalog world. GOTO CREF GOTO HREF OF /BRANCH88 GOTO FRSTW CATA
Return to the Previous Current Element
The SAME command will always return to the previous current element. For example: The current element will now be /VESS1. /VESS1 /SECTION99 SAME
ID Expressions
The above commands are all examples of an identification (ID) expression. The one exception is the ‘GOTO’ syntax. This keyword is omitted within an ID expression. ID expressions should be enclosed in brackets, although in most cases, they will work without the brackets. An ID expression may itself be queried or assigned to a Programmable Macro Language (PML) variable. Querying an expression or assigning it to a PML variable dos NOT change the CE. Assigning an ID expression to a PML variable is a common way to write PML. Q ( NEXT BOX) !MyEle = ( next box ) !MyEle = ( next box of /VESS1 ) !MyEle = (SPRE )
Special Cases
Information provided on the User Defined Element Type (UDET) and the TRACE command.
UDETs
A User Defined Element Type (UDET) may be used wherever an element type is valid. For example: The following exception applies: When climbing, either the UDET or the base type may be specified. For example: (:MYBOX 1 OF /VESS1 ) NEXT :MYBOX FIRST 2 :MYBOX :MYEQUIP - will climb to /VESSEL EQUIP - will also climb to /VESSEL
Trace Command
If in TeleTypewriter (TTY) mode, the TRACE ON/OFF command can be turned on track changes in current element. The default is on.
Pseudo Attributes Relating to Navigation
The following pseudo attributes relate to the database hierarchy. These can be queried directly or via a Programmable Macro Language (PML) variable. ALLELE DBREF ElementType All elements in the MDB of a particular type CONNECTIONS DBREF array Connections CONNECTIONSH DBREF array Connections for all descendants CONNER String Int Connection error message DDEP Int Database depth within hierarchy (World is 0) FRSTW DBREF String Reference of first world of given DB type in current MDB MAXD Int DB hierarchy depth of lowest level item beneath element MBACK DBREF array *ElementType Members in reverse order MCOU Int *ElementType Number of Element Members of Given type MEMB DBREF array *ElementType All members, or members of specific type OWNLST DBREF array Owning hierarchy PARENT DBREF *ElementType Reference of ascendant element of specified type SEQU Int Sequence Position in Member List TYSEQU Int Type Sequence Number ‘*’- qualifier is optional Attribute Name Data Type Qualifier Description ALLELE DBREF ElementType All elements in the MDB of a particular type CONNECTIONS DBREF array Connections CONNECTIONSH DBREF array Connections for all descendants CONNER String Int Connection error message DDEP Int Database depth within hierarchy (World is 0) FRSTW DBREF String Reference of first world of given DB type in current MDB MAXD Int DB hierarchy depth of lowest level item beneath element MBACK DBREF array *ElementType Members in reverse order MCOU Int *ElementType Number of Element Members of Given type MEMB DBREF array *ElementType All members, or members of specific type OWNLST DBREF array Owning hierarchy PARENT DBREF *ElementType Reference of ascendant element of specified type SEQU Int Sequence Position in Member List TYSEQU Int Type Sequence Number
Attributes
Information is provided on attribute types, real attributes, physical quantities, setting and querying attributes, PML attribute classes and PML element type classes.
Attribute Types
Attributes can be the following types: Attributes may also be arrays of simple attributes Those supported are: Integer Real Bool (or Logical) String (or Text) Datetime Ref This is a pointer to another element by storing its internal database reference (as Integer(2) array) Position This is a special form of Real(3) array containing 3 distances Direction This is a special form of a Real(3) array Orientation This is a special form of a Real(3) array Word This a character string of up to either 4 or 6 American Standard Code for Information Interchange (ASCI)I upper case character string stored as an integer which is often interpreted either as an enumerated value or as a user readable name. Words are used for the simple names and for many enumerated integer values. They are often called hash codes. If more than 4 (or 6) characters are entered only the first ones will be used, but without generating an error. Lower case characters will be converted to uppercase, and non ASCII unicode characters will be ignored. The word cannot contain a space. The space is one of the characters that will automatically delimit the string. Different attributes are limited to either 4 or 6 characters, although attribute and element type names do have up to 6. Whether 4 or 6 are allowed is an implementation issue and the older attributes existing in originally introduced in earlier databases tend to be limited to 4 characters. Examples of their use are TYPE of elements and attributes. Modifier attributes (JUST = TOP, BOT) Pline names Unit field of real attributes and dimension setting attributes (PTYPE = DIST, BORE, NONE etc) Integer Integer Real Real Bool (or Logical) Bool (or Logical) String (or Text) String (or Text) Datetime Datetime Ref This is a pointer to another element by storing its internal database reference (as Integer(2) array) Ref Position This is a special form of Real(3) array containing 3 distances Position Direction This is a special form of a Real(3) array Direction Orientation This is a special form of a Real(3) array Orientation Word This a character string of up to either 4 or 6 American Standard Code for Information Interchange (ASCI)I upper case character string stored as an integer which is often interpreted either as an enumerated value or as a user readable name. Words are used for the simple names and for many enumerated integer values. They are often called hash codes. If more than 4 (or 6) characters are entered only the first ones will be used, but without generating an error. Lower case characters will be converted to uppercase, and non ASCII unicode characters will be ignored. The word cannot contain a space. The space is one of the characters that will automatically delimit the string. Different attributes are limited to either 4 or 6 characters, although attribute and element type names do have up to 6. Whether 4 or 6 are allowed is an implementation issue and the older attributes existing in originally introduced in earlier databases tend to be limited to 4 characters. Examples of their use are TYPE of elements and attributes. Modifier attributes (JUST = TOP, BOT) Pline names Unit field of real attributes and dimension setting attributes (PTYPE = DIST, BORE, NONE etc) Word Integer Array Real Array Bool (or Logical) Array Text Array Ref Array Integer Array Integer Array Real Array Real Array Bool (or Logical) Array Bool (or Logical) Array Text Array Text Array Ref Array Ref Array
Real Attributes of Physical Quantities
Real attributes can be purely numeric, but often they may be representing physical quantities. The type of a physical quantity is its (physical) dimension. Attributes of physical quantities are consistently stored in the database in defined database units, irrespective of the current working units, or of the units of any value entered by you. The whole system operates on the expectation that all stored values of physically dimensioned quantities are in their relevant standard database units. The following table lists the dimensions understood by the system giving: For example attributes of length have a hash code of DIST are stored in mm and other standard units include inch, cm, ft, metre: AbsPressure ABSP pascal bar atm PSI torr mmHg inHg pressure may be absolute or gauge Acceleration ACCL m/s2 ActualPower ACTPOW V.A Angle ANGL degree grade arcmin arcsec AngularAcceleration ANGCCE rad/s2 AngularFrequency ANGF deg/s rpm rps rph angFreqHertz AngularMomentum ANGM N.m.s Area SQDI mm2 acre hectare AreaPerLength AREALE m2/m AreaPerLength Bore BORE mm in Range of bore units limited to mm and inch (and Finch) CableSize CABL kcmil cirmil circmms CalorificValueMole CALVQ J/Mol CalorificValueVolume CALVV J/m3 Capacitance CAPA farad Charge CHAR coulomb Conductance COND siemens mho Content PCUD mm-3 ConvertiblePressure PRESC cpascala cpascalg cbarg catmg cpsig ctorrg cmmHgg cinHgg cbara catma cpsia ctorra cmmHga cinHga osia inHgaAtSixtyDegF mmHgaAtSixtyDegF inWateraAtSixtyDegF inWateraAtFourDegC ftWateraAtSixtyDegF ftWateraAtFourDegC ata Currency CURY USD GBP EUR Current CURR ampere CurrentDensity CURITY A/m2 Density DENS kg/m3 DensityMANDB MAND kg/mm3 densities stored in MANU database EffectiveHeatCapacity EFFCAP J/m/K ElectricChargeDensity ELECSI C/m3 ElectricConductivity CNDT S/m ElectricField EFLD V/m ElectricFluxDensity ELEFSI C/m2 EMF EMF volt Energy ENER kWh joule BTU calorie calorieit BTUit chu chuAtFifteenDegC EnergyDensity EDEN J/kg Entropy ENTR J/K Equivalence EQUIVA equivalent EquivalenceFlow EQULOW equiv/s EquivalencePerVolume EQPRME equiv/m3 FlowRateMolePerLength SQPTD Mol/s/m FlowRateVolPerRpm FRVPR Force FORC newton pdl dyne kgf lbf FoulingFactor FFAC m2.K/W Frequency FREQ hertz freqRpm freqRps freqRph GaugePressure GAGE pascal bar atm PSI torr mmHg inHg pressure may be absolute or gauge HeatCoefficientArea HEAREA W/K HeatFluxLinear HEAEAR W/m HeatingValue HVAL J/m3 HeatOfReaction HEAION J/m3/h HeatTransferCoeff HTRA W/m2/K Illuminance ILLUMI lux Impedance IMPE ohm Inductance INDU henry Inertia INER kg/m2 InversePressure INVURE pascal-1 InverseTemperature INVRAT kelvin-1 KinematicViscosity KVIS m2/s Stoke Length DIST mm m in ft cm km mile yard micron thou angstrom LinearDensity PDIS mm-1 Luminance LUMNCE cd/m2 LuminousFlux LUMLUX lumen LuminousIntensity LUMI Candela MagFieldIntensity MFIN A/m MagFluxDensity MFXD tesla MagneticFlux MGFX weber Mass MASS kg gram tonne lb oz longTon shortTon cwt longCwt shortCwt ozt grain stone MassFlow MFLO kg/s MassFlux MASLUX kg/s/m2 MassPerArea MAPEA kg/m2 MassPerEnergy MAPGY kg/J MassReactionRate MARETE kg/s/m3 MolarConcentration MOLONC Mol/m3 MolarEntropy MOLOPY J/Mol/K MolarFlow MOLLOW Mol/s MolarMass MOLASS kg/Mol MolarPermeability MOLITY MolarReactionRate MOLATV Mol/m3/s MolarReactionRateMass MOLATM Mol/kg/s MolarVolume MOLUME m3/Mol MoleFluxDensity MOLATA Mol/m2/s MolePerMass MOLALY Mol/kg Momentum MOME N.s Noise NOIS DecibelA Permeability PMBT H/m Permittivity PMTT F/m pH PH pH Power POWE kW hp watt PowerPerArea POPEA W/m2 PowerPerVolume POWUME W/m3 Pressure PRES pascal bar atm psi torr mmHg inHg osi inHgAtSixtyDegF mmHgAtSixtyDegF inWaterAtSixtyDegF inWaterAtFourDegC ftWaterAtSixtyDegF ftWaterAtFourDegC mmWaterAtSixtyDegF mmWaterAtFourDegC at PressurePerDistance PRPEST Pa/m PressurePerTemperature PRPEMP Pa/K PressureRate PREATE Pa/s Radiance RADNCE RadiantIntensity RADITY W/sr RadiationDose RDOS sievert rem gray raddose Radioactivity RADY Bq curie RadioactivityConc RADONC Bq/m3 Ratio RATIO Ratio pc ppm ppb ReactivePower REAC VAreac Resistivity REST ohm/m RotationalStiffness STFR N.m/rad SecondMomentOfArea SMOFA metre4 SolidAngle SANGL steradian SolventPermeability SOPETY kg/m2/s/Pa SpecFuelelConsumptionVol SPFUNS m3/J SpecHeatCapacity SHCP J/kg/K SpecificRadioactivity SPVITY Bq/g SpecificSurfaceMass SPEASS m2/kg Speed SPEE m/s knot Stiffness STIF N/m SubstanceQuantity SUBQ Mole lbMole stdcubicfoot stdcubicmeters SurfaceDensity PSQD mm-2 Temperature TEMP degC degF kelvin degRan TemperatureGradient TPDI degC/mm TemperatureRate TEMATE K/s TemperatureVolumePerMole VOLPTQ ThermalConductivity TCON W/m/K ThermalExpansionCoeff THENCO degC-1 ThermalResistance TRES K/W Time TIME second min hr day month week year Torque TORQ N.m UnitMass UMAS kg/mm ViscosityDynamic VISC Pa.s poise VolHeatTransferCoeff VOLEFF W/m3/K Volume CUDI mm3 litre ImpGal USGal bbl Mbbl MMbbl grt ImpQrt USQrt USDryQrt ImpPint USPint USDryPint ImpFloz USFloz USDryGal VolumetricFlow VFLO m3/s MSCubicFeetDay None NONE numerical real attribute WORD WORD used in assigning parameter dimensions etc. Parameter UNIPAR used for parameter attributes Name of Dimension HashCode/Word Database Units Other Specific Units Comments AbsPressure ABSP pascal bar atm PSI torr mmHg inHg pressure may be absolute or gauge Acceleration ACCL m/s2 ActualPower ACTPOW V.A Angle ANGL degree grade arcmin arcsec AngularAcceleration ANGCCE rad/s2 AngularFrequency ANGF deg/s rpm rps rph angFreqHertz AngularMomentum ANGM N.m.s Area SQDI mm2 acre hectare AreaPerLength AREALE m2/m AreaPerLength Bore BORE mm in Range of bore units limited to mm and inch (and Finch) CableSize CABL kcmil cirmil circmms CalorificValueMole CALVQ J/Mol CalorificValueVolume CALVV J/m3 Capacitance CAPA farad Charge CHAR coulomb Conductance COND siemens mho Content PCUD mm-3 ConvertiblePressure PRESC cpascala cpascalg cbarg catmg cpsig ctorrg cmmHgg cinHgg cbara catma cpsia ctorra cmmHga cinHga osia inHgaAtSixtyDegF mmHgaAtSixtyDegF inWateraAtSixtyDegF inWateraAtFourDegC ftWateraAtSixtyDegF ftWateraAtFourDegC ata Currency CURY USD GBP EUR Current CURR ampere CurrentDensity CURITY A/m2 Density DENS kg/m3 DensityMANDB MAND kg/mm3 densities stored in MANU database EffectiveHeatCapacity EFFCAP J/m/K ElectricChargeDensity ELECSI C/m3 ElectricConductivity CNDT S/m ElectricField EFLD V/m ElectricFluxDensity ELEFSI C/m2 EMF EMF volt Energy ENER kWh joule BTU calorie calorieit BTUit chu chuAtFifteenDegC EnergyDensity EDEN J/kg Entropy ENTR J/K Equivalence EQUIVA equivalent EquivalenceFlow EQULOW equiv/s EquivalencePerVolume EQPRME equiv/m3 FlowRateMolePerLength SQPTD Mol/s/m FlowRateVolPerRpm FRVPR Force FORC newton pdl dyne kgf lbf FoulingFactor FFAC m2.K/W Frequency FREQ hertz freqRpm freqRps freqRph GaugePressure GAGE pascal bar atm PSI torr mmHg inHg pressure may be absolute or gauge HeatCoefficientArea HEAREA W/K HeatFluxLinear HEAEAR W/m HeatingValue HVAL J/m3 HeatOfReaction HEAION J/m3/h HeatTransferCoeff HTRA W/m2/K Illuminance ILLUMI lux Impedance IMPE ohm Inductance INDU henry Inertia INER kg/m2 InversePressure INVURE pascal-1 InverseTemperature INVRAT kelvin-1 KinematicViscosity KVIS m2/s Stoke Length DIST mm m in ft cm km mile yard micron thou angstrom LinearDensity PDIS mm-1 Luminance LUMNCE cd/m2 LuminousFlux LUMLUX lumen LuminousIntensity LUMI Candela MagFieldIntensity MFIN A/m MagFluxDensity MFXD tesla MagneticFlux MGFX weber Mass MASS kg gram tonne lb oz longTon shortTon cwt longCwt shortCwt ozt grain stone MassFlow MFLO kg/s MassFlux MASLUX kg/s/m2 MassPerArea MAPEA kg/m2 MassPerEnergy MAPGY kg/J MassReactionRate MARETE kg/s/m3 MolarConcentration MOLONC Mol/m3 MolarEntropy MOLOPY J/Mol/K MolarFlow MOLLOW Mol/s MolarMass MOLASS kg/Mol MolarPermeability MOLITY MolarReactionRate MOLATV Mol/m3/s MolarReactionRateMass MOLATM Mol/kg/s MolarVolume MOLUME m3/Mol MoleFluxDensity MOLATA Mol/m2/s MolePerMass MOLALY Mol/kg Momentum MOME N.s Noise NOIS DecibelA Permeability PMBT H/m Permittivity PMTT F/m pH PH pH Power POWE kW hp watt PowerPerArea POPEA W/m2 PowerPerVolume POWUME W/m3 Pressure PRES pascal bar atm psi torr mmHg inHg osi inHgAtSixtyDegF mmHgAtSixtyDegF inWaterAtSixtyDegF inWaterAtFourDegC ftWaterAtSixtyDegF ftWaterAtFourDegC mmWaterAtSixtyDegF mmWaterAtFourDegC at PressurePerDistance PRPEST Pa/m PressurePerTemperature PRPEMP Pa/K PressureRate PREATE Pa/s Radiance RADNCE RadiantIntensity RADITY W/sr RadiationDose RDOS sievert rem gray raddose Radioactivity RADY Bq curie RadioactivityConc RADONC Bq/m3 Ratio RATIO Ratio pc ppm ppb ReactivePower REAC VAreac Resistivity REST ohm/m RotationalStiffness STFR N.m/rad SecondMomentOfArea SMOFA metre4 SolidAngle SANGL steradian SolventPermeability SOPETY kg/m2/s/Pa SpecFuelelConsumptionVol SPFUNS m3/J SpecHeatCapacity SHCP J/kg/K SpecificRadioactivity SPVITY Bq/g SpecificSurfaceMass SPEASS m2/kg Speed SPEE m/s knot Stiffness STIF N/m SubstanceQuantity SUBQ Mole lbMole stdcubicfoot stdcubicmeters SurfaceDensity PSQD mm-2 Temperature TEMP degC degF kelvin degRan TemperatureGradient TPDI degC/mm TemperatureRate TEMATE K/s TemperatureVolumePerMole VOLPTQ ThermalConductivity TCON W/m/K ThermalExpansionCoeff THENCO degC-1 ThermalResistance TRES K/W Time TIME second min hr day month week year Torque TORQ N.m UnitMass UMAS kg/mm ViscosityDynamic VISC Pa.s poise VolHeatTransferCoeff VOLEFF W/m3/K Volume CUDI mm3 litre ImpGal USGal bbl Mbbl MMbbl grt ImpQrt USQrt USDryQrt ImpPint USPint USDryPint ImpFloz USFloz USDryGal VolumetricFlow VFLO m3/s MSCubicFeetDay None NONE numerical real attribute WORD WORD used in assigning parameter dimensions etc. Parameter UNIPAR used for parameter attributes
Real Attributes of Physical Quantities
Real attributes can be purely numeric, but often they may be representing physical quantities. The type of a physical quantity is its (physical) dimension. Attributes of physical quantities are consistently stored in the database in defined database units, irrespective of the current working units, or of the units of any value entered by you. The whole system operates on the expectation that all stored values of physically dimensioned quantities are in their relevant standard database units. The following table lists the dimensions understood by the system giving: For example attributes of length have a hash code of DIST are stored in mm and other standard units include inch, cm, ft, metre: AbsPressure ABSP pascal bar atm PSI torr mmHg inHg pressure may be absolute or gauge Acceleration ACCL m/s2 ActualPower ACTPOW V.A Angle ANGL degree grade arcmin arcsec AngularAcceleration ANGCCE rad/s2 AngularFrequency ANGF deg/s rpm rps rph angFreqHertz AngularMomentum ANGM N.m.s Area SQDI mm2 acre hectare AreaPerLength AREALE m2/m AreaPerLength Bore BORE mm in Range of bore units limited to mm and inch (and Finch) CableSize CABL kcmil cirmil circmms CalorificValueMole CALVQ J/Mol CalorificValueVolume CALVV J/m3 Capacitance CAPA farad Charge CHAR coulomb Conductance COND siemens mho Content PCUD mm-3 ConvertiblePressure PRESC cpascala cpascalg cbarg catmg cpsig ctorrg cmmHgg cinHgg cbara catma cpsia ctorra cmmHga cinHga osia inHgaAtSixtyDegF mmHgaAtSixtyDegF inWateraAtSixtyDegF inWateraAtFourDegC ftWateraAtSixtyDegF ftWateraAtFourDegC ata Currency CURY USD GBP EUR Current CURR ampere CurrentDensity CURITY A/m2 Density DENS kg/m3 DensityMANDB MAND kg/mm3 densities stored in MANU database EffectiveHeatCapacity EFFCAP J/m/K ElectricChargeDensity ELECSI C/m3 ElectricConductivity CNDT S/m ElectricField EFLD V/m ElectricFluxDensity ELEFSI C/m2 EMF EMF volt Energy ENER kWh joule BTU calorie calorieit BTUit chu chuAtFifteenDegC EnergyDensity EDEN J/kg Entropy ENTR J/K Equivalence EQUIVA equivalent EquivalenceFlow EQULOW equiv/s EquivalencePerVolume EQPRME equiv/m3 FlowRateMolePerLength SQPTD Mol/s/m FlowRateVolPerRpm FRVPR Force FORC newton pdl dyne kgf lbf FoulingFactor FFAC m2.K/W Frequency FREQ hertz freqRpm freqRps freqRph GaugePressure GAGE pascal bar atm PSI torr mmHg inHg pressure may be absolute or gauge HeatCoefficientArea HEAREA W/K HeatFluxLinear HEAEAR W/m HeatingValue HVAL J/m3 HeatOfReaction HEAION J/m3/h HeatTransferCoeff HTRA W/m2/K Illuminance ILLUMI lux Impedance IMPE ohm Inductance INDU henry Inertia INER kg/m2 InversePressure INVURE pascal-1 InverseTemperature INVRAT kelvin-1 KinematicViscosity KVIS m2/s Stoke Length DIST mm m in ft cm km mile yard micron thou angstrom LinearDensity PDIS mm-1 Luminance LUMNCE cd/m2 LuminousFlux LUMLUX lumen LuminousIntensity LUMI Candela MagFieldIntensity MFIN A/m MagFluxDensity MFXD tesla MagneticFlux MGFX weber Mass MASS kg gram tonne lb oz longTon shortTon cwt longCwt shortCwt ozt grain stone MassFlow MFLO kg/s MassFlux MASLUX kg/s/m2 MassPerArea MAPEA kg/m2 MassPerEnergy MAPGY kg/J MassReactionRate MARETE kg/s/m3 MolarConcentration MOLONC Mol/m3 MolarEntropy MOLOPY J/Mol/K MolarFlow MOLLOW Mol/s MolarMass MOLASS kg/Mol MolarPermeability MOLITY MolarReactionRate MOLATV Mol/m3/s MolarReactionRateMass MOLATM Mol/kg/s MolarVolume MOLUME m3/Mol MoleFluxDensity MOLATA Mol/m2/s MolePerMass MOLALY Mol/kg Momentum MOME N.s Noise NOIS DecibelA Permeability PMBT H/m Permittivity PMTT F/m pH PH pH Power POWE kW hp watt PowerPerArea POPEA W/m2 PowerPerVolume POWUME W/m3 Pressure PRES pascal bar atm psi torr mmHg inHg osi inHgAtSixtyDegF mmHgAtSixtyDegF inWaterAtSixtyDegF inWaterAtFourDegC ftWaterAtSixtyDegF ftWaterAtFourDegC mmWaterAtSixtyDegF mmWaterAtFourDegC at PressurePerDistance PRPEST Pa/m PressurePerTemperature PRPEMP Pa/K PressureRate PREATE Pa/s Radiance RADNCE RadiantIntensity RADITY W/sr RadiationDose RDOS sievert rem gray raddose Radioactivity RADY Bq curie RadioactivityConc RADONC Bq/m3 Ratio RATIO Ratio pc ppm ppb ReactivePower REAC VAreac Resistivity REST ohm/m RotationalStiffness STFR N.m/rad SecondMomentOfArea SMOFA metre4 SolidAngle SANGL steradian SolventPermeability SOPETY kg/m2/s/Pa SpecFuelelConsumptionVol SPFUNS m3/J SpecHeatCapacity SHCP J/kg/K SpecificRadioactivity SPVITY Bq/g SpecificSurfaceMass SPEASS m2/kg Speed SPEE m/s knot Stiffness STIF N/m SubstanceQuantity SUBQ Mole lbMole stdcubicfoot stdcubicmeters SurfaceDensity PSQD mm-2 Temperature TEMP degC degF kelvin degRan TemperatureGradient TPDI degC/mm TemperatureRate TEMATE K/s TemperatureVolumePerMole VOLPTQ ThermalConductivity TCON W/m/K ThermalExpansionCoeff THENCO degC-1 ThermalResistance TRES K/W Time TIME second min hr day month week year Torque TORQ N.m UnitMass UMAS kg/mm ViscosityDynamic VISC Pa.s poise VolHeatTransferCoeff VOLEFF W/m3/K Volume CUDI mm3 litre ImpGal USGal bbl Mbbl MMbbl grt ImpQrt USQrt USDryQrt ImpPint USPint USDryPint ImpFloz USFloz USDryGal VolumetricFlow VFLO m3/s MSCubicFeetDay None NONE numerical real attribute WORD WORD used in assigning parameter dimensions etc. Parameter UNIPAR used for parameter attributes Name of Dimension HashCode/Word Database Units Other Specific Units Comments AbsPressure ABSP pascal bar atm PSI torr mmHg inHg pressure may be absolute or gauge Acceleration ACCL m/s2 ActualPower ACTPOW V.A Angle ANGL degree grade arcmin arcsec AngularAcceleration ANGCCE rad/s2 AngularFrequency ANGF deg/s rpm rps rph angFreqHertz AngularMomentum ANGM N.m.s Area SQDI mm2 acre hectare AreaPerLength AREALE m2/m AreaPerLength Bore BORE mm in Range of bore units limited to mm and inch (and Finch) CableSize CABL kcmil cirmil circmms CalorificValueMole CALVQ J/Mol CalorificValueVolume CALVV J/m3 Capacitance CAPA farad Charge CHAR coulomb Conductance COND siemens mho Content PCUD mm-3 ConvertiblePressure PRESC cpascala cpascalg cbarg catmg cpsig ctorrg cmmHgg cinHgg cbara catma cpsia ctorra cmmHga cinHga osia inHgaAtSixtyDegF mmHgaAtSixtyDegF inWateraAtSixtyDegF inWateraAtFourDegC ftWateraAtSixtyDegF ftWateraAtFourDegC ata Currency CURY USD GBP EUR Current CURR ampere CurrentDensity CURITY A/m2 Density DENS kg/m3 DensityMANDB MAND kg/mm3 densities stored in MANU database EffectiveHeatCapacity EFFCAP J/m/K ElectricChargeDensity ELECSI C/m3 ElectricConductivity CNDT S/m ElectricField EFLD V/m ElectricFluxDensity ELEFSI C/m2 EMF EMF volt Energy ENER kWh joule BTU calorie calorieit BTUit chu chuAtFifteenDegC EnergyDensity EDEN J/kg Entropy ENTR J/K Equivalence EQUIVA equivalent EquivalenceFlow EQULOW equiv/s EquivalencePerVolume EQPRME equiv/m3 FlowRateMolePerLength SQPTD Mol/s/m FlowRateVolPerRpm FRVPR Force FORC newton pdl dyne kgf lbf FoulingFactor FFAC m2.K/W Frequency FREQ hertz freqRpm freqRps freqRph GaugePressure GAGE pascal bar atm PSI torr mmHg inHg pressure may be absolute or gauge HeatCoefficientArea HEAREA W/K HeatFluxLinear HEAEAR W/m HeatingValue HVAL J/m3 HeatOfReaction HEAION J/m3/h HeatTransferCoeff HTRA W/m2/K Illuminance ILLUMI lux Impedance IMPE ohm Inductance INDU henry Inertia INER kg/m2 InversePressure INVURE pascal-1 InverseTemperature INVRAT kelvin-1 KinematicViscosity KVIS m2/s Stoke Length DIST mm m in ft cm km mile yard micron thou angstrom LinearDensity PDIS mm-1 Luminance LUMNCE cd/m2 LuminousFlux LUMLUX lumen LuminousIntensity LUMI Candela MagFieldIntensity MFIN A/m MagFluxDensity MFXD tesla MagneticFlux MGFX weber Mass MASS kg gram tonne lb oz longTon shortTon cwt longCwt shortCwt ozt grain stone MassFlow MFLO kg/s MassFlux MASLUX kg/s/m2 MassPerArea MAPEA kg/m2 MassPerEnergy MAPGY kg/J MassReactionRate MARETE kg/s/m3 MolarConcentration MOLONC Mol/m3 MolarEntropy MOLOPY J/Mol/K MolarFlow MOLLOW Mol/s MolarMass MOLASS kg/Mol MolarPermeability MOLITY MolarReactionRate MOLATV Mol/m3/s MolarReactionRateMass MOLATM Mol/kg/s MolarVolume MOLUME m3/Mol MoleFluxDensity MOLATA Mol/m2/s MolePerMass MOLALY Mol/kg Momentum MOME N.s Noise NOIS DecibelA Permeability PMBT H/m Permittivity PMTT F/m pH PH pH Power POWE kW hp watt PowerPerArea POPEA W/m2 PowerPerVolume POWUME W/m3 Pressure PRES pascal bar atm psi torr mmHg inHg osi inHgAtSixtyDegF mmHgAtSixtyDegF inWaterAtSixtyDegF inWaterAtFourDegC ftWaterAtSixtyDegF ftWaterAtFourDegC mmWaterAtSixtyDegF mmWaterAtFourDegC at PressurePerDistance PRPEST Pa/m PressurePerTemperature PRPEMP Pa/K PressureRate PREATE Pa/s Radiance RADNCE RadiantIntensity RADITY W/sr RadiationDose RDOS sievert rem gray raddose Radioactivity RADY Bq curie RadioactivityConc RADONC Bq/m3 Ratio RATIO Ratio pc ppm ppb ReactivePower REAC VAreac Resistivity REST ohm/m RotationalStiffness STFR N.m/rad SecondMomentOfArea SMOFA metre4 SolidAngle SANGL steradian SolventPermeability SOPETY kg/m2/s/Pa SpecFuelelConsumptionVol SPFUNS m3/J SpecHeatCapacity SHCP J/kg/K SpecificRadioactivity SPVITY Bq/g SpecificSurfaceMass SPEASS m2/kg Speed SPEE m/s knot Stiffness STIF N/m SubstanceQuantity SUBQ Mole lbMole stdcubicfoot stdcubicmeters SurfaceDensity PSQD mm-2 Temperature TEMP degC degF kelvin degRan TemperatureGradient TPDI degC/mm TemperatureRate TEMATE K/s TemperatureVolumePerMole VOLPTQ ThermalConductivity TCON W/m/K ThermalExpansionCoeff THENCO degC-1 ThermalResistance TRES K/W Time TIME second min hr day month week year Torque TORQ N.m UnitMass UMAS kg/mm ViscosityDynamic VISC Pa.s poise VolHeatTransferCoeff VOLEFF W/m3/K Volume CUDI mm3 litre ImpGal USGal bbl Mbbl MMbbl grt ImpQrt USQrt USDryQrt ImpPint USPint USDryPint ImpFloz USFloz USDryGal VolumetricFlow VFLO m3/s MSCubicFeetDay None NONE numerical real attribute WORD WORD used in assigning parameter dimensions etc. Parameter UNIPAR used for parameter attributes
Values of Physical Quantities
A value of a real physical quantity has a numerical value (the number) and defines units of measure which are the units in which the quantity is measured. For example a distance can be 25.4mm or 1inch but regardless of the number it is the same distance because there is a known conversion factor between millimetres and inches. Value may be entered into the system with a unit qualifier which determines the dimension of the physical quantity and sets its value in those units. The system will automatically convert from the input unit to the database unit, and from database unit to a presentation unit (for example the 'current' unit) using internally defined conversion factors. For compound units (for example,. from 'pound per square inch' to 'pascal') the conversion factors of the component units are combined together. The internal conversion units used are sourced as accurately as possible. Some conversions are arithmetically exact for example, inches:mm, and SI conversions as listed by Bureau International des Poids et Mesures: Some conversions are experimentally determined (for example, conversion from Kg force to Newton) and precise published values are used. All the values are consistent with those published, for example, by US National Institute of Standards and Technology and listed at When more accurate values greater than 7 significant figures are obtainable from other sources such as and elsewhere these have been used in preference. There is one exception to this rule. The British Thermal Unit (BTU) which is defined by AVEVA E3D Design to be a 'typical' value of 1055.16kJ and not that defined by Fifth International Conference value of 1055.05585262kJ. http://physics.nist.gov/Pubs/SP811/appenB8.html http://en.wikipedia.org/wiki/Template:Convert http://physics.nist.gov/Pubs/SP811/appenB8.html http://en.wikipedia.org/wiki/Template:Convert
Standard Units
There are a set of standard specific units that the system will understand. Ideally the unit qualifier should be appended to the value (for example, 6.5inch) but often it can be recognized if separated from its value (for example, 6.5 inch); but not always. For each unit there is an abbreviated form, a long form, and a full form (which are often identical) (for example, mm and millimeter). All can be understood including curtailed versions of the long form (for example, metre and met) always providing there are no other ambiguities. However in general, the long form will be necessary if the unit is solitary (which means. not part of a compound unit) and especially if the unit qualifier is space separated from its value. The set of standard units are: arcmin arcmin arcmin ARCM Angle arcsec arcsec arcsec ARCS Angle deg degree degree DEG Angle grad grad grade GRAD Angle rad radian radian RAD Angle acre acre acre ACRE Area ha hectare hectare HECT Area F farad farad FARA Capacitance C coulomb coulomb COUL Charge mho mho mho MHO Conductance Si siemens siemens SIEM Conductance EUR EUR euro EURO Currency GBP GBP GBPound UKPD Currency USD USD USDollar USDO Currency A ampere ampere AMP Current V volt volt VOLT EMF BTU BTU BTU BTU Energy cal calorie calorie CALO Energy J joule joule JOUL Energy kWh kWh kiloWatthour KWH Energy dyn dyne dyne FORC Force kgf kgf kgForce KGF Force lbf lbf poundForce LBF Force N newton newton NEWT Force pdl pdl poundal PDL Force Hz hertz hertz HERZ Frequency rpm rpm rpm RPM Frequency ohm ohm ohm OHM Impedance H henry henry HENR Inductance Angst angstrom angstrom ANGS Length cm cm centimetre CM Length ft ft foot FOOT Length in in inch INCH Length in inch inch FINC Length km km kilometre KM Length m metre metre METR Length micron micron micron MICR Length mile mile mile MILE Length mm mm millimetre MM Length thou thou thou THOU Length yd yd yard YARD Length T tesla tesla TESL MagFluxDensity Wb weber weber WEBE MagneticFlux cwt cwt hundredweight CWT Mass g gram gram GRAM Mass kg kg kilogram KG Mass lb lb pound POUN Mass oz oz ounce OZ Mass shortTon shortTon shortTon STON Mass ton longTon longTon TON Mass tonne tonne tonne TONN Mass hp hp horsePower HP Power kW kW kiloWatt KWAT Power W watt watt WATT Power atm atm atmosphere ATM Pressure bar bar bar BAR Pressure inHg inHg inHg INHG Pressure mmHg mmHg mmHg MMHG Pressure Pa pascal pascal PASC Pressure PSI PSI PSI PSI Pressure torr torr torr TORR Pressure Gy gray gray GRAY RadiationDose radD raddose radDose RADD RadiationDose rem rem rem REM RadiationDose Sv sievert sievert SIEV RadiationDose Bq bequerel bequerel BEQU Radioactivity Ci curie curie CURI Radioactivity knot knot knot KNOT Speed degC degC degCelsius CELS Temperature degF degF degFahrenheit FAHR Temperature degRan degRan degRankine RANK Temperature K kelvin kelvin KELV Temperature day day day DAY Time hr hour hour HOUR Time min minute minute MINU Time mth month month MONT Time s second second SECO Time wk week week WEEK Time yr year year YEAR Time P poise poise POIS ViscosityDynamic ImpGal ImpGal ImpGallon GALI Volume l litre litre LITR Volume USGal USGal USGallon GALU Volume Where there are US and SI spelling alternatives BOTH versions are supported for example litre and liter, millimetre and millimeter etc. There is a significant extension of input in feet and inches (so-called FINCH format). A double quote (") may be used as a unit qualifier for inch in any context (decimal inch input, or finch input). In FINCH format a single quote (') is accepted as an abbreviation for feet and must be used for non format controlled input) and a double quote for inches. The feet and inch value is entered using both feet and inch unit qualifiers, and the fractional part of inches can either be entered as a decimal, 5'2.125" or as a fraction 5'2.1/8". The inch qualifier can be any inch qualifier or none (as it is syntactically redundant). If the input is controlled by a format object the foot qualifier can be any foot qualifier (ft, foot, blip) and the inch qualifier can be placed after the integer inch value OR at the end of the inch value, or omitted. Abbreviation Long Name Fullname Hash Code Physical Dimension arcmin arcmin arcmin ARCM Angle arcsec arcsec arcsec ARCS Angle deg degree degree DEG Angle grad grad grade GRAD Angle rad radian radian RAD Angle acre acre acre ACRE Area ha hectare hectare HECT Area F farad farad FARA Capacitance C coulomb coulomb COUL Charge mho mho mho MHO Conductance Si siemens siemens SIEM Conductance EUR EUR euro EURO Currency GBP GBP GBPound UKPD Currency USD USD USDollar USDO Currency A ampere ampere AMP Current V volt volt VOLT EMF BTU BTU BTU BTU Energy cal calorie calorie CALO Energy J joule joule JOUL Energy kWh kWh kiloWatthour KWH Energy dyn dyne dyne FORC Force kgf kgf kgForce KGF Force lbf lbf poundForce LBF Force N newton newton NEWT Force pdl pdl poundal PDL Force Hz hertz hertz HERZ Frequency rpm rpm rpm RPM Frequency ohm ohm ohm OHM Impedance H henry henry HENR Inductance Angst angstrom angstrom ANGS Length cm cm centimetre CM Length ft ft foot FOOT Length in in inch INCH Length in inch inch FINC Length km km kilometre KM Length m metre metre METR Length micron micron micron MICR Length mile mile mile MILE Length mm mm millimetre MM Length thou thou thou THOU Length yd yd yard YARD Length T tesla tesla TESL MagFluxDensity Wb weber weber WEBE MagneticFlux cwt cwt hundredweight CWT Mass g gram gram GRAM Mass kg kg kilogram KG Mass lb lb pound POUN Mass oz oz ounce OZ Mass shortTon shortTon shortTon STON Mass ton longTon longTon TON Mass tonne tonne tonne TONN Mass hp hp horsePower HP Power kW kW kiloWatt KWAT Power W watt watt WATT Power atm atm atmosphere ATM Pressure bar bar bar BAR Pressure inHg inHg inHg INHG Pressure mmHg mmHg mmHg MMHG Pressure Pa pascal pascal PASC Pressure PSI PSI PSI PSI Pressure torr torr torr TORR Pressure Gy gray gray GRAY RadiationDose radD raddose radDose RADD RadiationDose rem rem rem REM RadiationDose Sv sievert sievert SIEV RadiationDose Bq bequerel bequerel BEQU Radioactivity Ci curie curie CURI Radioactivity knot knot knot KNOT Speed degC degC degCelsius CELS Temperature degF degF degFahrenheit FAHR Temperature degRan degRan degRankine RANK Temperature K kelvin kelvin KELV Temperature day day day DAY Time hr hour hour HOUR Time min minute minute MINU Time mth month month MONT Time s second second SECO Time wk week week WEEK Time yr year year YEAR Time P poise poise POIS ViscosityDynamic ImpGal ImpGal ImpGallon GALI Volume l litre litre LITR Volume USGal USGal USGallon GALU Volume Note: " and ' qualifiers are NOT accepted for minutes and seconds or arc units. Note :
SI Unit Prefixes
Any unit may have an SI unit prefix preceding it which can be applied either directly (as in hectogramme) or with an intervening underscore (hecto_gramme). Unlike the units themselves the SI prefix cannot be abbreviated as it would introduce too much syntax ambiguity. Many standard units actually incorporate the SI prefix in them (mm, cm, kg) these are still standard units so it is actually (although misleadingly) possible to duplicate this as in millikg (which is, equivalent to a gram). The system does not forbid use of SI prefixes with imperial units, although, this is not to be encouraged. The set of prefixes supported are: Exa 1E+18 Peta 1E+15 Tera 1E+12 Giga 1E+09 Mega 1000000 kilo 1000 hecto 100 deca 10 deci 0.1 centi 0.01 milli 0.001 micro 0.000001 nano 1E-09 pico 1E-12 femto 1E-15 Prefix Multiplier Exa 1E+18 Peta 1E+15 Tera 1E+12 Giga 1E+09 Mega 1000000 kilo 1000 hecto 100 deca 10 deci 0.1 centi 0.01 milli 0.001 micro 0.000001 nano 1E-09 pico 1E-12 femto 1E-15
Compound Units
Units may have powers applied by immediately appending an integer power. This is often the only way of inputting the units of some values. Limited alternative verbose forms are supported using additional words square and cubic (which can be abbreviated down to SQU and CUB). For example: However the verbose syntax will not work with all abbreviations of standard units. For compound units requiring more than one unit these should be appended either using a dot (.) or a slash (/) which inverts the following power. Density, Speed and Moments can be input using forms such as: Again limited verbose forms are also supported using either concentrated units or the additional word 'per' as in However whenever values are reported back the verbose forms are generally NOT used. In general there is no serious limit to the complexity of compound units that may be entered. However when compound units are stored by the system, in particular when setting current working units or setting Programmable Macro Language (PML) variables, there are limitations to the complexity of compound units that can be maintained. No more than 4 component units can be used. Each component unit can have: When there is only one component it can be one of: If there are two components these are defined with: If there are three components these are defined with: If there are four components these are defined with: When the choice of units, powers or prefixes are restricted, the order of components may be adjusted to match a compound unit in range. The named unit itself An optional power of the unit (multiple and/or reciprocal) An optional SI Prefix The named unit itself The named unit itself An optional power of the unit (multiple and/or reciprocal) An optional power of the unit (multiple and/or reciprocal) An optional SI Prefix An optional SI Prefix Any standard unit -8>power>+8 SI Prefixes femto to Exa Any standard unit Any standard unit -8>power>+8 -8>power>+8 SI Prefixes femto to Exa SI Prefixes femto to Exa Any standard unit -8>power>+8 SI Prefixes femto to Exa for first component, and milli to Mega for second Any standard unit Any standard unit -8>power>+8 -8>power>+8 SI Prefixes femto to Exa for first component, and milli to Mega for second SI Prefixes femto to Exa for first component, and milli to Mega for second Any standard unit for first components, limited to 64 common units for last -8>power>+8 NO SI Prefixes Any standard unit for first components, limited to 64 common units for last Any standard unit for first components, limited to 64 common units for last -8>power>+8 -8>power>+8 NO SI Prefixes NO SI Prefixes Limited to a set of 32 common units -2>power>+2 except the last unit which has power range of +/-4 NO SI Prefixes Limited to a set of 32 common units Limited to a set of 32 common units -2>power>+2 except the last unit which has power range of +/-4 -2>power>+2 except the last unit which has power range of +/-4 NO SI Prefixes NO SI Prefixes Note: The limitation below is not applicable to AVEVA Administration 1.8, AVEVA Engineering 15.3 and higher. Note :
Units of Absolute and Gauge (gage) Pressures
A trailing qualifier of .abs or .gauge or .gage when added to any pressure unit will be accepted on input and in string conversion. A trailing "a" or "g" will be accepted on standard units (and their abbreviations) on input, and on string conversion. When gauge and absolute pressures are used in expressions they will always revert back to generic pressures. In particular there is no conversion factor applied between gauge and absolute pressures and so absolute is considered the same as generic pressures. The two additional pressure dimensions are supported for absolute and gauge pressures (ABS_PRESSURE and GAUGE_PRESSURE) The trailing qualifier will create a quantity with dimension of either absolute or gauge pressure. This trailing component can be added to both standard units such as pascal, bar, psi, atmosphere (bar.abs) and compound units (N/m2.abs, lbf/in2.gauge). The trailing qualifier will create a quantity with dimension of either absolute or gauge pressure. The trailing qualifier will create a quantity with dimension of either absolute or gauge pressure. This trailing component can be added to both standard units such as pascal, bar, psi, atmosphere (bar.abs) and compound units (N/m2.abs, lbf/in2.gauge). This trailing component can be added to both standard units such as pascal, bar, psi, atmosphere (bar.abs) and compound units (N/m2.abs, lbf/in2.gauge). The .gauge or .abs will be appended to compound units when quantities are formatted as gauge or absolute pressures. The .gauge or .abs will be appended to compound units when quantities are formatted as gauge or absolute pressures. The .gauge or .abs will be appended to compound units when quantities are formatted as gauge or absolute pressures. The trailing g or a will create an object with dimension of either gauge or absolute pressure, for example pascala, barg, psig, Paa, Pag It will be appended to standard units when quantities are formatted as gauge of absolute pressures The trailing g or a will create an object with dimension of either gauge or absolute pressure, for example pascala, barg, psig, Paa, Pag The trailing g or a will create an object with dimension of either gauge or absolute pressure, for example pascala, barg, psig, Paa, Pag It will be appended to standard units when quantities are formatted as gauge of absolute pressures It will be appended to standard units when quantities are formatted as gauge of absolute pressures These can be set in format objects (both Programmable Macro Language (PML) and .Net) and used to format generic pressure quantities. They can be set for User Defined Attributes (UDAs) or Properties to define values of these will always be output as gauge or absolute quantities They will be able to have their own current units, distinct from generic pressure units. (similarly to DIST and BORE) These can be set in format objects (both Programmable Macro Language (PML) and .Net) and used to format generic pressure quantities. These can be set in format objects (both Programmable Macro Language (PML) and .Net) and used to format generic pressure quantities. They can be set for User Defined Attributes (UDAs) or Properties to define values of these will always be output as gauge or absolute quantities They can be set for User Defined Attributes (UDAs) or Properties to define values of these will always be output as gauge or absolute quantities They will be able to have their own current units, distinct from generic pressure units. (similarly to DIST and BORE) They will be able to have their own current units, distinct from generic pressure units. (similarly to DIST and BORE) Note: You cannot apply a single "a" or "g" as this means ampere or gram! Note :
Database Units
For efficiency and consistency all attributes, whether real or pseudo, are handled by the same code within product whenever possible. Dimensioned attribute whose values are stored in the Engineering Database are always returned in Database Units, and this fact is utilized within the attribute handling code. It is therefore essential that dimensioned pseudo attributes are returned in Database units. This can be achieved simply by having: as the last two lines of any Programmable Macro Language (PML) function which is calculating the dimensioned pseudo attribute value. !result = !value.dbunits() return !result !result = !value.dbunits() return !result
Query Attributes
Information is provided on querying attributes and arrays, on dot notation in Programmable Macro Language (PML), on qualifiers, on relative positions, directions and orientations and on pseudo attributes.
Query the List of Attributes
The attributes available for an element will depend on its type, for example, a site will have different attributes to a branch. The lists of valid attributes can be obtained as follows: Note
Standard Attribute Query
An attribute value may be obtained as follows: Specify the attribute name after QUERY or on the RHS of a Programmable Macro Language (PML) assignment. This will return the attribute value, if valid, for the Current Element (CE). Via a DBREF object using the attribute name as a method, or using the ‘Attribute’ method. The querying is the same for UDAs or pseudo attributes. The type of the PML variable will depend on the type of the attribute and whether it is an array or not. Attributes of INTEGER type will be assigned to a PML variable of type REAL. Attributes of type WORD are assigned to PML variable of type TEXT. If the attribute is a DISTANCE attribute and current DISTANCE units are inch or finch, then the value will be converted to inches. If the attribute is a BORE attribute and current BORE units are inch or finch, then the value will be converted to inches. If the attribute is a REAL attribute and it is defined to be one a physical quantity (distance, angle, mass, whose metal data UNIT is set to a dimensions such as DIST, ANGL, or MASS etc.) then the attribute is returned in the current units of that quantity. If it is an attribute of volume capacity (CUDI) and the current units are derived from current distance units of INCH or FINCH the value will be reported in cubic inches. PML1 syntax allows an attribute to be passed to a PML variable without the ‘=’ operator. If this is done then the value will always be formatted to a TEXT using the current units if applicable. The VAR command has many forms but in all cases it creates PML STRING variables, not Numbers. If the contents are values and numbers then where these are physical quantities they will be appended with the units of the values as stored in the system. Will store the text equivalent of the value of the XLEN attribute in current distance units. Will return the text string form of !!CE.XLEN. It does this by using the STRING (actually queryString) method of the (temporary) real variable created by !!CE.XLEN. The real variable will be created in current units and the STRING method will append the unit qualifier to the value output Attributes my be queried on other elements by using the ‘OF’ syntax. The syntax following the OF may be any ID expression.
Query Arrays
If the attribute is an array, the query will return a list of values. Individual elements can be queried by passing in the index number. Alternatively, the NUM keyword can be used for PML 1 syntax. A range of values can be returned using the TO keyword. An error will occur if attempting to query off the end of the array. Within a PML1 expression, a position attribute may be queried as an array in order to access the individual coordinates.
dot Notation in PML
For reference attributes, the Programmable Macro Language (PML) dot notation can be used to achieve a similar result. This will return the description of the element pointed to by the CREF attribute on the Current Element (CE).
Qualifier
Many pseudo attributes take a qualifier. The qualifier is the extra information required 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 qualifier follows the attribute name in brackets. Attribute qualifiers must be preceded by the keyword ATTNAME and element types must be preceded by the keyword TYPENAME. For Programmable Macro LAnguage (PML) variables, the qualifier should be assigned to a PML array object and passed to the ‘Attribute’ method as the second argument: to query PPOS 1 to query list of nominal bores: to query Equipment members:
Relative Positions, Directions, Orientations
Positions, Orientations, directions can be queried relative to another element using the WRT syntax. The use of WRT is described more fully in the Expressions. Expressions Expressions
Summary of Related Pseudo Attributes
Pseudo attributes relating to the list of attributes. ATTLIST WORD(300) List of all visible attributes for element PSATTS WORD(500) List of pseudo attributes UDALIS WORD(300) List of UDAs UDASET WORD(300) List of UDAs set Pseudo attributes relating to the name. CUTNAM STRING(700) NUMBER Full name of element, truncated to n characters CUTNMN STRING(700) NUMBER Full name of element (without leading slash) truncated to n characters FLNM STRING(700) Full name of the element FLNN STRING(700) Full name of the element (without leading slash) ISNAMED BOOL True if element is named NAMESQ STRING(700) Type. sequence number and name of element NAMETY STRING(700) Type and name of the element NAMN STRING(500) Name of the element (without leading slash) NAMTYP STRING(700) Type and full name of element Pseudo attributes relating to the type. ACTTYPE WORD Type of the element, ignoring UDET, truncated to 4 or 6 characters. AHLIS WORD(200) List of actual types in owning hierarchy OSTYPE WORD Short cut for "Type of owner" TYPE WORD Type of the element, ignoring UDET, truncated to 4 or 6 characters Attribute Name Data Type Qualifier Description ATTLIST WORD(300) List of all visible attributes for element PSATTS WORD(500) List of pseudo attributes UDALIS WORD(300) List of UDAs UDASET WORD(300) List of UDAs set Attribute Name Data Type Qualifier Description CUTNAM STRING(700) NUMBER Full name of element, truncated to n characters CUTNMN STRING(700) NUMBER Full name of element (without leading slash) truncated to n characters FLNM STRING(700) Full name of the element FLNN STRING(700) Full name of the element (without leading slash) ISNAMED BOOL True if element is named NAMESQ STRING(700) Type. sequence number and name of element NAMETY STRING(700) Type and name of the element NAMN STRING(500) Name of the element (without leading slash) NAMTYP STRING(700) Type and full name of element Attribute Name Data Type Qualifier Description ACTTYPE WORD Type of the element, ignoring UDET, truncated to 4 or 6 characters. AHLIS WORD(200) List of actual types in owning hierarchy OSTYPE WORD Short cut for "Type of owner" TYPE WORD Type of the element, ignoring UDET, truncated to 4 or 6 characters
Set Attributes
Information is provided on the standard and special syntax, resetting user defined attributes (UDAs) to default, setting arrays, values of arrays and related pseudo attributes.
Standard Syntax
Attribute values can be set in two ways: The following general rules must be followed: The behaviour for each attribute type is described below: REAL attribute - allows an int, real or real expression INTEGER attribute - allows an int, a real or real expression. The result will be rounded to the nearest integer. TEXT attribute - allows a text value, a text expression, or UNSET. Assigning UNSET will result in a zero length string. LOGICAL attribute - allows FALSE, TRUE or logical expression. REF attribute - allows a name, refno, ID expression, or UNSET, NULREF keywords. The UNSET and NULREF keywords both result in a null reference (=0/0) being assigned. WORD attribute - If assigning to a PML variable, then allows a text value or text expression. If assigning via the attribute name, then it must be a word. POSITION attribute - allows a position or position expression. DIRECTION attribute - Allows a direction or direction expression ORIENTATION attribute - Allows an orientation or an orientation expression The value being assigned to an attribute must either be dimensionally equivalent to the attribute, or else a numerical value (which is taken to be in current working units of the dimension). If there is a clash of physical quantity an error will occur. The following will all generate errors. The value assigned must be the correct type for the attribute type (see examples below) PML variables can not be directly used if using method (2). The PML variable must be expanded using the late evaluation syntax, i.e. ‘XLEN !A’ is invalid but ‘XLEN $!A’ is OK. This also applies to any PML variables within expressions. The value assigned must be the correct type for the attribute type (see examples below) The value assigned must be the correct type for the attribute type (see examples below) PML variables can not be directly used if using method (2). The PML variable must be expanded using the late evaluation syntax, i.e. ‘XLEN !A’ is invalid but ‘XLEN $!A’ is OK. This also applies to any PML variables within expressions. PML variables can not be directly used if using method (2). The PML variable must be expanded using the late evaluation syntax, i.e. ‘XLEN !A’ is invalid but ‘XLEN $!A’ is OK. This also applies to any PML variables within expressions. Note: There must be a space between the name and the ‘)’ Note: The POS attribute can not be set by name, use AT syntax instead. Do not use brackets if setting by attribute name. Note: Do not use brackets if setting by attribute name. Note: Do not use brackets if setting by attribute name. Note : Note : Note : Note : Note :
Set a UDA Back to a Default
A UDA may be set back to it’s default by using the DEFAULT keyword.
Set an Array
If assigning via a Programmable Macro Language (PML) variable, an array attribute must be assigned from a PML array object. If assigning via the attribute name, then a list of values must be given.
Single Value of an Array
If assigning via a PML variable, an index number may be specified in square brackets. If assigning via the attribute name, a single value of an array may be set using the NUMB keyword. The NUMB keyword follows the attribute name, and is followed by the index number. This sets the 2nd value of the array to 99. The NUMB command actually specifies the start point for a list of values. This would set the 3rd value to 99, the 4th to 100 and the 5th to 101. The new values may go off the end of the existing array, but the start point must not be more than one beyond the existing end point.
Special Syntax for Names
All elements except the WORLD can be named. Although Design elements are often given suitable names while being created, later name changes can be made by giving a new name or by removing the old name. The name of any element must be unique; that is, not already used for another currently accessible element. NAME /ZONE5D The current element is given the specified name provided it has not been used elsewhere. UNN The current element loses its name (it is still identifiable by its automatically allocated reference number). The name of the current element and offspring can be modified where a standard name part occurs. REN ALL /Z1 /Z2 All occurrences of /Z1 in the names of the current element and its offspring will be changed to /Z2. Examples NAME /ZONE5D The current element is given the specified name provided it has not been used elsewhere. UNN The current element loses its name (it is still identifiable by its automatically allocated reference number). Example REN ALL /Z1 /Z2 All occurrences of /Z1 in the names of the current element and its offspring will be changed to /Z2. >-- NAMe --+-- ALL name name --. | | ‘-- name -----------+--> >-- UNName --> >-- REName --+-- ALL name name --. | | ‘-- name -----------+--> NAME /ZONE5D UNN REN ALL /Z1 /Z2 name name name
Special Syntax for LOCK
Locking a design element prevents it from being modified or deleted. The LOCK command allows either a single element to be controlled, or all its offspring too. (A complete Site can be locked if required.) This provides you with personal security control over your area of work. (General security restrictions affecting the whole Project are established in the Admin module of AVEVA E3D Design.) LOCK ALL The current element and all its offspring are locked. UNLOCK The current element is unlocked. Examples LOCK ALL The current element and all its offspring are locked. UNLOCK The current element is unlocked. >--+-- LOCK ----. | | ‘-- UNLOck --+-- ALL --. | | ‘---------+-- <snoun> --. | | ‘-------------+--> LOCK ALL UNLOCK
Related Pseudo Attributes
DACMOD BOOL ATTR True if DAC allows attribute of element to be modified MODATT BOOL ATTR True if attribute of element can be modified MODERR STRING(120) ATTR Returns the error text that would occur if attribute was modified Attribute Name Data Type Qualifier Description DACMOD BOOL ATTR True if DAC allows attribute of element to be modified MODATT BOOL ATTR True if attribute of element can be modified MODERR STRING(120) ATTR Returns the error text that would occur if attribute was modified
PML Attribute Class
Information is provided on the creation of attribute classes and the creation methods.
Creation
A Programmable Macro Language (PML) attribute instance may be created for a system attribute or a User defined Attribute (UDA). The class should not be confused with the attribute value. The actual Attribute value for a particular Element can only be accessed via the DBREF class or via the QUERY command. Comparing two Attributes just compares whether they identify the same attribute, the comparison does not look at attribute values in any way.
Methods
The Attribute instance can then be used for querying the ‘meta data’, that means, data about data. The methods of the class allow the following to be queried. String Type() Attribute type String Name() Attribute name String Description() Attribute description Int Hash() Attribute hash value int Length() Attribute length bool IsPseudo() Whether pseudo or not bool IsUda() Whether a User defined Attributes (UDA) or not string querytext() As output at the command line when querying attribute string units Either BORE, DISTANCE or NONE Returns the unit field of the attribute which is the string of the hash code of the dimension of the attribute (BORE, DIST, MASS, ANGL, or for numbers of no physical quantity NONE). For UDAs it is the value of the UDA Type (UTYP) attribute. bool Noclaim() Whether attribute can be changed without doing a claim ElementType array ElementTypes List of Elements for which the attribute is valid. This only works for UDAs Real array limits Min/Max values for real/int types String array ValidValues(ElementType) List of valid for text attributes. The list may vary with element type string DefaultValue (ElementType) Attribute default. This only works for UDAs string Category() Determines the grouping of attributes on the ‘Attribute Utility’ form bool hyperlink() if true then the attribute value refers to an external file bool connection() if true then the attribute value will appear on the reference list form bool hidden() If true then attribute will not appear on the Attribute utility form or after ‘Q ATT’ bool protected() if true then attribute is not visible if a protected Databases (DB). String Type() Attribute type String Name() Attribute name String Description() Attribute description Int Hash() Attribute hash value int Length() Attribute length bool IsPseudo() Whether pseudo or not bool IsUda() Whether a User defined Attributes (UDA) or not string querytext() As output at the command line when querying attribute string units Either BORE, DISTANCE or NONE Returns the unit field of the attribute which is the string of the hash code of the dimension of the attribute (BORE, DIST, MASS, ANGL, or for numbers of no physical quantity NONE). For UDAs it is the value of the UDA Type (UTYP) attribute. bool Noclaim() Whether attribute can be changed without doing a claim ElementType array ElementTypes List of Elements for which the attribute is valid. This only works for UDAs Real array limits Min/Max values for real/int types String array ValidValues(ElementType) List of valid for text attributes. The list may vary with element type string DefaultValue (ElementType) Attribute default. This only works for UDAs string Category() Determines the grouping of attributes on the ‘Attribute Utility’ form bool hyperlink() if true then the attribute value refers to an external file bool connection() if true then the attribute value will appear on the reference list form bool hidden() If true then attribute will not appear on the Attribute utility form or after ‘Q ATT’ bool protected() if true then attribute is not visible if a protected Databases (DB). String Type() Attribute type String Name() Attribute name String Description() Attribute description Int Hash() Attribute hash value int Length() Attribute length bool IsPseudo() Whether pseudo or not bool IsUda() Whether a User defined Attributes (UDA) or not string querytext() As output at the command line when querying attribute string units Either BORE, DISTANCE or NONE Returns the unit field of the attribute which is the string of the hash code of the dimension of the attribute (BORE, DIST, MASS, ANGL, or for numbers of no physical quantity NONE). For UDAs it is the value of the UDA Type (UTYP) attribute. bool Noclaim() Whether attribute can be changed without doing a claim ElementType array ElementTypes List of Elements for which the attribute is valid. This only works for UDAs Real array limits Min/Max values for real/int types String array ValidValues(ElementType) List of valid for text attributes. The list may vary with element type string DefaultValue (ElementType) Attribute default. This only works for UDAs string Category() Determines the grouping of attributes on the ‘Attribute Utility’ form bool hyperlink() if true then the attribute value refers to an external file bool connection() if true then the attribute value will appear on the reference list form bool hidden() If true then attribute will not appear on the Attribute utility form or after ‘Q ATT’ bool protected() if true then attribute is not visible if a protected Databases (DB). Note: We do yet not support direct usage of this class in other syntax. String Type() String Name() String Description() Int Hash() int Length() bool IsPseudo() bool IsUda() string querytext() string units bool Noclaim() ElementType array ElementTypes Real array limits String array ValidValues(ElementType) string DefaultValue (ElementType) string Category() bool hyperlink() bool connection() bool hidden() bool protected() Note :
PML ElementType Class
Information is provided on creating element type classes using PML, on the methods and on the related pseudo attributes.
Creation
An ElementType instance may be created for a system Element type or a User Defined Element Type (UDET). The ElementType instance can then be used for querying the ‘meta data’. which means,. data about data. The methods of the class allow the following to be queried.
Methods
The available methods are: string Name() Name of element type string Description() Description of element type int Hash() Hash value bool IsUdet() Whether a User Defined Element Type (UDET) or not Attribute array systemAttributes() List of system attributes (excludes User defined Attributes (UDAs)) string array DbType()s List of valid Database (DB) types string ChangeType() Indicates if an element of this type may have it’s type changed ElementType SystemType() for UDETs this is the base type ElementType array UDETs derived from this type bool Primary() Whether the element is primary or not ElementType array MemberTypes() Valid members, including UDETs ElementType array ParentTypes() Valid parents, including UDETs string Name() Name of element type string Description() Description of element type int Hash() Hash value bool IsUdet() Whether a User Defined Element Type (UDET) or not Attribute array systemAttributes() List of system attributes (excludes User defined Attributes (UDAs)) string array DbType()s List of valid Database (DB) types string ChangeType() Indicates if an element of this type may have it’s type changed ElementType SystemType() for UDETs this is the base type ElementType array UDETs derived from this type bool Primary() Whether the element is primary or not ElementType array MemberTypes() Valid members, including UDETs ElementType array ParentTypes() Valid parents, including UDETs string Name() Name of element type string Description() Description of element type int Hash() Hash value bool IsUdet() Whether a User Defined Element Type (UDET) or not Attribute array systemAttributes() List of system attributes (excludes User defined Attributes (UDAs)) string array DbType()s List of valid Database (DB) types string ChangeType() Indicates if an element of this type may have it’s type changed ElementType SystemType() for UDETs this is the base type ElementType array UDETs derived from this type bool Primary() Whether the element is primary or not ElementType array MemberTypes() Valid members, including UDETs ElementType array ParentTypes() Valid parents, including UDETs Note: We do yet not support direct usage of this class in other syntax. string Name() string Description() int Hash() bool IsUdet() Attribute array systemAttributes() string array DbType()s string ChangeType() ElementType SystemType() ElementType array bool Primary() ElementType array MemberTypes() ElementType array ParentTypes() Note :
Related Pseudo Attributes
There are a number of pseudo attributes that return values according to the element type, as follows: HLIS WORD(2000) List of all possible types in owning hierarchy LIST WORD(2000) List of all possible member types LLIS WORD(2000) List of all possible types in member hierarchy OLIS WORD(2000) List of all possible owner types REPTXT STRING Reporter text used for element type Attribute Name Data Type Qualifier Description HLIS WORD(2000) List of all possible types in owning hierarchy LIST WORD(2000) List of all possible member types LLIS WORD(2000) List of all possible types in member hierarchy OLIS WORD(2000) List of all possible owner types REPTXT STRING Reporter text used for element type
Database Modification
This chapter describes the commands to create, copy and modify database elements.
Modify the Content of a DB
As well as accessing the current content of a Database (DB), you may also (if you have Read/Write access rights) modify a DB in any of the following ways: Create a new element at an appropriate level of the DB hierarchy; refer to Create a New Element. Delete an element from the DB hierarchy; refer to Delete an Element. Reorganize the hierarchy, refer to Reorganize the DB Hierarchy: by rearranging members of an element into a different list order. by moving an element from one part of the hierarchy to another; Define the attributes and offspring of a new element by copying the corresponding attribute, settings and member lists from another element; refer to Copy Attributes from One Element to Another. Create a new element at an appropriate level of the DB hierarchy; refer to Create a New Element. Create a new element at an appropriate level of the DB hierarchy; refer to Create a New Element. Delete an element from the DB hierarchy; refer to Delete an Element. Delete an element from the DB hierarchy; refer to Delete an Element. Reorganize the hierarchy, refer to Reorganize the DB Hierarchy: by rearranging members of an element into a different list order. by moving an element from one part of the hierarchy to another; Reorganize the hierarchy, refer to Reorganize the DB Hierarchy: Define the attributes and offspring of a new element by copying the corresponding attribute, settings and member lists from another element; refer to Copy Attributes from One Element to Another. Define the attributes and offspring of a new element by copying the corresponding attribute, settings and member lists from another element; refer to Copy Attributes from One Element to Another. Create a New Element Delete an Element Reorganize the DB Hierarchy Copy Attributes from One Element to Another Create a New Element Delete an Element Reorganize the DB Hierarchy Copy Attributes from One Element to Another
Create a New Element
To create a new element within an existing Database (DB), you must first make sure that the Current Element (CE) is at a level within the hierarchy which can legally own the element to be created. For example, a Site can own a Zone, but it cannot own a Valve. To create a new Valve, you must be at Branch level. You must therefore navigate to the correct level by using one of the command options described in Database Navigation and Query Syntax. You can then create a new element, set its attributes and, if required, create further elements as its members. If you create an element without explicitly identifying its position in the Member List of the Current Element, the new element is inserted immediately after the Current List Position. To use this option, enter the command NEW element_type element_name (element_name is optional) NEW element_type element_name (element_name is optional) For example, if the Current List Position is at member 4 (/VALV1) of the Member List. The command adds a new Tee at list position 5 (between /VALV1 and /ELBO2) and names it /TEE2. The Member List of /BRAN1 thus becomes To insert the new Tee as the first or last component in the Member List, access the Branch Head or Tail, respectively, before giving the NEW TEE command. To create a new element at a specified list position, identify a list position adjacent to the required position and state which side of it the newly-created element is to go. The command syntax is one of the following: where element_name is again optional and where list_position may be specified in any of the ways described in Database Navigation and Query Syntax. Consider the following examples. Starting from the configuration shown, any of these commands creates a new Tee between /ELBO3 (list position 7) and /FLAN2 (list position 8): NEW TEE AFTER /ELBO3 Specify name or refno NEW TEE BEFORE 8 Specify list position number NEW TEE BEFORE FLAN 2 Specify member type and number (second Flange in the list) NEW TEE AFTER LAST ELBO Specify first or last member of a given type (last Elbow in the list) NEW TEE AFTER NEXT 3 Specify position relative to Current List Position NEW TEE BEFORE LAST FLAN Specify first or last member of a given type NEW TEE AFTER /ELBO3 Specify name or refno NEW TEE BEFORE 8 Specify list position number NEW TEE BEFORE FLAN 2 Specify member type and number (second Flange in the list) NEW TEE AFTER LAST ELBO Specify first or last member of a given type (last Elbow in the list) NEW TEE AFTER NEXT 3 Specify position relative to Current List Position NEW TEE BEFORE LAST FLAN Specify first or last member of a given type The new Tee, which is unnamed, becomes list member 7, /ELBO3 becomes list member 8, /FLAN2 becomes list member 9, and so on. To create a new top level element in a specific database there is a DB keyword available in the syntax of the ‘NEW’ command as follows: NEW element_type element_name DB database_name where element_name is again optional and where the database_name is expressed as a fully qualified database name,for example, team/database. The following command will create a new SITE named /MYSITE in the MYTEAM/MYDB database. NEW element_type element_name (element_name is optional) NEW TEE AFTER /ELBO3 Specify name or refno NEW TEE BEFORE 8 Specify list position number NEW TEE BEFORE FLAN 2 Specify member type and number (second Flange in the list) NEW TEE AFTER LAST ELBO Specify first or last member of a given type (last Elbow in the list) NEW TEE AFTER NEXT 3 Specify position relative to Current List Position NEW TEE BEFORE LAST FLAN Specify first or last member of a given type NEW TEE /TEE2 NEW element_type element_name BEFore list_position NEW element_type element_name AFTer list_position NEW SITE /MYSITE DB MYTEAM/MYDB Note: The Q LIST query will tell you which element types you can create as members of the Current Element. Database Navigation and Query Syntax Database Navigation and Query Syntax Database Navigation and Query Syntax Note : NEW element_type element_name Database Navigation and Query Syntax NEW TEE AFTER /ELBO3 NEW TEE BEFORE 8 NEW TEE BEFORE FLAN 2 NEW TEE AFTER LAST ELBO NEW TEE AFTER NEXT 3 NEW TEE BEFORE LAST FLAN NEW element_type element_name DB database_name element_name database_name team/database
Delete an Element
You can delete either the entire Current Element or some or all of its offspring. When you delete the Current Element, you also delete all of its offspring (that is, its members, their members, etc.) from the hierarchy. The command must therefore be used with care. When an element has been deleted, its Owner becomes the new Current Element. As a safeguard against accidental deletion of parts of a DB, the deletion function operates only on the Current Element. As further safeguards, the DELETE command word must be entered in full and the command syntax requires that you confirm the generic type of the Current Element. Furthermore, access to the required element and its subsequent deletion must be specified in two separate command lines. To delete the Current Element and all its offspring, enter For example, to delete a Nozzle, make the Nozzle the Current Element and then enter The Equipment which owned the Nozzle becomes the Current Element. To delete a complete Zone, including all Equipment, Piping, Structures etc. owned by it, make the Zone the Current Element and then enter The Site which owned the deleted Zone becomes the Current Element. To delete only specified members of the Current Element, use one of the following forms of the command syntax: DELETE element_type MEMbers (deletes all members) DELETE element_type MEMbers integer (deletes one member) DELETE element_type MEMbers integer TO integer (deletes a range of members) (deletes all members) (deletes one member) (deletes a range of members) Consider the following examples, where the Current Element is /BRAN1 with the Member List illustrated in Figure 10-2: DELETE BRAN MEMBERS Deletes all components from the Branch, leaving only the Branch Head and Tail DELETE BRAN MEMBER 6 Deletes only /TEE1 DELETE BRAN MEMBERS 5 TO 7 Deletes /ELBO2, /TEE1 and /ELBO3 Deletes all components from the Branch, leaving only the Branch Head and Tail Deletes only /TEE1 Deletes /ELBO2, /TEE1 and /ELBO3 DELETE element_type MEMbers (deletes all members) DELETE element_type MEMbers integer (deletes one member) DELETE element_type MEMbers integer TO integer (deletes a range of members) DELETE BRAN MEMBERS Deletes all components from the Branch, leaving only the Branch Head and Tail DELETE BRAN MEMBER 6 Deletes only /TEE1 DELETE BRAN MEMBERS 5 TO 7 Deletes /ELBO2, /TEE1 and /ELBO3 DELETE NOZZ DELETE ZONE DELETE DELETE element_type MEMbers DELETE element_type MEMbers integer DELETE element_type MEMbers integer TO integer DELETE BRAN MEMBERS DELETE BRAN MEMBER 6 DELETE BRAN MEMBERS 5 TO 7
Reorganize the DB Hierarchy
You can reorganize the structure of the Database (DB) hierarchy, without elements being added to or removed from its contents, in either of two ways: In both cases elements and their offspring are transferred to new positions in the hierarchy. In the first case the element's owner remains unchanged, while in the second case the element's owner changes. To rearrange the Member List of the Current Element (CE), use one of the commands: where element_id specifies an element which is to be moved (which must be a member of the Current Element) and where list_position may be specified in any of the ways described in Database Navigation and Query Syntax. If list_position is omitted, the intended position is assumed to be immediately after the Current List Position. For example, starting with the previous Member List: The command moves /ELBO3 to position 5, immediately following the Current List Position, giving the new Member List Starting from either of the above configurations, the command moves /ELBO3 to position 3, immediately before /ELBO1, thus To insert an existing element into the Member List of the Current Element, when it is not already a member of that list, use one of the commands where element_id specifies an element which is to be moved (which may be anywhere within the DB hierarchy as long as it is at an appropriate level) and where list_position may be specified in any of the ways described in Database Navigation and Query Syntax. If list_position is omitted, the intended position is assumed to be immediately after the Current List Position. For example, starting with the simple hierarchy the command moves /PIPE2 (and all its offspring) to the position immediately following the Current List Position. Ownership of /PIPE2 passes from /ZONE2 to /ZONE1, resulting in the new hierarchy REOrder element_id REOrder element_id BEFore list_position REOrder element_id AFTer list_position REORDER /ELBO3 REORDER /ELBO3 BEFORE FIRST ELBO INCLude element_id INCLude element_id BEFore list_position INCLude element_id AFTer list_position INCLUDE /PIPE2 By rearranging the order of the Member List of a single element By relocating an element to a different part of the hierarchy By rearranging the order of the Member List of a single element By rearranging the order of the Member List of a single element By relocating an element to a different part of the hierarchy By relocating an element to a different part of the hierarchy Database Navigation and Query Syntax Database Navigation and Query Syntax Database Navigation and Query Syntax Lude element_id INCLude element_id BEFore list_position INCLude element_id AFTer list_position Database Navigation and Query Syntax
Copy Attributes from One Element to Another
It is often convenient to create a new element as a copy of an existing element which has the same, or similar, attribute settings or members to those required. You do this in two stages: When an element is 'cloned' in this way, all attributes are copied from the source element to the target element except NAME (which must be unique) and LOCK (which is always unlocked in the target element). Additionally, and this is what makes the facility so powerful, all offspring of the source element are copied as offspring of the target element. You may specify automatic renaming of the Current Element and its offspring as part of the copying process. Without this the new elements will be unnamed, since AVEVA E3D Design does not permit two elements in the same Database (DB) hierarchy to have identical names. You may also choose to copy only the members (and their offspring) of the source element, leaving the attributes of the Current Element itself unchanged. To copy a complete element and all of its offspring, after creating a new Current Element of an appropriate type, enter where element_id identifies the source element to be copied. For example, to create a new item of Equipment which is an exact replica of a previously-defined Equipment, you might use the command sequence (at Zone level) This creates /EQUIPB as the Current Element and then turns it into an exact copy of /EQUIPA. All attributes and members of /EQUIPB now have the same settings as those of /EQUIPA, including its position, orientation etc., and so you will probably now want to move one of the Equipments to a different location. To copy all offspring of an element, so that they create duplicate offspring for the Current Element, enter The position, orientation, etc., of the Current Element now remain unchanged, but it acquires new members which are derived from the specified source element and which are correctly positioned relative to the Current Element. To copy selected offspring of an element, so that they create duplicate offspring for the Current Element, enter For example, the command sequence creates a new Branch named /SIDEARM whose components replicate that part of the existing Branch /MAINLINE between the specified list positions. The attributes of the Branch /SIDEARM itself are unaffected by the COPY command, so that its position, orientation, etc. (as defined by its Head and Tail settings) remain unchanged by the addition of its new members. To copy attributes from an identified element into the current element, type This causes all attributes (except for references to elements in DESI databases and OWNER) to be copied to the current element. Or: This is similar to the ATTRIBUTES option, except that as well as DESI references not being copied, neither are any position, direction, orientation or angle attributes. In both cases, the Specification Reference (SPREF) and Catalog Reference (CATREF) are also not copied between elements of different types. To copy elements alongside their original positions, type This option causes a list of elements, defined by the selection criterion select, to be copied alongside their original positions in the database. So if the list includes a SCTN and a PNOD (for example) then each of these items would be copied so that the new SCTN shares the same owner as the old SCTN and the new PNOD shares the same owner as the old PNOD. As this option copies elements, rather than just attributes, other COPY options, such as RENAME, are valid. To copy all or part of an element and rename the copies, append the command to the corresponding COPY command line. For example, the command copies all attributes and offspring of /FRACT1/PIPE into the Current Element. Where /FRACT1 occurs as the name or part of the name, it is changed to /FRACT2 in the Current Element and its offspring. Thus the Current Element itself is now named /FRACT2/PIPE, and so on. DACCOH BOOL True if DAC allows element hierarchy to be copied to another DB DACCOP BOOL True if DAC allows element to be copied to another DB DACCRE BOOL NOUN True if DAC allows element to be created DACDEL BOOL True if DAC allows element to be deleted DACERR STRING(120) ATTR Returns the DAC error MODATT BOOL ATTR True if attribute of element can be modified MODDEL BOOL ATTR True if element can be deleted Attribute Name Data Type Qualifier Description DACCOH BOOL True if DAC allows element hierarchy to be copied to another DB DACCOP BOOL True if DAC allows element to be copied to another DB DACCRE BOOL NOUN True if DAC allows element to be created DACDEL BOOL True if DAC allows element to be deleted DACERR STRING(120) ATTR Returns the DAC error MODATT BOOL ATTR True if attribute of element can be modified MODDEL BOOL ATTR True if element can be deleted COPY element_id NEW EQUI /EQUIPB COPY /EQUIPA COPY MEMbers OF element_id COPY MEMbers integer TO integer OF element_id NEW BRAN /SIDEARM COPY MEMBERS 12 TO 20 OF /MAINLINE COPY ATTributes OF element_id COPY LIKE element_id COPY ADJ/ACENT select ... REName old_name new_name COPY /FRACT1/PIPE RENAME /FRACT1 /FRACT2 Note: If the Current Element already has members, it is not possible to make it a copy of another element in this way. Create a New Element Create a New Element Note :
Save Work and Get Work
SAVEWORK saves the current Model changes without leaving Model. It is good practice to use this command on a regular basis during a long session to make sure maximum data security. As well as a comment, an optional number n can be used to specify a particular database for the command. The number is the number of the database in the order output by the STATUS command (refer to Project). If no number is given, the SAVEWORK applies to the whole Multiple Database (MDB). An example of Savework syntax is SAVEWORK ‘comment’ 1. GETWORK refreshes the view of all READ databases to pick up any changes that other users may have made since you first opened them. The optional n works in the same way as for SAVEWORK. You would normally only use GETWORK if you know of specific changes you wish to pick up and use. Please note that GETWORK slows up subsequent database access, as the information has to be re-read from disk. Therefore, you should use this command sparingly. Project n Project n
Sessions
Each time you enter Model or save your design changes, a new session is created for each database changed. You can then query when specific items of design data were modified by reference to the corresponding session number(s). Sessions can be used by the System Administrator to backtrack changes to a given date or session if necessary.
Session Comments
You can add a comment for each session, which can help identify the work done in each session. Lets you associate comment text with the current Model session. You can query this text later to help you identify a particular session in which modifications were made to elements and/or attribute settings. You can enter the session comment before you issue a SAVEWORK command, or as part of a SAVEWORK command for example SAVEWORK ‘MY COMMENTS’. SESSION COMMENT ’Addition of upper platform’ where integer is the session number. Each time you enter Model or save your design changes, a new session is created for each database changed. You can then query when specific items of design data were modified by reference to the corresponding session number(s). Sessions can be used by the System Administrator to backtrack changes to a given date or session if necessary. Example SESSION COMMENT ’Addition of upper platform’ >-- SESSION COMMENT -- text --> Q SESSComment integer Note: Sessions 1 and 2 are created in ADMIN (when the MODEL DB and its World element, respectively, are created), so the first true session will be Session 3. Example SESSION COMMENT ’Addition of upper platform’ before Note : Session 3 SESSION COMMENT ’Addition of upper platform’ text integer integer
Multiwrite Databases Claims and Extracts
If a Model or Draw Database (DB) has been created as a multiwrite database, several users can write to it simultaneously, although they cannot change the same element. Multiwrite databases can either be Standard multiwrite databases, or Extract databases. In both types, an element must be claimed before it can be modified. Claiming an element prevents other users claiming (and modifying) the element; the element must be released before another user can change it. Claiming can be either explicit, where you must use the CLAIM command before attempting to modify the element, or implicit, where the claim is made automatically when you try to modify the element. The claim mode is set when the DB is created. Refer to Administrator Command Reference Manual for further information. multiwrite Standard Extract claimed released explicit implicit Administrator Command Reference Manual Administrator Command Reference Manual .
User Claims
In a Standard multiwrite database, you must claim an element before changing it. This is known as a user claim. If the claim mode is explicit (see below for details of how to check this), you must first claim each element that you want to modify using the CLAIM command. If the claim mode is implicit, the claim will be made automatically (although you can still give explicit CLAIM commands if you want to prevent other users claiming specific elements). Only primary elements can be claimed, these are listed in the Data Model Reference Manual. You can claim a specified element only, or a specified element plus all of the significant elements below it in the hierarchy. If the claimed element is not a significant element, the significant element above it in the hierarchy will be claimed. An element must be unclaimed before another user can claim it and change it. User claims are always unclaimed when you change modules or leaves AVEVA E3D Design, and you can also unclaim elements at any time during an AVEVA E3D Design session using the UNCLAIM command. CLAIM /ZoneA /EQUIP100 /PIPE-100-A Claims named elements CLAIM /ZoneA HIERARCHY Claims named element and all of its owned hierarchy CLAIM /ELBOW-33 Claims Branch which owns named component, since ELBO is not a significant element UNCLAIM /PIPE-100 /PIPE-200 Unclaims named elements UNCLAIM ALL Unclaims all elements currently claimed Examples CLAIM /ZoneA /EQUIP100 /PIPE-100-A Claims named elements CLAIM /ZoneA HIERARCHY Claims named element and all of its owned hierarchy CLAIM /ELBOW-33 Claims Branch which owns named component, since ELBO is not a significant element UNCLAIM /PIPE-100 /PIPE-200 Unclaims named elements UNCLAIM ALL Unclaims all elements currently claimed .---------------. / | >-- CLAIM ----*-- elementname --+-- HIERARCHY ---. | | ‘----------------+--> .---------------. / | >-- UNCLAIM ---*-- elementname --+-- HIERARCHY ---. | | | ‘-- ALL ----------+----------------+--> Data Model Reference Manual user claim primary Data Model Reference Manual unclaimed CLAIM /ZoneA /EQUIP100 /PIPE-100-A CLAIM /ZoneA HIERARCHY CLAIM /ELBOW-33 UNCLAIM /PIPE-100 /PIPE-200 UNCLAIM ALL
Notes on Standard Multiwrite DBs
Elements cannot be claimed if recent changes have been made to them by other users. You must issue a GETWORK command first. Elements cannot be unclaimed if there are updates outstanding. You must issue a SAVEWORK command first. You can insert/remove primary elements in a members list without claiming the owner. For example, you can add a Branch to a Pipe without claiming the Pipe. Thus two users can add different Branches to the same Pipe: any discrepancies will be resolved when a SAVEWORK is attempted. Before an element can be deleted, that element and all of its sub-hierarchy must be claimed. The following potential problems may not be revealed until you try to save changes: Elements cannot be claimed if recent changes have been made to them by other users. You must issue a GETWORK command first. Elements cannot be claimed if recent changes have been made to them by other users. You must issue a GETWORK command first. Elements cannot be unclaimed if there are updates outstanding. You must issue a SAVEWORK command first. Elements cannot be unclaimed if there are updates outstanding. You must issue a SAVEWORK command first. You can insert/remove primary elements in a members list without claiming the owner. For example, you can add a Branch to a Pipe without claiming the Pipe. Thus two users can add different Branches to the same Pipe: any discrepancies will be resolved when a SAVEWORK is attempted. You can insert/remove primary elements in a members list without claiming the owner. For example, you can add a Branch to a Pipe without claiming the Pipe. Thus two users can add different Branches to the same Pipe: any discrepancies will be resolved when a SAVEWORK is attempted. Before an element can be deleted, that element and all of its sub-hierarchy must be claimed. Before an element can be deleted, that element and all of its sub-hierarchy must be claimed. The following potential problems may not be revealed until you try to save changes: The following potential problems may not be revealed until you try to save changes:
Extract Databases
Unlike standard multiwrite databases, extracts allow users to keep elements claimed when they exit from AVEVA E3D Design or change to another module. They can also be used, together with Data Access Control (DAC), to manage workflow. Refer to Administrator User Guide for more information. An Extract is created from an existing Database. When an Extract is created, it will be empty, with pointers back to the owing or master database . Extracts can only be created from Multiwrite databases. An extract can be worked on by one User at the same time as another user is working on the master or another extract. When a user works on the extract, an extract claim is made as well as a user claim. If the claim mode is explicit, the extract claim will be made automatically when you make a user claim using the CLAIM command. You can also claim to the extract only using the EXTRACT CLAIM command. If an element is claimed to an extract, only users with write access to the extract will be able to make a user claim and start work on the element: When an extract user does a SAVEWORK, the changed data will be saved to the Extract. The unchanged data will still be read via pointers back to the master Database (DB). The changes made to the extract can be written back to the master, or dropped. Also, the extract can be refreshed with changes made to the master. EXTRACT CLAIM /STRU1 /STRU2 /STRU3 Claims named elements to the extract EXTRACT CLAIM /STRU1 /STRU2 /ZONE-A HIERARCHY Claims the named elements, and all the elements in the hierarchy to the extract The HIERARCHY keyword must be the last on the command line. It will attempt to claim to the extract all members of the elements listed in the command which are not already claimed to the extract. EXTRACT FLUSH DB PIPE/PIPE ‘Description of flush’ Writes all changes to the database back to the owing extract. The Extract claim is maintained. EXTRACT FLUSH /STRU1 /STRU2 /STRU3 ‘Flushing three structures’ Writes the changes to the named elements back to the owing extract. The Extract claim is maintained. EXTRACT ISSUE DB PIPE/PIPE ‘Issuing /pipe’ Writes all the changes to the database back to the owning extract and releases the extract claim EXTRACT ISSUE /ZONE-A HIERARCHY ‘Issuing /zone’ Writes all the changes to the named element and all elements under it in the hierarchy back to the owning extract and releases the extract claim EXTRACT ISSUE /STRU1 /STRU2 /STRU3 ‘Issuing three structures’ Writes the changes to the named elements back to the owning extract and releases the extract claim EXTRACT RELEASE DB PIPE/PIPE Releases the extract claim: this command can only be given to release changes that have already been flushed. EXTRACT RELEASE /STRU1 /STRU2 /STRU3 Releases the extract claim: this command can only be given to release changes that have already been flushed. EXTRACT RELEASE /ZONE-A HIERARCHY Releases the extract claim to the named element and all: elements under it in the hierarchy. EXTRACT DROP DB PIPE/PIPE ‘Dropping /Pipe’ Drops changes that have not been flushed or issued. Your claim must have been unclaimed before this command can be given. EXTRACT REFRESH DB MYTEAMPIPING This will refresh the extract MYTEAMPIPING with changes made on the parent extract, The elements required can be specified by selection criteria, using a Programmable Macro Language (PML) expression. For example: Examples EXTRACT CLAIM /STRU1 /STRU2 /STRU3 Claims named elements to the extract EXTRACT CLAIM /STRU1 /STRU2 /ZONE-A HIERARCHY Claims the named elements, and all the elements in the hierarchy to the extract The HIERARCHY keyword must be the last on the command line. It will attempt to claim to the extract all members of the elements listed in the command which are not already claimed to the extract. EXTRACT FLUSH DB PIPE/PIPE ‘Description of flush’ Writes all changes to the database back to the owing extract. The Extract claim is maintained. EXTRACT FLUSH /STRU1 /STRU2 /STRU3 ‘Flushing three structures’ Writes the changes to the named elements back to the owing extract. The Extract claim is maintained. EXTRACT ISSUE DB PIPE/PIPE ‘Issuing /pipe’ Writes all the changes to the database back to the owning extract and releases the extract claim EXTRACT ISSUE /ZONE-A HIERARCHY ‘Issuing /zone’ Writes all the changes to the named element and all elements under it in the hierarchy back to the owning extract and releases the extract claim EXTRACT ISSUE /STRU1 /STRU2 /STRU3 ‘Issuing three structures’ Writes the changes to the named elements back to the owning extract and releases the extract claim EXTRACT RELEASE DB PIPE/PIPE Releases the extract claim: this command can only be given to release changes that have already been flushed. EXTRACT RELEASE /STRU1 /STRU2 /STRU3 Releases the extract claim: this command can only be given to release changes that have already been flushed. EXTRACT RELEASE /ZONE-A HIERARCHY Releases the extract claim to the named element and all: elements under it in the hierarchy. EXTRACT DROP DB PIPE/PIPE ‘Dropping /Pipe’ Drops changes that have not been flushed or issued. Your claim must have been unclaimed before this command can be given. EXTRACT REFRESH DB MYTEAMPIPING This will refresh the extract MYTEAMPIPING with changes made on the parent extract, EXTRACT CLAIM ALL STRU WHERE (:OWNER EQ 'USERA') HIERARCHY >- EXTRACT -+- FLUSH ---------------. | | |- FLUSHWithoutrefresh -| | | |- RELEASE -------------| | | |- ISSUE ---------------| | | |- DROP ----------------| .-------<-------. | | / | ‘- REFRESH -------------+--*-- elementname --+- HIERARCHY -. | | | | | | ‘-- DB dbname ---------------------+-> If the databases are set up with implicit claim, when you modify the element, the element will be claimed both to the extract and then to you. If the element is already claimed to the extract, then the claim will only be made to you. If the databases are set up with explicit claim, then you will need to use the CLAIM command before modifying the element. Once you have made a user claim, no other users will be able to work on the elements claimed, as in a normal multiwrite database. If you unclaim an element, it will remain claimed to the extract until the extract claim is released or issued. If the databases are set up with implicit claim, when you modify the element, the element will be claimed both to the extract and then to you. If the element is already claimed to the extract, then the claim will only be made to you. If the databases are set up with implicit claim, when you modify the element, the element will be claimed both to the extract and then to you. If the element is already claimed to the extract, then the claim will only be made to you. If the databases are set up with explicit claim, then you will need to use the CLAIM command before modifying the element. If the databases are set up with explicit claim, then you will need to use the CLAIM command before modifying the element. Once you have made a user claim, no other users will be able to work on the elements claimed, as in a normal multiwrite database. Once you have made a user claim, no other users will be able to work on the elements claimed, as in a normal multiwrite database. If you unclaim an element, it will remain claimed to the extract until the extract claim is released or issued. If you unclaim an element, it will remain claimed to the extract until the extract claim is released or issued. Administrator User Guide master released issued EXTRACT CLAIM /STRU1 /STRU2 /STRU3 EXTRACT CLAIM /STRU1 /STRU2 /ZONE-A HIERARCHY HIERARCHY EXTRACT FLUSH DB PIPE/PIPE ‘Description of flush’ EXTRACT FLUSH /STRU1 /STRU2 /STRU3 ‘Flushing three structures’ EXTRACT ISSUE DB PIPE/PIPE ‘Issuing /pipe’ EXTRACT ISSUE /ZONE-A HIERARCHY ‘Issuing /zone’ EXTRACT ISSUE /STRU1 /STRU2 /STRU3 ‘Issuing three structures’ EXTRACT RELEASE DB PIPE/PIPE EXTRACT RELEASE /STRU1 /STRU2 /STRU3 EXTRACT RELEASE /ZONE-A HIERARCHY EXTRACT DROP DB PIPE/PIPE ‘Dropping /Pipe’ EXTRACT REFRESH DB MYTEAMPIPING
How to Find Out What You Can Claim
This section explains what different users will see as a result of Q CLAIMLIST commands. For this example, take the case of a database PIPE/PIPE, accessed by USERA, with two extracts. Users USERX1 and USERX2 are working on the extracts. USERA creates a Pipe and flushes the database back to the owning database, PIPE/PIPE. The results of various Q CLAIMLIST commands by the three Users, together with the extract control commands which they have to give to make the new data available, are shown in the the image. When you create an element, AVEVA E3D Design only sees it as a user claim, not an extract claim, until the element is flushed. It will then be reported as an extract claim (as well as a user claim, if it has not been unclaimed). Note that a change in the claim status of an existing element will be shown by the appropriate Q CLAIMLIST command as soon as appropriate updates take place, but a user will have to GETWORK as usual to see the changes to the Model model data. We recommend that: Q DBNAME Returns the name of the database which you are actually writing to. Q CLAIMLIST Outputs a list of all elements currently claimed by yourself: Q CLAIMLIST OTHE Outputs a list of all elements currently claimed by other users who are accessing the same DB: Q CLAIMLIST EXTRACT Shows the extract claimlist for all the writable extracts in the MDB. Q CLAIMLIST EXTRACT DB dbname Shows the extract claimlist for the named extract DB. Q CLAIMLIST EXTRACT FREE DB dbname Shows the elements claimed to the current extract and not claimed to another extract or user. That is, the elements which can be released. Q CLAIMLIST EXTRACT OTHER DB dbname Shows the elements claimed to the current extract and claimed to another extract or user. Q CLAIMLIST CONTROL DB dbname Shows the extract claimlist for a CONTROLLED named extract DB. Q DBAC Queries the access mode of the database. DBAC can have the text settings CONTROL, UPDATE or MULTIWRITE. Q DBCL Queries the claim mode of the database. DBCL can have the text settings EXPLICIT or IMPLICIT. Q LCLM Queries whether or not the current element is claimed by another user. Returns TRUE or FALSE. Q DBNAME Returns the name of the database which you are actually writing to. Q CLAIMLIST Outputs a list of all elements currently claimed by yourself: Q CLAIMLIST OTHE Outputs a list of all elements currently claimed by other users who are accessing the same DB: Q CLAIMLIST EXTRACT Shows the extract claimlist for all the writable extracts in the MDB. Q CLAIMLIST EXTRACT DB dbname Shows the extract claimlist for the named extract DB. Q CLAIMLIST EXTRACT FREE DB dbname Shows the elements claimed to the current extract and not claimed to another extract or user. That is, the elements which can be released. Q CLAIMLIST EXTRACT OTHER DB dbname Shows the elements claimed to the current extract and claimed to another extract or user. Q CLAIMLIST CONTROL DB dbname Shows the extract claimlist for a CONTROLLED named extract DB. Q DBAC Queries the access mode of the database. DBAC can have the text settings CONTROL, UPDATE or MULTIWRITE. Q DBCL Queries the claim mode of the database. DBCL can have the text settings EXPLICIT or IMPLICIT. Q LCLM Queries whether or not the current element is claimed by another user. Returns TRUE or FALSE. Q DBNAME Returns the name of the database which you are actually writing to. Q CLAIMLIST Outputs a list of all elements currently claimed by yourself: Q CLAIMLIST OTHE Outputs a list of all elements currently claimed by other users who are accessing the same DB: Q CLAIMLIST EXTRACT Shows the extract claimlist for all the writable extracts in the MDB. Q CLAIMLIST EXTRACT DB dbname Shows the extract claimlist for the named extract DB. Q CLAIMLIST EXTRACT FREE DB dbname Shows the elements claimed to the current extract and not claimed to another extract or user. That is, the elements which can be released. Q CLAIMLIST EXTRACT OTHER DB dbname Shows the elements claimed to the current extract and claimed to another extract or user. Q CLAIMLIST CONTROL DB dbname Shows the extract claimlist for a CONTROLLED named extract DB. Q DBAC Queries the access mode of the database. DBAC can have the text settings CONTROL, UPDATE or MULTIWRITE. Q DBCL Queries the claim mode of the database. DBCL can have the text settings EXPLICIT or IMPLICIT. Q LCLM Queries whether or not the current element is claimed by another user. Returns TRUE or FALSE. EXTRACT CLAIM ALL FROM !COLL >-- Q CLAIMLIST --+- OTHER -----. | | |- EXTRACT ---+- OTHER --. | | | | |- FREE ---| | | | | ‘----------| | | |------------------------+-- DB dbname --. | | ‘----------------------------------------+--> Before you make a user or extract claim, you should do an EXTRACT REFRESH and GETWORK. If you need to claim many elements to an extract, it improves performance if the elements are claimed in a single command, for example, by using a collection: EXTRACT CLAIM ALL FROM !COLL Before you make a user or extract claim, you should do an EXTRACT REFRESH and GETWORK. Before you make a user or extract claim, you should do an EXTRACT REFRESH and GETWORK. If you need to claim many elements to an extract, it improves performance if the elements are claimed in a single command, for example, by using a collection: EXTRACT CLAIM ALL FROM !COLL If you need to claim many elements to an extract, it improves performance if the elements are claimed in a single command, for example, by using a collection: Note: Q CLAIMLIST EXTRACT tells you what you can flush Q CLAIMLIST OTHERS tells you want you can't claim Note : Q CLAIMLIST EXTRACT Q CLAIMLIST OTHERS Q DBNAME Q CLAIMLIST Q CLAIMLIST OTHE Q CLAIMLIST EXTRACT Q CLAIMLIST EXTRACT DB dbname Q CLAIMLIST EXTRACT FREE DB dbname Q CLAIMLIST EXTRACT OTHER DB dbname Q CLAIMLIST CONTROL DB dbname Q DBAC Q DBCL Q LCLM
Related Attributes
Attribute Name Data Type Qualifier Description DACCLA BOOL True if DAC allows element to be claimed DACERR STRING(120) ATTR Returns the DAC error DACISS BOOL True if DAC allows element to be issued Attribute Name Data Type Qualifier Description DACCLA BOOL True if DAC allows element to be claimed DACERR STRING(120) ATTR Returns the DAC error DACISS BOOL True if DAC allows element to be issued CLMID STRING(120) Unique system ID of user claiming element CLMNUM INTEGER User or extract number claiming element. Extract num\-bers are negative CLMTIE ELEMENT(4) Reference to elements that are automatically claimed along with this element EXCLFR BOOL True if element claimed from this extract. Only True for Primary elements EXCLHI ELEMENT(5000) Primary elements in descendant hierarchy claimed to this extract (includes this element) EXCLTO BOOL True if element claimed to this extract. Only True for Pri\-mary elements EXNCLH ELEMENT(5000) Primary elements in descendant hierarchy not claimed to this extract EXTRC STRING(120) Name of extract claiming element NPDESC ELEMENT(5000) 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 ELEMENT Primary owning element (will be itself if primary) USCLHI ELEMENT(5000) Elements in descendant hierarchy claimed to this user USERC STRING(120) User name of user claiming element USNCLH ELEMENT(5000) Elements in descendant hierarchy not claimed to this user EXHCNC ELEMENT(5000) As EXTCNC, but repeat test for all descendants EXHCNN ELEMENT(5000) As EXTCNN, but repeat test for all descendants EXHCON ELEMENT(5000) As EXTCON, but repeat test for all descendants EXHRCN ELEMENT(5000) As EXRCN, but repeat test for all descendants EXHRCO ELEMENT(5000) As EXTRCO, but repeat test for all descendants EXMOC BOOL As EXMOD but ignoring changes to "noclaim" attributes and member lists EXPMOC BOOL As EXPMOD but ignoring changes to "noclaim" attributes and member lists EXPMOD BOOL True if primary and element or non-primary descendants have been modified in this extract EXTCNC ELEMENT(5000) As EXTCON but excluding non modified elements EXTCNN ELEMENT(5000) As EXTCON but excluding modified elements EXTCON ELEMENT(5000) Primary elements connected/disconnected from ele\-ment or non primary descendants in extract EXTRCN ELEMENT(5000) As EXTCNN, but applied recursively to each connection EXTRCO ELEMENT(5000) As EXTCON, but applied recursively to each connection OKDROP BOOL True if element may be dropped OKDRPH ELEMENT(5000) Primary elements preventing hierarchy drop OKRLEH ELEMENT(5000) Primary elements preventing hierarchy release OKRLEX BOOL True if element may be extract released Attribute Name Data Type Qualifier Description DACCLA BOOL True if DAC allows element to be claimed DACERR STRING(120) ATTR Returns the DAC error DACISS BOOL True if DAC allows element to be issued Attribute Name Data Type Qualifier Description CLMID STRING(120) Unique system ID of user claiming element CLMNUM INTEGER User or extract number claiming element. Extract num\-bers are negative CLMTIE ELEMENT(4) Reference to elements that are automatically claimed along with this element EXCLFR BOOL True if element claimed from this extract. Only True for Primary elements EXCLHI ELEMENT(5000) Primary elements in descendant hierarchy claimed to this extract (includes this element) EXCLTO BOOL True if element claimed to this extract. Only True for Pri\-mary elements EXNCLH ELEMENT(5000) Primary elements in descendant hierarchy not claimed to this extract EXTRC STRING(120) Name of extract claiming element NPDESC ELEMENT(5000) 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 ELEMENT Primary owning element (will be itself if primary) USCLHI ELEMENT(5000) Elements in descendant hierarchy claimed to this user USERC STRING(120) User name of user claiming element USNCLH ELEMENT(5000) Elements in descendant hierarchy not claimed to this user Attribute Name Data Type Qualifier Description EXHCNC ELEMENT(5000) As EXTCNC, but repeat test for all descendants EXHCNN ELEMENT(5000) As EXTCNN, but repeat test for all descendants EXHCON ELEMENT(5000) As EXTCON, but repeat test for all descendants EXHRCN ELEMENT(5000) As EXRCN, but repeat test for all descendants EXHRCO ELEMENT(5000) As EXTRCO, but repeat test for all descendants EXMOC BOOL As EXMOD but ignoring changes to "noclaim" attributes and member lists EXPMOC BOOL As EXPMOD but ignoring changes to "noclaim" attributes and member lists EXPMOD BOOL True if primary and element or non-primary descendants have been modified in this extract EXTCNC ELEMENT(5000) As EXTCON but excluding non modified elements EXTCNN ELEMENT(5000) As EXTCON but excluding modified elements EXTCON ELEMENT(5000) Primary elements connected/disconnected from ele\-ment or non primary descendants in extract EXTRCN ELEMENT(5000) As EXTCNN, but applied recursively to each connection EXTRCO ELEMENT(5000) As EXTCON, but applied recursively to each connection OKDROP BOOL True if element may be dropped OKDRPH ELEMENT(5000) Primary elements preventing hierarchy drop OKRLEH ELEMENT(5000) Primary elements preventing hierarchy release OKRLEX BOOL True if element may be extract released
Undo and Redo
It is possible to undo and redo many operations. The undo mechanism is managed by AVEVA E3D Design using a stack of transaction objects. Each transaction object records the change in the state across the transaction. The new descriptions are then: MARKDB ‘comment’ - Complete the current transaction and starts a new transaction. UNDODB - Undo the last transaction. If there is a current transaction then this is completed. Multiple Undos are allowed. REDODB - Redo to next mark. Multiple Redos are allowed. A redo is only valid after an UNDO. Any database change after an UNDO invalidates a REDO.
How Undo Works
Every time you select an undo operation an entry is taken off the undo stack. The state saved in this transaction is restored, and the transaction object is placed on the redo stack. When the undo stack is empty, then the Undo button and the Undo menu option will be greyed out indicating that there are no operations remaining that can be undone. If the operation of undo involves moving into or out of model editing mode, then the switch into that mode will happen automatically, and the model editor button and menu option will reflect the change. The selection set and handle appropriate to the editing operation that was being used will also be restored. There are also a number of ways that you can perform an undo: The undo stack is automatically cleared after a SAVEWORK or GETWORK. A similar process to the one described above occurs for redo. When a transaction is taken off the redo stack, it is put back onto the undo stack. If you perform any operation that changes the database after doing an undo, then the redo stack will be cleared. Refer to for controlling the undo stack from user defined Programmable Macro Language (PML). MARKDB 'comment' Set a Database mark. Multiple marks may be set. UNDODB Undo database to last mark. Multiple undos are allowed. REDODB Redo to next mark. Multiple Redos are allowed. A redo is only valid after an UNDO. Any database change after an UNDO invalidates a REDO. MARKDB 'comment' Set a Database mark. Multiple marks may be set. UNDODB Undo database to last mark. Multiple undos are allowed. REDODB Redo to next mark. Multiple Redos are allowed. A redo is only valid after an UNDO. Any database change after an UNDO invalidates a REDO. The list of marks can be obtained from PML function MARKDB. The system will always create an initial mark the first time the database is changed. MARKDB 'comment' Set a Database mark. Multiple marks may be set. UNDODB Undo database to last mark. Multiple undos are allowed. REDODB Redo to next mark. Multiple Redos are allowed. A redo is only valid after an UNDO. Any database change after an UNDO invalidates a REDO. AREA 0 MARKDB 'First Mark' AREA 100 MARKDB 'Second Mark' AREA 200 MARKDB 'Third Mark' AREA 300 !MARKS = MARKDB Q VAR !MARKS UNDODB Q AREA - value will be 200 UNDODB Q AREA - value will be 100 UNDODB Q AREA - value will be 0 REDODB Q AREA - value will be 100 REDODB Q AREA - value will be 200 AREA 99 UNDODB Q AREA - value will be 200 REDODB Q AREA - value will be 99 By clicking on the Undo button on the appropriate toolbar. By selecting the Undo option on the Edit pulldown menu on the main toolbar. By entering the command UNDODB n where n indicates how many steps are to be undone. By clicking on the Undo button on the appropriate toolbar. By clicking on the Undo button on the appropriate toolbar. By selecting the Undo option on the Edit pulldown menu on the main toolbar. By selecting the Undo option on the Edit pulldown menu on the main toolbar. By entering the command UNDODB n where n indicates how many steps are to be undone. By entering the command UNDODB n where n indicates how many steps are to be undone. Undo Undo Undo Undo Edit UNDODB n n Example
Shared Collections (Groups) and Secondary Hierarchies
A shared collection can hold in its members list a number of design elements from any combination of hierarchic levels, they may also span Multiple Databases (MDBs). You can use any appropriate design operation to act upon all of these individual elements simply by carrying out the operation on the shared collection. Shared collections are particularly useful when there is a need to create a secondary hierarchy of elements. For example a set of elements for a project may span more that one site, if this is the case it is difficulty to identify where in the hierarchy these elements occur. With a shared collection you can easily query its members and see the hierarchy of elements contained within it. A shared collection is a Model database element in its own right, and is therefore stored automatically for use in later sessions when you save database changes. The Elements which make up a shared collection within the Model database are shown below: GPWL (Group World) Is a top level administrative element. A GPWL may hold multiple GPSET (Group Set) elements. GPSET contains groups of items (GPITEM). A GPSET element has Name, DESC, and FUNCTION attributes. GPITEM These are elements within a database which are to be grouped under a Group Set (GPSET). Elements from different databases can all be grouped into the same Group Set. A GPITEM has the following attributes Name, DESC and SITEM. It is possible to nest Group Sets within other Group Sets. To achieve this structure a GPSET can own another GPSET or a GPITEM can point back onto a GPSET. The following figure illustrates this: GPWL GPSET GPITEM
Define Contents
The contents of a shared collection are defined by adding or removing references to or from the list part of the shared collection. In order to use the commands described in this section, the current element must be the shared collection whose member list you wish to modify. Specified elements are then added to the list part of the current element starting from the current list position or are removed from the list part of the current element such that the current list position becomes the Head position. The elements to be added to, or removed from, the shared collection’s member list may be specified in any of the following ways: GADD /ZONE1 /VALVE2 Adds /ZONE1 and /VALVE2 to the current shared collection, starting from the current list position GREMOVE /ZONE1 /BOX3 Removes /ZONE1 and /BOX3 from the current shared collection and moves the current list position pointer to the Head position GADD MEM OF /BRANCH1 /BRANCH2 Adds all the pipe Components in Branches /BRANCH1 and /BRANCH2 to the current shared collection, starting from the current list position GREM MEM OF /PIPE100 MEM OF /EQUI-B Removes all Branches of the Pipe /PIPE100 and all members of Equipment /EQUI-B from the current shared collection GREM ITEMS OF /ZONE2 Removes from the current shared collection all occurrences of those offspring of /ZONE2 which are items GADD ALL EQU BRAN OF /ZONE1 /ZONE2 Adds all offspring of /ZONE1 and /ZONE2 which are of types Equip or Branch to the current shared collection, starting from the current list position Examples GADD /ZONE1 /VALVE2 Adds /ZONE1 and /VALVE2 to the current shared collection, starting from the current list position GREMOVE /ZONE1 /BOX3 Removes /ZONE1 and /BOX3 from the current shared collection and moves the current list position pointer to the Head position GADD MEM OF /BRANCH1 /BRANCH2 Adds all the pipe Components in Branches /BRANCH1 and /BRANCH2 to the current shared collection, starting from the current list position GREM MEM OF /PIPE100 MEM OF /EQUI-B Removes all Branches of the Pipe /PIPE100 and all members of Equipment /EQUI-B from the current shared collection GREM ITEMS OF /ZONE2 Removes from the current shared collection all occurrences of those offspring of /ZONE2 which are items GADD ALL EQU BRAN OF /ZONE1 /ZONE2 Adds all offspring of /ZONE1 and /ZONE2 which are of types Equip or Branch to the current shared collection, starting from the current list position >--+-- GADD -----. .-------------. | | / | ‘-- GREMove --+---*-- <selatt> ---+---> Explicitly, by name or (system-assigned) reference number. As members of specified elements, where a member of an element is defined as any element immediately below it in the DB hierarchy As items of specified elements, where an item of an element is any element anywhere below it in the hierarchy which has no list part (such as a Valve, Point, Box, etc.) By type (such as Equipment, Branch, Pipe, etc.) Explicitly, by name or (system-assigned) reference number. Explicitly, by name or (system-assigned) reference number. As members of specified elements, where a member of an element is defined as any element immediately below it in the DB hierarchy As members of specified elements, where a member of an element is defined as any element immediately below it in the DB hierarchy As items of specified elements, where an item of an element is any element anywhere below it in the hierarchy which has no list part (such as a Valve, Point, Box, etc.) As items of specified elements, where an item of an element is any element anywhere below it in the hierarchy which has no list part (such as a Valve, Point, Box, etc.) By type (such as Equipment, Branch, Pipe, etc.) By type (such as Equipment, Branch, Pipe, etc.) or member immediately item no GADD /ZONE1 /VALVE2 GREMOVE /ZONE1 /BOX3 GADD MEM OF /BRANCH1 /BRANCH2 GREM MEM OF /PIPE100 MEM OF /EQUI-B GREM ITEMS OF /ZONE2 GADD ALL EQU BRAN OF /ZONE1 /ZONE2
Delete Shared Collection
The action of this command differs from normal behaviour if the current element is a shared collection. DELETE GPSET Only the current element and any Offspring that are GPSETs will be deleted. DELETE GPWLD Only the current element and any Offspring that are GPSETs will be deleted. Examples DELETE GPSET Only the current element and any Offspring that are GPSETs will be deleted. DELETE GPWLD Only the current element and any Offspring that are GPSETs will be deleted. DELETE GPSET DELETE GPWLD
Copy a Shared Collection
Shared collections can be copied with a slightly different effect to normal elements. COPY /GROUP21 (At a Group) The Current shared collection will contain exactly the same Members as /GROUP21. No new elements have been created. Examples COPY /GROUP21 (At a Group) The Current shared collection will contain exactly the same Members as /GROUP21. No new elements have been created. COPY /GROUP21 (At a Group)
Define Dynamic Shared Collections
You may specify a dynamic selection for a GPSET. The dynamic selection consists of a PML1 collection expression. For example: The selection must be set against the SCOSEL attribute. For example: The selection is evaluated dynamically whenever the shared collection is used. Depending on the selection used there is a performance overhead in evaluating the selection. ALL PIPE WHERE (BORE GT 80) ALL BRAN MEMBERS WHERE (SPREF EQ /MYSPEC ) for SITE /SITE1 SCOSEL ALL EQUI FROM CLAIMLIST RE (BORE GT 80) ALL BRAN MEMBERS WHERE (SPREF EQ /MYSPEC .
Expressions
This section explains the PML 1 expressions package. These facilities are needed within AVEVA products, for example, to define report templates in AVEVA E3D Design. Expressions have types. For example, you can have numeric expressions, text expressions and logical expressions. All the elements in an expression must be of the correct type. For example, if you have a two numbers, x and y, and two text strings text1 and text2, the following expression is meaningless: x + text1 $ x + text1 $ However, both of the following expressions are valid: x + y $ adds the values of the numeric variables. Text1 + text2 $ concatenates the two text strings. x + y $ adds the values of the numeric variables. Text1 + text2 $ concatenates the two text strings. Real expressions also have a physical dimension. This may be NONE when all values in the expression are purely numerical, but if any value has a physical dimension (such as being a length or mass) then all other values must be compatible with it and the result of the expression may have a physical dimension, or it may evaluate to a pure numerical value (1inch / 1mm = 25.4). The following types of expressions are available: x + text1 $ x + y $ adds the values of the numeric variables. Text1 + text2 $ concatenates the two text strings. Logical Expressions Logical Array Expressions Numeric (Real) Expressions Numeric (Real) Functions Text Expressions Logical Expressions Logical Expressions Logical Array Expressions Logical Array Expressions Numeric (Real) Expressions Numeric (Real) Expressions Numeric (Real) Functions Numeric (Real) Functions Text Expressions Text Expressions Note: Generally, all these facilities are compatible with PML 2. Logical Expressions Logical Array Expressions Numeric (Real) Expressions Numeric (Real) Functions Text Expressions Note : x + text1 x + y Text1 + text2 Logical Expressions Logical Array Expressions Numeric (Real) Expressions Numeric (Real) Functions Text Expressions
Format of Expressions
The format of an expression, for example the use of brackets, spaces and quotes, is important. If you do not follow the rules given below you will get error messages: Text must be enclosed in quotes. There must be a space between each operator and operand. For example: Use round brackets to control the order of evaluation of expressions and to enclose the argument of a function. In general, you do not need spaces before or after brackets, except when an AVEVA E3D Design name is followed by a bracket. If there is no space, the bracket will be read as part of the name. 'This is text’ x + y SIN(30) (NAME EQ /VESS1 )
Operator Precedence
Operators are evaluated in the order of the following list: the ones at the top of the list are evaluated first. BRACKETS Brackets can be used to control the order in which operators are evaluated, in the same way as in normal arithmetic FUNCTIONS * / + - EQ, NEQ, LT, LE, GE, GT NOT AND OR Operator Comments BRACKETS Brackets can be used to control the order in which operators are evaluated, in the same way as in normal arithmetic FUNCTIONS * / + - EQ, NEQ, LT, LE, GE, GT NOT AND OR
Nesting Expressions
Expressions can be nested using brackets. ( (SIN(!angleA) * 2) / SIN(!angleB) ) ( (SIN(!angleA) * 2) / SIN(!angleB) )
Logical Expressions
Logical expressions can contain: AVEVA E3D Design attributes of type logical e.g. BUILT. Logical constants. The constants available are: TRUE, ON, YES for true, and FALSE, OFF, NO for false. Logical operators. Logical functions. AVEVA E3D Design attributes of type logical e.g. BUILT. AVEVA E3D Design attributes of type logical e.g. BUILT. Logical constants. The constants available are: TRUE, ON, YES for true, and FALSE, OFF, NO for false. Logical constants. The constants available are: TRUE, ON, YES for true, and FALSE, OFF, NO for false. Logical operators. Logical operators. Logical functions. Logical functions.
Logical Operators
Logical expressions involving physical quantities. If the expression contains unit qualified values, or attributes with a physical dimension then these values are converted to consistent units before comparison If a value is not unit qualified it is assumed to be in current units of the quantity defined by the other value (i.e. the context of the expression). For example if current units of mass (colloquially weight) are oz then But if current units of mass are kg then expression will return FALSE as 2lb is not equal to 2kg. If the units are not units of the same physical quantity FALSE will always be returned as the two values are completely incompatible (as are apples and pears) and a warning issued (for example, (2lb equal 32mm). The logical operators available are: AND EQ, NE The operators EQ and NE may be applied to any pair of values of the same type. GT, GE, LE, LT The operators GE, LE, GT and LT may only be used with numbers and positions. For more information, see Positions, Directions and Orientations in Expressions. NOT OR log1 AND log2 -> logical Perform the logical AND between two logical values. Treats unset values as FALSE. If one of the values is undefined and the other one is FALSE, the result is FALSE. TRUE and FALSE -> FALSE Compare two values. A special feature is used for the positions, only the coordinates specified are compared. Refer to Compare Positions for more information. Unset values result in FALSE across EQ, TRUE across NE. If two positions have no common coordinate, for example, ’N 10 ne U 10’, the result is undefined. Units are consolidated across comparisons. ( 1.0 eq 2.0) -> FALSE None. ( number1 GT number2 ) > logical ( pos1 GT pos2 ) > logical ( number1 GE number2 ) > logical ( pos1 GE pos2 ) > logical ( number1 LE number2 ) > logical ( pos1 LE pos2 ) > logical ( number1 LT number2 ) > logical ( pos1 LT pos2 ) > logical Compare two values. A special feature is used for positions: only the coordinates specified are compared. See Compare Positions for more information. For positions, since comparisons may be performed on more than one value, LT (GT) is not the inverse of GE (LE). Unset values result in false If two positions have no common coordinate, the result is undefined. For example, ’N 10 gt U 10’. Units are consolidated across comparisons. ( 1.0 LT 2.0) -> TRUE ( N 0 E 10 GT N 10 E 0 ) -> FALSE ( N 0 E 10 GT N 10 E 0 ) -FALSE None. NOT log1 -> logical Perform the logical NOT on a logical value. None. not TRUE -> FALSE None. OR log2 -> logical Perform the logical inclusive OR between two logical values. (The exclusive OR is defined by using NE.) Allows numbers instead of logical values. If one of the values is undefined and the other one is TRUE, the result is TRUE. TRUE or FALSE -> TRUE None. Operator Comments AND EQ, NE The operators EQ and NE may be applied to any pair of values of the same type. GT, GE, LE, LT The operators GE, LE, GT and LT may only be used with numbers and positions. For more information, see Positions, Directions and Orientations in Expressions. NOT OR Synopsis log1 AND log2 -> logical Description Perform the logical AND between two logical values. Treats unset values as FALSE. Side Effects If one of the values is undefined and the other one is FALSE, the result is FALSE. Example TRUE and FALSE -> FALSE Synopsis ( number1 EQual number2) -> logical ( text1 EQual text2 ) -> logical ( log1 EQual log2 ) -> logical ( id1 EQual id2 ) -> logical ( pos1 EQual pos2 ) -> logical ( dir1 EQual dir2 ) -> logical ( ori1 EQual ori2 ) -> logical ( pp1 EQual pp2 ) -> logical ( number1 NEqual number2 ) -> logical ( text1 NEqual text2 ) -> logical ( log1 NEqual log2 ) -> logical ( id1 NEqual id2 ) -> logical ( pos1 NEqual pos2 ) -> logical ( dir1 NEqual dir2 ) -> logical ( ori1 NEqual ori2 ) -> logical ( pp1 NEqual pp2 ) -> logical Description Compare two values. A special feature is used for the positions, only the coordinates specified are compared. Refer to Compare Positions for more information. Unset values result in FALSE across EQ, TRUE across NE. Side Effects If two positions have no common coordinate, for example, ’N 10 ne U 10’, the result is undefined. Units are consolidated across comparisons. Example ( 1.0 eq 2.0) -> FALSE Errors None. Synopsis ( number1 GT number2 ) > logical ( pos1 GT pos2 ) > logical ( number1 GE number2 ) > logical ( pos1 GE pos2 ) > logical ( number1 LE number2 ) > logical ( pos1 LE pos2 ) > logical ( number1 LT number2 ) > logical ( pos1 LT pos2 ) > logical Description Compare two values. A special feature is used for positions: only the coordinates specified are compared. See Compare Positions for more information. For positions, since comparisons may be performed on more than one value, LT (GT) is not the inverse of GE (LE). Unset values result in false Side Effects If two positions have no common coordinate, the result is undefined. For example, ’N 10 gt U 10’. Units are consolidated across comparisons. Example ( 1.0 LT 2.0) -> TRUE ( N 0 E 10 GT N 10 E 0 ) -> FALSE ( N 0 E 10 GT N 10 E 0 ) -FALSE Errors None. Synopsis NOT log1 -> logical Description Perform the logical NOT on a logical value. Side Effects None. Example not TRUE -> FALSE Errors None. Synopsis OR log2 -> logical Description Perform the logical inclusive OR between two logical values. (The exclusive OR is defined by using NE.) Allows numbers instead of logical values. Side Effects If one of the values is undefined and the other one is TRUE, the result is TRUE. Example TRUE or FALSE -> TRUE Errors None. ( number1 EQual number2) -> logical ( text1 EQual text2 ) -> logical ( log1 EQual log2 ) -> logical ( id1 EQual id2 ) -> logical ( pos1 EQual pos2 ) -> logical ( dir1 EQual dir2 ) -> logical ( ori1 EQual ori2 ) -> logical ( pp1 EQual pp2 ) -> logical ( number1 NEqual number2 ) -> logical ( text1 NEqual text2 ) -> logical ( log1 NEqual log2 ) -> logical ( id1 NEqual id2 ) -> logical ( pos1 NEqual pos2 ) -> logical ( dir1 NEqual dir2 ) -> logical ( ori1 NEqual ori2 ) -> logical ( pp1 NEqual pp2 ) -> logical Note: The operators EQ, NE, LT, GT, LE and GE are sometimes referred to as comparator or relational operators; NOT, AND and OR are sometimes referred to as Boolean operators. Refer to Precision of Comparisons for tolerances in comparing numbers. Positions, Directions and Orientations in Expressions Precision of Comparisons Compare Positions Compare Positions Positions, Directions and Orientations in Expressions Note : comparator relational Boolean Precision of Comparisons Synopsis log1 AND log2 -> logical Description Side Effects Example TRUE and FALSE -> FALSE EQ and NE Synopsis Description Compare Positions Side Effects ’N 10 ne U 10’ Example ( 1.0 eq 2.0) -> FALSE Errors Synopsis ( number1 GT number2 ) > logical ( pos1 GT pos2 ) > logical ( number1 GE number2 ) > logical ( pos1 GE pos2 ) > logical ( number1 LE number2 ) > logical ( pos1 LE pos2 ) > logical ( number1 LT number2 ) > logical ( pos1 LT pos2 ) > logical Description Compare Positions Side Effects ’N 10 gt U 10 Example ( 1.0 LT 2.0) -> TRUE ( N 0 E 10 GT N 10 E 0 ) -> FALSE ( N 0 E 10 GT N 10 E 0 ) -FALSE Errors Synopsis NOT log1 -> logical Description Side Effects Example not TRUE -> FALSE Errors Synopsis OR log2 -> logical Description Side Effects Example TRUE or FALSE -> TRUE Errors
Logical Functions
The logical functions available are: BADREF DEFINED,UNDEFINED CREATED DELETED EMPTY IFTRUE MATCHWILD MODIFIED UNSET VLOGICAL BADREF DEFINED,UNDEFINED CREATED DELETED EMPTY IFTRUE MATCHWILD MODIFIED UNSET VLOGICAL BADREF (id) -> logical TRUE if id is invalid, else FALSE. None BADREF(TREF) -> ’true’ if TREF=nulref None. DEFined (variable_name) -> logical DEFined (variable_name,number) -> logical UNDEFined (variable_name) -> logical UNDEFined (variable_name , number) -> logical With one argument, DEFINED is true only if the scalar variable, the array variable or the array variable element exists. With two arguments, DEFINED is true only if the first argument is an array variable which has a value for the index denoted by the second argument. UNDEFINED( !foo ) is equivalent to NOT DEFINED( !foo ). None. DEFINED ( !var ) -> TRUE DEFINED ( !array ) -> TRUE DEFINED ( !array[1] )) -> TRUE DEFINED ( !array , 1 ) -> TRUE DEFINED ( !var) -> FALSE UNDEFINED ( !array) -> TRUE DEFINED ( !array , 3 ) -> FALSE None. CREATED -> logical Returns TRUE if the element has been created since the set date. None. CREATED -> TRUE None. DELETED -> logical Returns TRUE if the element has been deleted since the set date. None. DELETED -> TRUE None. EMPTY(text) -> logical Returns TRUE if text is a zero length string, else FALSE None. EMPTY(‘’) -> TRUE EMPTY(‘not empty’) -> FALSE None. IFTrue(logical, anyA, anyB) -> logical The first argument is a logical value or expression. The second and third arguments may be of any type BUT THEY MUST BE OF THE SAME TYPE. Returns a value that is the SAME TYPE as the second and third arguments. Returns anyA if logical evaluates to TRUE, anyB if logical evaluates to FALSE. anyA and anyB can be IFTRUE functions themselves (as long as they return consistent types) so IF constructs can be nested.ds. None. IFT (SPREF EQ /A3B/GC50, 'BLUE', 'RED' iftrue (gwei gt 1tonne, /INSUL/THICK, /INSUL/THIN) -> BLUE ->INSUL/THICK Normal number of argument errors and Mismatched second and third arguments: (2,497) TYPE MISMATCH: unmatched or illegal argument type for IFTRUE function. MATCHW/ILD( text1, text2) -> logical MATCHW/ILD( text1, text2, text3) -> logical MATCHW/ILD( text1, text2, text3, text4) -> logical Matches string text2 to string text1. If they are the same then returns TRUE, else FALSE. text2 may contain wildcard characters. The defaults for wildcards are ‘*’ for any number of characters, and ‘?’ for a single character. With three arguments, the multiple wildcard character ‘*’ may be redefined by text3. With four arguments the single wildcard character ‘?’ may be redefined by text4. None MATCHW/ILD(’** text’,’**!’,’!’) -> TRUE None. .-----------------------------------. / | >- MODIFIED-(-+- attname -------*- DESCENDANTS ‑-+-+-comma +-attname ‑’ | | | | |- DESCENDANTS -. |- SIGNIFICANT --| | | | | | | |- SIGNIFICANT--| |- PRIMARY ----- | | | | | | | |- PRIMARY -----| |- OFFSPRING-----| | | | | | | |- OFFSPRING ---| ‘----------------’ | | | | | | | | | | ‘---------------+--------------------+--+-- ) - OF ‑ id Æ | ‘-Æ For sophisticated queries relating to modifications. Returns TRUE if a modification has taken place. Each attribute name may be followed by the following qualifying keywords: OFFSPRING, to check this element and members SIGNIF, to check all elements for which this element represents the significant one; PRIMARY, check all elements for which this element represents the primary one; DESCENDANTS, this element and everything below (descendants). The ‘OF’ syntax may be used as for attributes. The MODIFIED function or the GEOM, CATTEXT and CATMOD pseudo-attributes. The MODIFIED, DELETED and CREATED functions may go anywhere within an AVEVA E3D™ PML1 expression. i.e. after Q/VAR and within collections None Q (MODIFIED()) Returns TRUE if element has changed at all since the comparison date. It will also return TRUE if the element has been created since the comparison date. Q MODIFIED(POS,ORI) Returns TRUE if POS or ORI modified since the comparison date. Q MODIFIED(P1 POS) Returns TRUE if the position of P1 has changed. Q MODIFIED(GEOM DESCENDANTS Returns TRUE if any geometry for item or any descendants has changed Q MODIFIED(PRIMARY) Returns TRUE if any element for which this element is primary, has changed. Q MODIFIED() OF /PIPE1 Returns TRUE if /PIPE1 has been modified since the comparison date. Q (BUIL OR MODIFIED()OR ELECREC OF NEXT ) None. The MODIFIED, DELETED and CREATED functions are not implemented within PML2 expressions. UNSET(value) -> logical Returns TRUE if value is unset, else FALSE. The value can be of any data type including ARRAYS. Normally it will be an AVEVA E3D™ attribute. None. UNSET( DESC ) TRUE where DESC is an unset text attribute UNSET(CRFA) FALSE where CRFA contains unset reference attributes None. VLOGICAL is used for the late evaluation of variables. VLOGICAL ( variable_name )) -> logical VLOGICAL ( variable_name , number) -> logical With one argument, return the value of the scalar variable or the value of the array variable element as a logical. With two arguments, return the value of the element corresponding to the index number as a logical. The rules of conversion are: TRUE for the strings ’T’, ’TR’, ’TRU’ or ’TRUE’ (case insensitive) or any numeric value not equal to zero; FALSE for the strings ’F’, ’FA’, ’FAL’, ’FALS’ or ’FALSE’ (case insensitive) or a numeric value equal to zero. Scalar variables may not be indexed. For example, VTEXT(!var[1]) will return an error. Array variables must have an index. For example, VTEXT (!array) will return an error. The value cannot be translated into a logical. See also VTEXT, used for late evaluation when a text result is required; and VVALUE, used for late evaluation when a numeric result is required. If the scalar variable, the array variable, or the array variable element does not exist, the result is undefined. VLOG ( !array[1] ) -> TRUE VLOG ( !array , 2 ) -> FALSE None. BADREF DEFINED,UNDEFINED CREATED DELETED EMPTY IFTRUE MATCHWILD MODIFIED UNSET VLOGICAL Synopsis BADREF (id) -> logical Description TRUE if id is invalid, else FALSE. Side Effects None Example BADREF(TREF) -> ’true’ if TREF=nulref Errors None. Synopsis DEFined (variable_name) -> logical DEFined (variable_name,number) -> logical UNDEFined (variable_name) -> logical UNDEFined (variable_name , number) -> logical Description With one argument, DEFINED is true only if the scalar variable, the array variable or the array variable element exists. With two arguments, DEFINED is true only if the first argument is an array variable which has a value for the index denoted by the second argument. UNDEFINED( !foo ) is equivalent to NOT DEFINED( !foo ). Side Effects None. Example DEFINED ( !var ) -> TRUE DEFINED ( !array ) -> TRUE DEFINED ( !array[1] )) -> TRUE DEFINED ( !array , 1 ) -> TRUE DEFINED ( !var) -> FALSE UNDEFINED ( !array) -> TRUE DEFINED ( !array , 3 ) -> FALSE Errors None. Synopsis CREATED -> logical Description Returns TRUE if the element has been created since the set date. Side Effects None. Example CREATED -> TRUE Errors None. Synopsis DELETED -> logical Description Returns TRUE if the element has been deleted since the set date. Side Effects None. Example DELETED -> TRUE Errors None. Synopsis EMPTY(text) -> logical Description Returns TRUE if text is a zero length string, else FALSE Side Effects None. Example EMPTY(‘’) -> TRUE EMPTY(‘not empty’) -> FALSE Errors None. Synopsis IFTrue(logical, anyA, anyB) -> logical The first argument is a logical value or expression. The second and third arguments may be of any type BUT THEY MUST BE OF THE SAME TYPE. Returns a value that is the SAME TYPE as the second and third arguments. Description Returns anyA if logical evaluates to TRUE, anyB if logical evaluates to FALSE. anyA and anyB can be IFTRUE functions themselves (as long as they return consistent types) so IF constructs can be nested.ds. Side Effects None. Example IFT (SPREF EQ /A3B/GC50, 'BLUE', 'RED' iftrue (gwei gt 1tonne, /INSUL/THICK, /INSUL/THIN) -> BLUE ->INSUL/THICK Errors Normal number of argument errors and Mismatched second and third arguments: (2,497) TYPE MISMATCH: unmatched or illegal argument type for IFTRUE function. Synopsis MATCHW/ILD( text1, text2) -> logical MATCHW/ILD( text1, text2, text3) -> logical MATCHW/ILD( text1, text2, text3, text4) -> logical Description Matches string text2 to string text1. If they are the same then returns TRUE, else FALSE. text2 may contain wildcard characters. The defaults for wildcards are ‘*’ for any number of characters, and ‘?’ for a single character. With three arguments, the multiple wildcard character ‘*’ may be redefined by text3. With four arguments the single wildcard character ‘?’ may be redefined by text4. Side Effects None Example MATCHW/ILD(’A big bottle of beer’,’*big*’) -> TRUE MATCHW/ILD(’A big bottle of beer’,’??big*’) -> TRUE MATCHW/ILD(’A big bottle of beer’,’???*big*’) -> FALSE MATCHW/ILD(’A big bottle of beer’,’*big*beer’) -> TRUE MATCHW/ILD(’** text’,’**!’,’!’) -> TRUE Errors None. Synopsis .-----------------------------------. / | >- MODIFIED-(-+- attname -------*- DESCENDANTS ‑-+-+-comma +-attname ‑’ | | | | |- DESCENDANTS -. |- SIGNIFICANT --| | | | | | | |- SIGNIFICANT--| |- PRIMARY ----- | | | | | | | |- PRIMARY -----| |- OFFSPRING-----| | | | | | | |- OFFSPRING ---| ‘----------------’ | | | | | | | | | | ‘---------------+--------------------+--+-- ) - OF ‑ id Æ | ‘-Æ Description For sophisticated queries relating to modifications. Returns TRUE if a modification has taken place. Each attribute name may be followed by the following qualifying keywords: OFFSPRING, to check this element and members SIGNIF, to check all elements for which this element represents the significant one; PRIMARY, check all elements for which this element represents the primary one; DESCENDANTS, this element and everything below (descendants). The ‘OF’ syntax may be used as for attributes. The MODIFIED function or the GEOM, CATTEXT and CATMOD pseudo-attributes. The MODIFIED, DELETED and CREATED functions may go anywhere within an AVEVA E3D™ PML1 expression. i.e. after Q/VAR and within collections Side Effects None Example Q (MODIFIED()) Returns TRUE if element has changed at all since the comparison date. It will also return TRUE if the element has been created since the comparison date. Q MODIFIED(POS,ORI) Returns TRUE if POS or ORI modified since the comparison date. Q MODIFIED(P1 POS) Returns TRUE if the position of P1 has changed. Q MODIFIED(GEOM DESCENDANTS Returns TRUE if any geometry for item or any descendants has changed Q MODIFIED(PRIMARY) Returns TRUE if any element for which this element is primary, has changed. Q MODIFIED() OF /PIPE1 Returns TRUE if /PIPE1 has been modified since the comparison date. Q (BUIL OR MODIFIED()OR ELECREC OF NEXT ) Errors None. Synopsis UNSET(value) -> logical Description Returns TRUE if value is unset, else FALSE. The value can be of any data type including ARRAYS. Normally it will be an AVEVA E3D™ attribute. Side Effects None. Example UNSET( DESC ) TRUE where DESC is an unset text attribute UNSET(CRFA) FALSE where CRFA contains unset reference attributes Errors None. Synopsis VLOGICAL ( variable_name )) -> logical VLOGICAL ( variable_name , number) -> logical Description With one argument, return the value of the scalar variable or the value of the array variable element as a logical. With two arguments, return the value of the element corresponding to the index number as a logical. The rules of conversion are: TRUE for the strings ’T’, ’TR’, ’TRU’ or ’TRUE’ (case insensitive) or any numeric value not equal to zero; FALSE for the strings ’F’, ’FA’, ’FAL’, ’FALS’ or ’FALSE’ (case insensitive) or a numeric value equal to zero. Scalar variables may not be indexed. For example, VTEXT(!var[1]) will return an error. Array variables must have an index. For example, VTEXT (!array) will return an error. The value cannot be translated into a logical. See also VTEXT, used for late evaluation when a text result is required; and VVALUE, used for late evaluation when a numeric result is required. Side Effects If the scalar variable, the array variable, or the array variable element does not exist, the result is undefined. Example VLOG ( !array[1] ) -> TRUE VLOG ( !array , 2 ) -> FALSE Errors None. Synopsis BADREF (id) -> logical Description id Side Effects Example BADREF(TREF) -> ’true’ if TREF=nulref Errors Synopsis DEFined (variable_name) -> logical DEFined (variable_name,number) -> logical UNDEFined (variable_name) -> logical UNDEFined (variable_name , number) -> logical Description Side Effects Example DEFINED ( !var ) -> TRUE DEFINED ( !array ) -> TRUE DEFINED ( !array[1] )) -> TRUE DEFINED ( !array , 1 ) -> TRUE DEFINED ( !var) -> FALSE UNDEFINED ( !array) -> TRUE DEFINED ( !array , 3 ) -> FALSE Errors Synopsis CREATED -> logical Description Side Effects Example CREATED -> TRUE Errors Synopsis DELETED -> logical Description Side Effects Example DELETED -> TRUE Errors Synopsis EMPTY(text) -> logical Description Side Effects Example EMPTY(‘’) -> TRUE EMPTY(‘not empty’) -> FALSE Errors Synopsis IFTrue(logical, anyA, anyB) -> logical Description Side Effects Example IFT (SPREF EQ /A3B/GC50, 'BLUE', 'RED' iftrue (gwei gt 1tonne, /INSUL/THICK, /INSUL/THIN) -> BLUE ->INSUL/THICK Errors Synopsis MATCHW/ILD( text1, text2) -> logical MATCHW/ILD( text1, text2, text3) -> logical MATCHW/ILD( text1, text2, text3, text4) -> logical Description text2 text1 text2 text3 text4 Side Effects Example MATCHW/ILD(’** text’,’**!’,’!’) -> TRUE Errors Synopsis .-----------------------------------. / | >- MODIFIED-(-+- attname -------*- DESCENDANTS ‑-+-+-comma +-attname ‑’ | | | | |- DESCENDANTS -. |- SIGNIFICANT --| | | | | | | |- SIGNIFICANT--| |- PRIMARY ----- | | | | | | | |- PRIMARY -----| |- OFFSPRING-----| | | | | | | |- OFFSPRING ---| ‘----------------’ | | | | | | | | | | ‘---------------+--------------------+--+-- ) - OF ‑ id Æ | ‘-Æ Description Side Effects Example Q (MODIFIED()) Q MODIFIED(POS,ORI) Q MODIFIED(P1 POS) Q MODIFIED(GEOM DESCENDANTS Q MODIFIED(PRIMARY) Q MODIFIED() OF /PIPE1 Q (BUIL OR MODIFIED()OR ELECREC OF NEXT ) Errors Synopsis UNSET(value) -> logical Description value Side Effects None. Example UNSET( DESC ) TRUE where DESC is an unset text attribute UNSET(CRFA) FALSE where CRFA contains unset reference attributes Errors Synopsis VLOGICAL ( variable_name )) -> logical VLOGICAL ( variable_name , number) -> logical Description VTEXT(!var[1]) VTEXT (!array) Side Effects Example VLOG ( !array[1] ) -> TRUE VLOG ( !array , 2 ) -> FALSE Errors
Logical Array Expressions
Logical array expressions can contain: AVEVA E3D Design attributes of type logical array. For example, LOGARR where LOGARR is a User Dfined Attribute (UDA) of type logical. Logical constants. The constants available are: TRUE, ON, YES for true; and FALSE, OFF, NO for false. Logical operators. Refer to Logical Operators. Logical functions. Refer to Logical Functions. AVEVA E3D Design attributes of type logical array. For example, LOGARR where LOGARR is a User Dfined Attribute (UDA) of type logical. AVEVA E3D Design attributes of type logical array. For example, LOGARR where LOGARR is a User Dfined Attribute (UDA) of type logical. Logical constants. The constants available are: TRUE, ON, YES for true; and FALSE, OFF, NO for false. Logical constants. The constants available are: TRUE, ON, YES for true; and FALSE, OFF, NO for false. Logical operators. Refer to Logical Operators. Logical operators. Refer to Logical Operators. Logical functions. Refer to Logical Functions. Logical functions. Refer to Logical Functions. Logical Operators Logical Functions Logical Operators . Logical Functions .
Numeric (Real) Expressions
In AVEVA E3D Design expressions, integers are treated as reals; they are fully interchangeable. Numeric expressions can contain: Numbers, for example: 32, 10.1. Numbers can be given as integer exponents, for example: 10 exp 5, and 5 E 6. Values (numbers) can be qualified by units. This introduces dimensional analysis into the expression. The valid units are any standard appropriate unit qualifiers for example MM, M/etres, IN/ches, FT, FEET, kg, lb, kgf/m3, pascal. These may be preceded by SQU/are, CUBIC, CUB/e to denote non-linear Values, or alternatively they can have power indices appended. For example: 100 mm, 10 exp 5 cubic feet, 10m3, 20newton.m-2. Feet and inches can be shown as, for example, 10'6. AVEVA E3D Design attributes of type number, for example: XLEN. Position, direction and orientation attributes which have a subscript to indicate which part of the array is required. For example, POS[2] means the second element of the POSITION attribute; that is, the northing. Note: Position, direction and orientation attributes without subscripts can only be used in number array expressions. The keyword PI (3.142). Numeric operators. Numeric functions. Numbers, for example: 32, 10.1. Numbers, for example: 32, 10.1. Numbers can be given as integer exponents, for example: 10 exp 5, and 5 E 6. Numbers can be given as integer exponents, for example: 10 exp 5, and 5 E 6. Values (numbers) can be qualified by units. This introduces dimensional analysis into the expression. The valid units are any standard appropriate unit qualifiers for example MM, M/etres, IN/ches, FT, FEET, kg, lb, kgf/m3, pascal. These may be preceded by SQU/are, CUBIC, CUB/e to denote non-linear Values, or alternatively they can have power indices appended. For example: 100 mm, 10 exp 5 cubic feet, 10m3, 20newton.m-2. Feet and inches can be shown as, for example, 10'6. Values (numbers) can be qualified by units. This introduces dimensional analysis into the expression. The valid units are any standard appropriate unit qualifiers for example MM, M/etres, IN/ches, FT, FEET, kg, lb, kgf/m3, pascal. These may be preceded by SQU/are, CUBIC, CUB/e to denote non-linear Values, or alternatively they can have power indices appended. For example: 100 mm, 10 exp 5 cubic feet, 10m3, 20newton.m-2. Feet and inches can be shown as, for example, 10'6. AVEVA E3D Design attributes of type number, for example: XLEN. AVEVA E3D Design attributes of type number, for example: XLEN. Position, direction and orientation attributes which have a subscript to indicate which part of the array is required. For example, POS[2] means the second element of the POSITION attribute; that is, the northing. Note: Position, direction and orientation attributes without subscripts can only be used in number array expressions. Position, direction and orientation attributes which have a subscript to indicate which part of the array is required. For example, POS[2] means the second element of the POSITION attribute; that is, the northing. The keyword PI (3.142). The keyword PI (3.142). Numeric operators. Numeric operators. Numeric functions. Numeric functions. POS[2] Note
Numeric (Real) Operators
The numeric operators available are: + Addition. - Subtraction. * Multiplication. / Division. Operator Comments + Addition. - Subtraction. * Multiplication. / Division.
ADD and SUBTRACT (+ and -)
The add and subtract functions available are number + number -> number number ‑ number -> number + number -> number - number -> number Add or subtract two numbers. They can also be used as unary operators at the beginning of a parenthesized sub-expression. Units are consolidated across add and subtract and the result is returned in current units of the physical quantity, for example when current distance units are inches If only one value has a unit qualifier the other is assumed to be in current units of that physical quantity for example: If the two values have conflicting units a warning is issued and a value is returned with no units assuming both values are in the database units of their respective quantities which is mm and Kg in the example: q (1ft + 1kg ) will return 305.8 1 + 2 -> 3.0 1 ‑ 2 -> 1.0 + 1 -> 1.0 - 1 -> -1.0 Floating point underflow. Synopsis number + number -> number number ‑ number -> number + number -> number - number -> number Description Add or subtract two numbers. They can also be used as unary operators at the beginning of a parenthesized sub-expression. Side Effects Units are consolidated across add and subtract and the result is returned in current units of the physical quantity, for example when current distance units are inches q (1ft + 100mm) will return 15.9in If only one value has a unit qualifier the other is assumed to be in current units of that physical quantity for example: q (1ft + 100 ) will return 112in If the two values have conflicting units a warning is issued and a value is returned with no units assuming both values are in the database units of their respective quantities which is mm and Kg in the example: q (1ft + 1kg ) will return 305.8 Example 1 + 2 -> 3.0 1 ‑ 2 -> 1.0 + 1 -> 1.0 - 1 -> -1.0 Errors Floating point underflow. Synopsis number + number -> number number ‑ number -> number + number -> number - number -> number Description Side Effects Example 1 + 2 -> 3.0 1 ‑ 2 -> 1.0 + 1 -> 1.0 - 1 -> -1.0 Errors