Metric

Return to Introduction  Previous page  Next page

public Class

A Metric is a named item with a weighting that can be associated with an element for purposes of building metrics about the model. Accessed through the Element Metrics collection.

Associated table in .EAP file: t_objectmetrics

Metric Attributes

Attribute

Type

Notes

Name

String

Read/Write. The name of the metric.

Type

String

Read/Write. The metric type.

Weight

Long

Read/Write. A user defined weighting for estimation or metric purposes.

Notes

String

Read/Write. Notes about this metric.

ObjectType

ObjectType

Read only. Distinguishes objects referenced through a Dispatch interface.

Metric Methods

Method

Type

Notes

Update () 

Boolean 

Update the current Metric object after modification or appending a new item. If false is returned, check the GetLastError function for more information.

GetLastError () 

String

Returns a string value describing the most recent error that occurred in relation to this object.

This function is rarely used since an exception is thrown when an error occurs.