Attribute Symbolic Constants

Some of the model and object attributes accessible through EMA are integers that can take on several values, each of which has a special symbolic meaning (i.e., codes or flags). For convenience, the possible values for these attributes are represented by the symbolic constants listed in this section. The substituted values of these constants are subject to change in new releases, so it is not advisable to use the actual numeric constants instead of the symbolic constants.

The grid unit symbolic constants listed below identify the type of grid that is used inside a subnet to measure node and link positions. These constants can be assigned to the grid unit attribute of the subnet object within the network model. The grid unit value assigned to this subnet attribute determines the unit interpretation of all grid and position related attributes of network objects (in the network attribute tables in Models, Objects, and Attributes, grid-based attribute units are indicated by the designation “subnet grid unit”).

Table 141: Grid Unit Symbolic Constants

  • OPC_GRID_UNIT_DEG
  • OPC_GRID_UNIT_FOOT
  • OPC_GRID_UNIT_KILOMETER
  • OPC_GRID_UNIT_METER
  • OPC_GRID_UNIT_MILE
  • OPC_GRID_UNIT_NONE

The grid style symbolic constants listed below are used to specify the appearance of the grid within a subnet. These constants can be assigned to the grid style attribute of subnet objects within network models.

Table 142: Grid Style Symbolic Constants

  • OPC_GRID_STYLE_DASHED
  • OPC_GRID_STYLE_NONE
  • OPC_GRID_STYLE_SOLID

The graphics color symbolic constants listed below are used to indicate color preferences for objects or object sub-components. These constants are usually assigned to the color attribute of objects. The following objects support this attribute:

  • network model (satellite node, mobile node, simplex point-to-point link, duplex point-to-point link, bus link, bus tap)
  • node model (stream, statistic wire)
  • external system definition (esys interface)
  • process model (transition)

In addition, network model subnets support the color attributes outline color and grid color.

Table 143: Graphics Color Symbolic Constants

  • OPC_GFX_COLOR_BEIGE
  • OPC_GFX_COLOR_BLACK
  • OPC_GFX_COLOR_BLUE
  • OPC_GFX_COLOR_BRICK
  • OPC_GFX_COLOR_BROWN
  • OPC_GFX_COLOR_CORN
  • OPC_GFX_COLOR_CYAN¹
  • OPC_GFX_COLOR_FUCHSIA
  • OPC_GFX_COLOR_GREEN
  • OPC_GFX_COLOR_GREY
  • OPC_GFX_COLOR_MAGENTA
  • OPC_GFX_COLOR_MAROON
  • OPC_GFX_COLOR_OLIVE
  • OPC_GFX_COLOR_ORANGE
  • OPC_GFX_COLOR_ORCHID
  • OPC_GFX_COLOR_PEACH
  • OPC_GFX_COLOR_PINK
  • OPC_GFX_COLOR_PLUM
  • OPC_GFX_COLOR_PURPLE
  • OPC_GFX_COLOR_RED
  • OPC_GFX_COLOR_SIENNA
  • OPC_GFX_COLOR_SLATE
  • OPC_GFX_COLOR_STEEL
  • OPC_GFX_COLOR_TAN
  • OPC_GFX_COLOR_TURQ¹
  • OPC_GFX_COLOR_VIOLET
  • OPC_GFX_COLOR_WHITE
  • OPC_GFX_COLOR_YELLOW

Note 1: CYAN and TURQ represent the same color value.

In addition to the named graphics color symbolic constants listed above, there is a set of defined symbolic constants for colors specified in terms of red, green, and blue (RGB) components. The graphic user interface (GUI) supports 64 different colors based on the 64 RGB permutations of 4 brightness levels per color (64 = 4 x 4 x 4). The format of the RGB-based symbolic constants is:

	OPC_GFX_COLOR_RGB<r><g><b>

where <r>, <g>, and <b> can take the values 0, 1, 2, and 3. The limiting cases in this format are black (OPC_GFX_COLOR_RGB000), and white (OPC_GFX_COLOR_RGB333).

The interrupt method symbolic constants listed below are used to specify the type of interrupt that will be caused by packet arrivals or statistic wire triggers. These constants can be assigned to the intrpt method attribute of the following object / model pairs:

  • stream objects in node models
  • statistic wire objects in node models.

From a modeling point of view, only some assignments of these constants have an effect. For instance, the interrupt method is ignored for streams with processor or queue sources, since these modules proactively set their own preference for interrupt method when sending packets. Also, the quiet interrupt method is ignored for statistic wires (the proper way to do this is to disable all triggers).

Table 144: Interrupt Method Symbolic Constants

  • OPC_INTRPT_METHOD_FORCED
  • OPC_INTRPT_METHOD_QUIET
  • OPC_INTRPT_METHOD_SCHED

The trigger symbolic constants listed below are used to specify which trigger flags are enabled on statistic wires. These constants can be assigned to the trigger attribute of statistics wire objects within node models. Since any combination of triggers is possible, each of the constants has a value which supports logical “OR-ing” of the constants to derive a composite value which can be assigned to an attribute. An example of this technique is shown in Figure 10. Note that if the OPC_TRIG_HIGH_THRESH or OPC_TRIG_LOW_THRESH flags are enabled, the statistic wire object attributes high thresh or low thresh should be assigned appropriate values.

Table 145: Statistic Wire Trigger Symbolic Constants

  • OPC_TRIG_FALLING_EDGE
  • OPC_TRIG_HIGH_THRESH
  • OPC_TRIG_LOW_THRESH
  • OPC_TRIG_REPEAT
  • OPC_TRIG_RISING_EDGE
  • OPC_TRIG_ZERO_CROSSING

Figure 10: Example Statistic Wire Trigger Attribute Assignment

Ema_Object_Attr_Set (mid, obid, "trigger", COMP_CONTENTS,
	OPC_TRIG_RISING_EDGE
	OPC_TRIG_FALLING_EDGE
	OPC_TRIG_REPEAT, EMAC_EOL);

The packet field type symbolic constants listed below are used to specify the type of a field within a packet format. These constants can be assigned to the type attribute of field objects within packet format models.

Table 146: Packet Field Type Symbolic Constants

  • OPC_PKF_TYPE_FLOATING POINT
  • OPC_PKF_TYPE_INFO
  • OPC_PKF_TYPE_INTEGER
  • OPC_PKF_TYPE_PACKET
  • OPC_PKF_TYPE_STRUCT

The packet encoding attribute symbolic constants listed below are used to specify the encoding within a packet format. These constants can be assigned to the encoding attribute of field objects within packet format models.

Table 147: Packet Encoding Attribute Symbolic Constants

  • OPC_PKF_ENCODING_BIGE
  • OPC_PKF_ENCODING_LITTLEE
  • OPC_PKF_ENCODING_SIGNED_BIGE
  • OPC_PKF_ENCODING_SIGNED_LITTLEE
  • OPC_PKF_ENCODING_UNSIGNED_BIGE
  • OPC_PKF_ENCODING_UNSIGNED_LITTLEE

The ICI attribute type symbolic constants listed below are used to specify the type of an attribute within an ICI. These constants can be assigned to the type attribute of attribute descriptor objects within ICI format models.

Table 148: ICI Attribute Type Symbolic Constants

  • OPC_ICA_TYPE_DOUBLE
  • OPC_ICA_TYPE_INTEGER
  • OPC_ICA_TYPE_STRUCT

The cartographic line type symbolic constants listed below are used to specify what a line in a cartographic data set represents. These constants can be assigned to the type attribute of line objects within cartographic data sets. Four line types are supported: national boundary; coast, island, or lake; river; and internal boundary.

Table 149: Cartographic Line Type Symbolic Constants

  • OPC_CDS_LINE_TYPE_COAST
  • OPC_CDS_LINE_TYPE_IBOUND
  • OPC_CDS_LINE_TYPE_NBOUND
  • OPC_CDS_LINE_TYPE_RIVER

The text size symbolic constants listed below are used to specify the size of text labels in cartographic data sets. These constants can be assigned to the text size attribute of cartographic objects (which are typically used as labels or to mark cities or other landmarks) within cartographic data sets.

Table 150: Text Size Symbolic Constants

  • OPC_TEXT_SIZE_LARGE
  • OPC_TEXT_SIZE_MEDIUM
  • OPC_TEXT_SIZE_SMALL

The interface description flags symbolic constants listed below are used to specify the options for an interface description. These constants can be assigned to the flags attribute of interface description objects. These flags map to the state of inheritance of limits, comments, default values, units, and value-restriction in symbol maps, in the interfaces for process, node, and link models.

Table 151: Interface Description Flags Symbolic Constants

  • OPC_ID_INHRT_COMMENTS
  • OPC_ID_INHRT_DEFVAL
  • OPC_ID_INHRT_LIMS
  • OPC_ID_INHRT_UNITS
  • OPC_ID_INHRT_VAL_RESTRICT

The properties object flags symbolic constants listed below are used to specify the options for a properties object. These constants can be assigned to the flags attribute of properties objects, and may be bitwise ORed to use more than one constant. In the node and process model domains, these flags map to the functions of the Edit Attributes dialog box. The LOWLIM operations map to the From value, the HILIM operations map to the To value, DEFV_AUTOASSIGN maps to the Autoassign default value checkbox, and SYM_VAL_RESTRICT maps to the Allow other values checkbox for symbol maps.

Table 152: Properties Object Flags Symbolic Constants

  • EMAC_DEFV_AUTOASSGN
  • EMAC_HILIM_EXCLU
  • EMAC_HILIM_SET
  • EMAC_LOWLIM_EXCLU
  • EMAC_LOWLIM_SET
  • EMAC_SYM_VAL_RESTRICT

The attribute assignment operation symbolic constants listed below are used to specify the type of operation for an attribute assignment. These constants can be assigned to the operation attribute of attribute assignment objects. In the model domain, the IGNORE operation maps to the “promoted” assignment, SET maps to “set”, and SUPPRESS maps to “hidden”.

Table 153: Attribute Assignment Operation Symbolic Constants

  • OPC_AA_IGNORE
  • OPC_AA_SET
  • OPC_AA_SUPPRESS

The output vector type symbolic constants listed below are used to specify whether an output vector is enumerated. These constants are assigned to the type attribute of the output vector object. If type is assigned the value OPC_OV_TYPE_VECTOR_ENUM, an output vector dictionary file must be specified in the enum dictionary attribute.

Table 154: Output Vector Type Symbolic Constants

  • OPC_OV_TYPE_VECTOR_DOUBLE
  • OPC_OV_TYPE_VECTOR_ENUM

The output vector subelement type symbolic constants listed below are used to specify the subelement options for an output vector. These constants can be assigned to the type attribute of output vector objects. Objects of type OBJ_OV_VECTOR must have type values of either VECTOR_DOUBLE or ENUM. All other values can be used only with OBJ_OV_ELEMENT objects.

Table 155: Output Vector Subelement Type Symbolic Constants

  • OPC_OV_TYPE_OBJECT
  • OPC_OV_TYPE_STAT_GROUP
  • OPC_OV_TYPE_STATISTIC
  • OPC_OV_TYPE_TOP_ELEMENT
  • OPC_OV_TYPE_VECTOR_DOUBLE
  • OPC_OV_TYPE_VECTOR_ENUM

The output vector drawing style symbolic constants listed below are used to specify the drawing style options for an output vector. These constants can be assigned to the drawing style attribute of output vector objects.

Table 156: Output Vector Drawing Style Symbolic Constants

  • OPC_OV_DRAW_STYLE_BAR
  • OPC_OV_DRAW_STYLE_DISCRETE
  • OPC_OV_DRAW_STYLE_LINEAR
  • OPC_OV_DRAW_STYLE_NONE
  • OPC_OV_DRAW_STYLE_SAMPHOLD
  • OPC_OV_DRAW_STYLE_SQR_WAVE

The output vector threshold mode symbolic constants listed below are used to specify the threshold mode options for an output vector. These constants can be assigned to the threshold mode attribute of output vector objects.

Table 157: Output Vector Threshold Mode Symbolic Constants

  • OPC_OV_THRESHOLD_MODE_GE
  • OPC_OV_THRESHOLD_MODE_GT
  • OPC_OV_THRESHOLD_MODE_LE
  • OPC_OV_THRESHOLD_MODE_LT
  • OPC_OV_THRESHOLD_MODE_NONE

The output vector time unit symbolic constants listed below are used to specify the time unit options for an output vector. These constants can be assigned to the time unit attribute of output vector objects.

Table 158: Output Vector Time Unit Symbolic Constants

  • OPC_OV_TIME_UNITS_GENERIC
  • OPC_OV_TIME_UNITS_MONTHS
  • OPC_OV_TIME_UNITS_SECONDS

The self description comparator symbolic constants listed below are used to specify the comparator value of a required self description. These constants can be assigned to the comparator attribute of required self description objects. Five types are supported: equals, one of, range, contains, and count.

Table 159: Self Description Comparator Symbolic Constants

  • OPC_SELFDESC_CMP_CONTAINS
  • OPC_SELFDESC_CMP_COUNT
  • OPC_SELFDESC_CMP_EQUALS
  • OPC_SELFDESC_CMP_ONEOF
  • OPC_SELFDESC_CMP_RANGE

The self description assignment type symbolic constants listed below are used to specify the type value of an assigned self description. These constants can be assigned to the type attribute of assigned self description objects. Three types are supported: constant, characteristic, and value.

Table 160: Self Description Assignment Type Symbolic Constants

  • OPC_SELFDESC_ASSGN_CHARACTERISTIC
  • OPC_SELFDESC_ASSGN_CONST
  • OPC_SELFDESC_ASSGN_VALUE

The project traffic growth time unit symbolic constants listed below are used to specify the time unit of traffic growth data. These constants can be assigned to the time units attribute of long term study (traffic growth) objects.

Table 161: Project Traffic Growth Time Unit Symbolic Constants

  • OPC_PJ_TIME_UNITS_DAYS
  • OPC_PJ_TIME_UNITS_HOURS
  • OPC_PJ_TIME_UNITS_MINUTES
  • OPC_PJ_TIME_UNITS_MONTHS
  • OPC_PJ_TIME_UNITS_SECONDS
  • OPC_PJ_TIME_UNITS_WEEKS
  • OPC_PJ_TIME_UNITS_YEARS

The project traffic growth result storage method symbolic constants listed below are used to specify the method used to store traffic growth data. These constants can be assigned to the result storage method attribute of long term study (traffic growth) objects.

Table 162: Project Traffic Growth Result Storage Method Symbolic Constants

  • OPC_PJ_RESULT_STORE_EACH_SIMULATION
  • OPC_PJ_RESULT_STORE_SUMMARY_ONLY

The project traffic growth import options symbolic constants listed below are used to specify what to import during a long term study. These constants can be assigned to the import options attribute of long term study (traffic growth) objects.

Table 163: Project Traffic Growth Import Options Symbolic Constants

  • OPC_PJ_IMPORT_NETWORK_AND_TRAFFIC
  • OPC_PJ_IMPORT_NOTHING
  • OPC_PJ_IMPORT_TRAFFIC

The project traffic growth method symbolic constants listed below are used to specify the method used to calculate traffic growth. These constants can be assigned to the growth method attribute of long term study (traffic growth) objects.

Table 164: Project Traffic Growth Method Symbolic Constants

  • OPC_PJ_GROWTH_COMPOUND_BY_TABLE
  • OPC_PJ_GROWTH_REGULAR_COMPOUND
  • OPC_PJ_GROWTH_REGULAR_SIMPLE
  • OPC_PJ_GROWTH_SIMPLE_BY_TABLE

The external system interface type symbolic constants listed below are used to specify the data type assigned to an external system interface. These constants can be assigned to the type attribute of esys interface objects.

Table 165: External System Interface Type Symbolic Constants

  • OPC_ESYS_TYPE_BIT
  • OPC_ESYS_TYPE_BOOLEAN
  • OPC_ESYS_TYPE_CHARACTER
  • OPC_ESYS_TYPE_DOUBLE
  • OPC_ESYS_TYPE_INTEGER
  • OPC_ESYS_TYPE_POINTER
  • OPC_ESYS_TYPE_STDLOGIC
  • OPC_ESYS_TYPE_STRING
  • OPC_ESYS_TYPE_UNDEFINED

The external system interface direction symbolic constants listed below are used to specify the data type assigned to an external system interface. These constants can be assigned to the direction attribute of esys interface objects.

Table 166: External System interface Direction Symbolic Constants

  • OPC_ESYS_DIR_IN
  • OPC_ESYS_DIR_INOUT
  • OPC_ESYS_DIR_NC
  • OPC_ESYS_DIR_OUT