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_DEGOPC_GRID_UNIT_FOOTOPC_GRID_UNIT_KILOMETEROPC_GRID_UNIT_METEROPC_GRID_UNIT_MILEOPC_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_DASHEDOPC_GRID_STYLE_NONEOPC_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_BEIGEOPC_GFX_COLOR_BLACKOPC_GFX_COLOR_BLUEOPC_GFX_COLOR_BRICKOPC_GFX_COLOR_BROWNOPC_GFX_COLOR_CORNOPC_GFX_COLOR_CYAN¹OPC_GFX_COLOR_FUCHSIAOPC_GFX_COLOR_GREENOPC_GFX_COLOR_GREYOPC_GFX_COLOR_MAGENTAOPC_GFX_COLOR_MAROONOPC_GFX_COLOR_OLIVEOPC_GFX_COLOR_ORANGEOPC_GFX_COLOR_ORCHIDOPC_GFX_COLOR_PEACHOPC_GFX_COLOR_PINKOPC_GFX_COLOR_PLUMOPC_GFX_COLOR_PURPLEOPC_GFX_COLOR_REDOPC_GFX_COLOR_SIENNAOPC_GFX_COLOR_SLATEOPC_GFX_COLOR_STEELOPC_GFX_COLOR_TANOPC_GFX_COLOR_TURQ¹OPC_GFX_COLOR_VIOLETOPC_GFX_COLOR_WHITEOPC_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_FORCEDOPC_INTRPT_METHOD_QUIETOPC_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_EDGEOPC_TRIG_HIGH_THRESHOPC_TRIG_LOW_THRESHOPC_TRIG_REPEATOPC_TRIG_RISING_EDGEOPC_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 POINTOPC_PKF_TYPE_INFOOPC_PKF_TYPE_INTEGEROPC_PKF_TYPE_PACKETOPC_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_BIGEOPC_PKF_ENCODING_LITTLEEOPC_PKF_ENCODING_SIGNED_BIGEOPC_PKF_ENCODING_SIGNED_LITTLEEOPC_PKF_ENCODING_UNSIGNED_BIGEOPC_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_DOUBLEOPC_ICA_TYPE_INTEGEROPC_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_COASTOPC_CDS_LINE_TYPE_IBOUNDOPC_CDS_LINE_TYPE_NBOUNDOPC_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_LARGEOPC_TEXT_SIZE_MEDIUMOPC_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_COMMENTSOPC_ID_INHRT_DEFVALOPC_ID_INHRT_LIMSOPC_ID_INHRT_UNITSOPC_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_AUTOASSGNEMAC_HILIM_EXCLUEMAC_HILIM_SETEMAC_LOWLIM_EXCLUEMAC_LOWLIM_SETEMAC_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_IGNOREOPC_AA_SETOPC_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_DOUBLEOPC_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_OBJECTOPC_OV_TYPE_STAT_GROUPOPC_OV_TYPE_STATISTICOPC_OV_TYPE_TOP_ELEMENTOPC_OV_TYPE_VECTOR_DOUBLEOPC_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_BAROPC_OV_DRAW_STYLE_DISCRETEOPC_OV_DRAW_STYLE_LINEAROPC_OV_DRAW_STYLE_NONEOPC_OV_DRAW_STYLE_SAMPHOLDOPC_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_GEOPC_OV_THRESHOLD_MODE_GTOPC_OV_THRESHOLD_MODE_LEOPC_OV_THRESHOLD_MODE_LTOPC_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_GENERICOPC_OV_TIME_UNITS_MONTHSOPC_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_CONTAINSOPC_SELFDESC_CMP_COUNTOPC_SELFDESC_CMP_EQUALSOPC_SELFDESC_CMP_ONEOFOPC_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_CHARACTERISTICOPC_SELFDESC_ASSGN_CONSTOPC_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_DAYSOPC_PJ_TIME_UNITS_HOURSOPC_PJ_TIME_UNITS_MINUTESOPC_PJ_TIME_UNITS_MONTHSOPC_PJ_TIME_UNITS_SECONDSOPC_PJ_TIME_UNITS_WEEKSOPC_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_SIMULATIONOPC_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_TRAFFICOPC_PJ_IMPORT_NOTHINGOPC_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_TABLEOPC_PJ_GROWTH_REGULAR_COMPOUNDOPC_PJ_GROWTH_REGULAR_SIMPLEOPC_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_BITOPC_ESYS_TYPE_BOOLEANOPC_ESYS_TYPE_CHARACTEROPC_ESYS_TYPE_DOUBLEOPC_ESYS_TYPE_INTEGEROPC_ESYS_TYPE_POINTEROPC_ESYS_TYPE_STDLOGICOPC_ESYS_TYPE_STRINGOPC_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_INOPC_ESYS_DIR_INOUTOPC_ESYS_DIR_NCOPC_ESYS_DIR_OUT