Extending product function with VBA : The System Architect object model : Object model classes : Symbol class : Symbol metrics
  
Symbol metrics
You can run individual metrics by invoking the GetMetric method in the Symbol class. There is a directory of all the symbol metrics in the SYMBOLMETRIC enumerated list in the SA Object Browser. The following lists all the available symbol metrics and their descriptions:
SYMMETANNOTATION
Returns True if the symbol is an annotation symbol (Doc Block, Text Box, Rectangle, Page Connector).
SYMMETBALANCE
Compares the input and output lines of the symbol with the input and output lines of its child process. Creates a list of non-matching input or output lines, giving the name and symbol type. (See Balance Child Help file)
If the symbol is a data store, AND connector, or XOR connector, then it compares the defined elements and structures of those symbols. Creates list of undefined elements in the symbol and indicates whether the incoming and outgoing data flows have defined elements. (See Balance Horizontal Help file)
SYMMETBALANCEMSPEC
Balances the Minispec of the symbol definition. Used for processes on Data Flow diagrams and modules on Structure Chart diagrams. For additional information, reference the System Architect Help file, using keyword Minispec.
SYMMETBOTTOM
Bottom is a derived True or False Boolean field. The value is true for a symbol if it does not expand to a diagram.
SYMMETCHARCOUNT
Returns the number of characters in the description property of the symbol.
SYMMETCONNECTOR
Returns True if the symbol is a connector symbol (AND connector, XOR connector, or ICOM Arrow Join)
SYMMETCURRENT
True or False Boolean field. Returns True if symbol on currently displayed diagram.
SYMMETELEMENTLIST
Creates a list of the bottom level elements for the symbol definition. An element is bottom if it has no expanding relationships.
SYMMETEXPRESSION
Creates a list of erroneous expression syntax or undefined data elements or data structures used by the expression of the symbol definition.
SYMMETICOMDEST
Returns the ICOM arrow destination role (input, control, mechanism, or boundary) as a string.
SYMMETICOMSOURCE
Returns the ICOM arrow source role (call, output, or boundary) as a string.
SYMMETINPUTLIST
Creates a list of bottom level elements used as input for the symbol definition. An element is bottom if it has no expanding relationships.
SYMMETISFOREIGNKEY
Returns True if the symbol definition is a foreign key.
SYMMETKEYCOMPNBR
Returns the component number of the primary key of a symbol. A user can alternatively view the component number by expanding the attribute list of the symbol definition in the browser detail (for example, @1, @2, and so forth).
SYMMETLEVELNUMBER
Returns the number describing the hierarchal position of the symbol (that is, 5.3, 5.3.1, and so forth) as a string.
SYMMETLEVELNUMBERSORT
Returns the number describing the hierarchal position of the symbol as a string. Each number contains 3 digits (i.e. 003.005.002). This allows the user to better sort the results.
SYMMETLINECOUNT
Returns the number of lines in the description property of a symbol definition.
SYMMETNORMALIZE1
Runs a check to see if the symbol definition is in first normal form. An entity is in First Normal Form if it contains no repeating groups.
SYMMETNORMALIZE23
Runs a check to see if the symbol definition is in second and third normal form. An entity is in Second Normal Form if it is in First Normal Form and each non-key attribute is full functionally dependent on the primary key. An entity is in Third Normal Form if it is in Second Normal Form and each non-key attribute is dependent on the primary key and only on the primary key.
SYMMETOUTPUTLIST
Creates a list of bottom level elements used as output for the symbol definition. An element is bottom if it has no expanding relationships.
SYMMETPARENTSLASHDATA
Returns the symbol definition's foreign key slash data, which contains information on where the attribute is keyed from. The slash data of the foreign key can also be viewed by expanding the attribute list of the symbol definition in the browser details. The slash data appears in the form of the following example:
Row_Number / FKFROM "Stock_Location.Row_Number(stores)" /
SYMMETREFERENCE
Returns True if the symbol definition is referenced by any other object.
SYMMETRULES
Runs rules check that looks for violations of standard methodology rules for the symbol.
SYMMETSELECTED
Returns True if the symbol on a currently opened diagram is highlighted.
SYMMETSEQINPARENTSLIST
Checks the property set of the parent object for a list of child objects. Returns the number that the symbol definition appears in that list.
SYMMETTOP
Returns False if the diagram, which the selected symbol is on, is the child of any other symbols. Returns True if that diagram does not expand from any other symbol.
SYMMETUNMARKEDLIST
Creates a list of bottom level elements used by the definition of all line symbols that are not marked as either input or output (no arrow heads). An element is bottom if it has no expanding relationships.
SYMMETUPDATEUSES
Updates the relation table of the data dictionary (RELATN.DBF). Has no return value.
SYMMETWORDCOUNT
Returns the number of words in the description property of the symbol definition.
See also
Symbol class