Extending product function with VBA > The System Architect object model > Object model classes > Encyclopedia class > Encyclopedia class: Methods > GetRelationMetric
  
GetRelationMetric
Gets relationship information or behavior between two System Architect objects in the encyclopedia.
Syntax
Encyclopedia Object.GetRelationMetric SAObject1, SAObject2, Relation, Depth, Metric, FieldType[, NbrChars[, NbrDec]]
Parameters
Encyclopedia Object
Use: Required
Data type: Object
Any instantiated Encyclopedia class
SAObject1
Use: Required
Data type: Object
One of two required System Architect objects that are needed to execute the relation metric.
SAObject2
Use: Required
Data type: Object
One of two required System Architect objects that are needed to execute the relation metric.
Relation
Use: Required
Data type: RELATETYPE
The relationship type that exists between the two parameterized System Architect objects above.
Depth
Use: Required
Data type: Long
The number of relationships between the two parameterized System Architect objects above. For example, if Object 1 is a Data Structure that contains Object 2, which is a Data Element, then the `Depth' between the two objects is 1.
Metric
Use: Required
Data type: RELATIONMETRIC
Relation Metric, see below for a complete list of all relation metrics.
FieldType
Use: Required
Data type: FLDTYPE
NbrChars
Use: Optional
Data type: Long
The number of characters that System Architect returns that will appear before the decimal point.
NbrDec
Use: Optional
Data type: Long
The number of characters that System Architect returns that will appear after the decimal point.
See also
Encyclopedia class: Methods