Models, Objects, and Attributes
This section documents the Riverbed analysis software models, objects, and attributes that are supported via the Ema package. Models, objects, and attributes each have a unique symbolic constant (or string) that identifies them in calls to the EMA functions documented in the previous section. The sets of symbolic constants and strings are listed in tables within this section. For attributes, the core types and type modifiers are also listed.
Note: Models, objects, and attributes that are added by optional functionality are described in the documentation for that functionality. For example, mobile node and subnet objects are described in the Wireless documentation.
Some of the objects and attributes have names that might be unfamiliar to users of Riverbed analysis software because they represent data that is transparently managed by the application's graphical tools. For instance, most of the models have a position object that is used to specify the position on the screen at which an icon or other graphical item should be drawn. This data is not explicitly entered by the user because it is captured implicitly via the position of the mouse. However, in an EMA-based application, the data must be explicitly referenced and assigned.
In addition, some object types have redundant attributes. These are attributes that provide compatibility across various software releases. There are two kinds of redundant attributes:
- An attribute that appears on more than one object type.
- Multiple attributes that appear on the same object type and specify the same information.
Redundant attributes allow an EMA application developed under one release to be used with another release when Ema_Init() is called with the EMAC_MODE_REL_<nn> flag, as described in Ema_Init(). For example, the subnet object has some redundant attributes (such as grid style) that belong to and are described with the subnet view object in the current release, but which belonged to the subnet object in an earlier release.
Redundant attributes may become visible when you generate EMA code and can be accessed by functions such as Ema_Object_Print() and Ema_Model_Attr_Get(). However, only attributes that correspond to the release specified by the EMAC_MODE_REL_<nn> flag have actual values that are updated as the model runs.
Symbolic Constants
The following table lists symbolic constants that appear as special values in the attribute tables forming the remainder of this section.
Table 10: Special Attribute Values
| Meaning | Symbolic Constant |
|---|---|
| disabled toggle | EMAC_DISABLED |
| enabled toggle | EMAC_ENABLED |
| "infinite" double-precision value | EMAC_DBL_INFINITY |
| unassigned object ID | EMAC_NULL_OBJ_ID |
EMA Model Types
The following table lists the symbolic constants that identify each model type supported by EMA.
Table 11: Riverbed Models
| Model Type | Symbolic Constant |
|---|---|
| project model | MOD_PROJECT |
| network model | MOD_NETWORK |
| node model | MOD_NODE |
| process model | MOD_PROCESS |
| external system definition | MOD_ESD |
| link model | MOD_LINK |
| path model | MOD_PATH |
| demand model | MOD_DEMAND |
| traffic model | MOD_TRAFFIC |
MOD_PDF |
|
| packet format | MOD_PK_FORMAT |
| ICI format | MOD_ICI_FORMAT |
| probe list | MOD_PROBES |
| web report probe list | MOD_REPORT_PROBES |
| SLA report probe list | MOD_SLA_PROBES |
| simulation sequence | MOD_SIM_SEQ |
| output vector | MOD_OUTVECTORS |
| output scalar | MOD_OUTSCALARS |
| cartographic data set | MOD_CARTO |
| public attribute description model | MOD_PUB_AD |
| derived node model | MOD_DER_NODE |
| derived link model | MOD_DER_LINK |
| derived path model | MOD_DER_PATH |
| derived demand model | MOD_DER_DEMAND |
Project Model
Table 12: Project Objects
| Object Type | Symbolic Constant |
|---|---|
| scenario | OBJ_PJ_SCENARIO |
| scenario import state | OBJ_PJ_SCENARIO_IMPORT_STATE |
| traffic growth data | OBJ_PJ_SCENARIO_LONG_TERM_STUDY |
Table 13: Project Model Attributes
| Name | Type | Default |
|---|---|---|
scenario |
object ID¹ |
|
current scenario |
integer |
0 |
Note 1: array of object IDs of scenario objects
Table 14: Scenario Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
"unnamed" |
import state |
object ID¹ |
|
long term study |
object ID² |
Note 1: ID of scenario import state object. Note 2: ID of traffic growth object
Table 15: Scenario Import State Object Attributes
| Name | Type | Default |
|---|---|---|
server name |
string |
"localhost" |
subnet name |
string |
|
aggregation |
integer |
0 |
repair flag |
toggle |
EMAC_ENABLED |
icons flag |
toggle |
EMAC_DISABLED |
max per hub flag |
toggle |
EMAC_DISABLED |
max per switch flag |
toggle |
EMAC_DISABLED |
max per hub |
integer |
0 |
max per switch |
integer |
0 |
Table 16: Traffic Growth Object Attributes
| Name | Type | Default |
|---|---|---|
number of simulations |
integer |
1 |
time units |
integer¹ |
OPC_PJ_TIME_UNITS_SECONDS |
time between simulations |
double |
1.0 |
start time |
string |
|
start date |
string |
|
result storage method |
integer² |
OPC_PJ_RESULT_STORE_EACH_SIMULATION |
import options |
integer³ |
OPC_PJ_IMPORT_NOTHING |
growth method |
integer⁴ |
OPC_PJ_GROWTH_REGULAR_SIMPLE |
growth rate |
double |
10.0 |
growth table |
double vector |
Note 1: symbolic constant values for this attribute appear in Table 162 Project Traffic Growth Result Storage Method Symbolic Constants. Note 2: symbolic constant values for this attribute appear in Table 162 Project Traffic Growth Result Storage Method Symbolic Constants. Note 3: symbolic constant values for this attribute appear in Table 163 Project Traffic Growth Import Options Symbolic Constants. Note 4: symbolic constant values for this attribute appear in Table 164 Project Traffic Growth Method Symbolic Constants.
Network Model
Table 17: Network Objects
| Object Type | Symbolic Constant |
|---|---|
| annotation view rectangle | OBJ_NT_ANNOT_VIEW_RECT |
| annotation, line | OBJ_NT_ANNOT_LINE |
| annotation, shape | OBJ_NT_ANNOT_SHAPE |
| annotation, text | OBJ_NT_ANNOT_TEXT |
| attribute assignment | OBJ_NT_ATTR_ASSGN |
| bus link | OBJ_NT_BU_LINK |
| bus tap | OBJ_NT_TAP |
| demand | OBJ_NT_DEMAND |
| interface description | OBJ_NT_INTF_DESC |
| node, fixed | OBJ_NT_NODE_FIXED |
| path | OBJ_NT_PATH |
| point-to-point link, duplex | OBJ_NT_PTDUP_LINK |
| point-to-point link, simplex | OBJ_NT_PTSIMP_LINK |
| position | OBJ_NT_POS |
| subnet | OBJ_NT_SUBNET |
| subnet view | OBJ_NT_SUBNET_VIEW |
| subnet, fixed | OBJ_NT_SUBNET_FIX |
| view path | OBJ_NT_VIEW_PATH |
| view position | OBJ_NT_VIEW_POS |
Table 18: Network Model Attributes
| Name | Type | Default |
|---|---|---|
ext fileset |
textlist¹ |
|
keywords list |
textlist |
|
view subnet |
object ID² |
|
tmm propagation models |
array of object IDs³ |
|
iso elev map color levels |
array of object IDs⁴ |
|
iso elev map label color |
integer |
1 |
Note 1: Names of external object files. Note 2: object ID of object that represents the subnet currently in view. Note 3: object IDs of type Nt_Tmm_Propagation_Model_Config. Note 4: object IDs of type Nt_Iso_Elev_Map_Color_Settings.
Table 19: Position Object Attributes
| Name | Type | Default |
|---|---|---|
x |
set-required double |
|
y |
set-required double |
Table 20: Interface Description Object Attributes
| Name | Type | Default |
|---|---|---|
promotion name |
set-required string¹ |
|
merged names |
set-required textlist² |
|
flags |
integer³ |
0 |
properties |
object ID⁴ |
|
suppressed symbols |
textlist⁵ |
(empty) |
type |
integer⁶ |
-1 |
Note 1: New name of attribute if a rename/merge is being represented; original attribute name otherwise.
Note 2: List of pre-rename attribute names if a rename/merge is being represented; original attribute name otherwise.
Note 3: A combination of some of the following: OPC_ID_INHRT_LIMS, OPC_ID_INHRT_VAL_RESTRICT, OPC_ID_INHRT_COMMENTS, OPC_ID_INHRT_DEFVAL, and OPC_ID_INHRT_UNITS.
Note 4: object ID of properties object.
Note 5: textlist containing names of suppressed symbols.
Note 6: valid types are EMAC_INTEGER, EMAC_DOUBLE, EMAC_STRING, EMAC_TOGGLE, EMAC_TOGGLE_DOUBLE, EMAC_COMPOUND, or EMAC_DATAFILE.
Table 21: Attribute Assignment Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
operation |
integer¹ |
|
value |
poly² |
|
type |
integer³ |
-1 |
Note 1: Assignment operation constant (one of OPC_AA_IGNORE, OPC_AA_SET, or OPC_AA_SUPPRESS).
Note 2: value type determined at run time and must correspond to the type specified by the type attribute.
Note 3: valid types are EMAC_INTEGER, EMAC_DOUBLE, EMAC_STRING, EMAC_TOGGLE, EMAC_TOGGLE_DOUBLE, EMAC_COMPOUND, or EMAC_DATAFILE.
Table 22: Fixed Subnet Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
attribute promotion |
toggle |
Enabled | |
name |
set-required string |
||
priority |
integer |
0 | |
user id |
integer |
0 | |
x position |
longitude |
double |
0.0 (subnet grid unit) |
y position |
latitude |
double |
0.0 (subnet grid unit) |
threshold |
double |
0.0 (pixels/s.g.u.) | |
map |
string |
"NONE" | |
icon name |
icon |
string¹ |
"fixed subnet" |
outline color |
integer² |
OPC_GFX_COLOR_RGB003 |
|
grid unit |
integer³ |
OPC_GRID_UNIT_NONE |
|
subnet |
object ID⁴ |
||
view stack |
object ID⁵ |
||
doc file |
string |
"nt_subnet_fix" | |
iso-elev-map list |
textlist |
||
iso-elev-map line threshold |
double |
0.0 |
Note 1: name of icon in an icon database.
Note 2: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants.
Note 3: symbolic constant values for this attribute appear in Table 141 Grid Unit Symbolic Constants.
Note 4: object ID of surrounding subnet object; set to EMAC_NULL_OBJ_ID if no surrounding subnet (i.e., object is top-level subnet with name attribute set to "top").
Note 5: object IDs of subnet view objects.
Table 23: Fixed Node Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
set-required string |
||
model |
set-required string¹ |
||
user id |
integer |
0 | |
x position |
double |
0.0 (subnet grid unit) | |
y position |
double |
0.0 (subnet grid unit) | |
altitude |
double |
0.0 (subnet grid unit) | |
priority |
integer |
0 | |
condition |
toggle |
EMAC_ENABLED |
|
threshold |
double |
0.0 (pixels/s.g.u.) | |
icon name |
icon |
string |
"fixed_comm" |
subnet |
set-required object ID² |
||
doc file |
string |
"nt_node" | |
alias |
array of strings |
||
tooltip |
string |
"" |
Note 1: name of node model, without suffix. Note 2: object ID of surrounding subnet object.
Table 24: Simplex Point-to-Point Link Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
model |
string¹ |
"pt_base" | |
channel count |
integer |
1 | |
transmitter |
source tx |
string² |
|
receiver |
dest rx |
string² |
|
data rate |
double |
1024.0 | |
packet formats |
textlist³ |
OPC_NT_LINK_ALLPKS |
|
delay |
double |
0.0 (sec) | |
ber |
double |
0.0 (err/bit) | |
condition |
toggle |
EMAC_ENABLED |
|
user id |
integer |
0 | |
cost |
double |
0.0 | |
txdel model |
string⁴ |
"dpt_txdel" | |
propdel model |
string⁴ |
"dpt_propdel" | |
error model |
string⁴ |
"dpt_error" | |
ecc model |
string⁴ |
"dpt_ecc" | |
source site |
source node |
set-required object ID⁵ |
|
dest site |
dest node |
set-required object ID⁵ |
|
path |
array of object IDs⁶ |
||
color |
gfx color |
integer⁷ |
OPC_GFX_COLOR_RGB233 |
subnet |
object ID⁸ |
||
doc file |
string |
"nt_link" | |
tooltip |
string |
"" |
Note 1: name of node model, without suffix. Note 2: hierarchical name of connected point-to-point transceiver; formatted as:[<subnet_ name(s)>.]<node_name>.<module_name>Dot-separated subnet names only appear in the hierarchical name if the link is directly connected to a subnet containing the transceiver; otherwise the hierarchical name only consists of node and module names. Note 3: textlist containing names of packet formats this link can transmit. Note 4: name of Transceiver Pipeline Stage object code file, without suffix. Note 5: object ID of directly connected subnet or fixed node object. Note 6: object IDs of position objects that define link path. Note 7: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants. Note 8: object ID of surrounding subnet object.
Table 25: Duplex Point-to-Point Link Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
model |
string¹ |
"pt_base" | |
channel count |
integer |
1 | |
transmitter a |
string² |
||
transmitter b |
string b |
||
receiver a |
string |
||
receiver b |
string |
||
data rate |
double |
1024.0 | |
packet formats |
textlist³ |
OPC_NT_LINK_ALLPKS |
|
delay |
double |
0.0 (sec) | |
ber |
double |
0.0 (err/bit) | |
condition |
toggle |
EMAC_ENABLED |
|
user id |
integer |
0 | |
cost |
double |
0.0 | |
txdel model |
string⁴ |
"dbu_txdel" | |
propdel model |
string⁴ |
"dbu_propdel" | |
error model |
string⁴ |
"dpt_error" | |
ecc model |
string⁴ |
"dpt_ecc" | |
site a |
set-required object ID⁵ |
||
site b |
set-required object ID⁵ |
||
path |
array of object IDs⁶ |
||
color |
gfx color |
integer⁷ |
OPC_GFX_COLOR_WHITE |
subnet |
object ID⁸ |
||
doc file |
string |
"nt_link" | |
tooltip |
string |
"" |
Note 1: name of node model, without suffix. Note 2: hierarchical name of connected point-to-point transceiver; formatted as: [<subnet_ name(s)>.]<node_name>.<module_name>Dot-separated subnet names only appear in the hierarchical name if the link is directly connected to a subnet containing the transceiver; otherwise the hierarchical name only consists of node and module names. Note 3: textlist containing names of packet formats this link can transmit. Note 4: name of Transceiver Pipeline Stage object code file, without suffix. Note 5: object ID of directly connected subnet or fixed node object. Note 6: object IDs of position objects that define link path. Note 7: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants. Note 8: object ID of surrounding subnet object.
Table 26: Bus Link Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
model |
string¹ |
"bu_adv" |
channel count |
integer |
1 |
data rate |
double |
1024.0 |
packet formats |
textlist² |
(empty) |
delay |
double |
0.0 (sec/m) |
ber |
double |
0.0 (err/bit) |
condition |
toggle |
EMAC_ENABLED |
user id |
integer |
0 |
cost |
double |
0.0 |
txdel model |
string³ |
"dbu_txdel" |
closure model |
string³ |
"dbu_closure" |
propdel model |
string³ |
"dbu_propdel" |
coll model |
string³ |
"dbu_coll" |
error model |
string³ |
"dbu_error" |
ecc model |
string³ |
"dbu_ecc" |
color |
integer⁴ |
OPC_GFX_COLOR_RGB023 |
subnet |
set-required object ID⁵ |
|
path |
array of object IDs⁶ |
|
doc file |
string |
"nt_bus" |
tooltip |
string |
"" |
Note 1: name of node model, without suffix. Note 2: textlist containing names of packet formats this link can transmit. Note 3: name of Transceiver Pipeline Stage stage model, without suffix. Note 4: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants. Note 5: object ID of surrounding subnet object. Note 6: object IDs of position objects that define link path.
Table 27: Bus Tap Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
model |
string¹ |
"tp_adv" | |
transmitter |
source tx |
string² |
|
receiver |
dest rx |
string² |
|
condition |
toggle |
EMAC_ENABLED |
|
user id |
integer |
0 | |
cost |
double |
0.0 | |
color |
gfx color |
integer³ |
OPC_GFX_COLOR_GREY |
site |
node |
set-required object ID⁴ |
|
path |
array of object IDs⁵ |
||
bus |
object ID⁶ |
||
subnet |
object ID⁷ |
||
doc file |
string |
"nt_bus_tap" | |
tooltip |
string |
"" |
Note 1: name of node model, without suffix. Note 2: hierarchical name of connected bus transceiver; formatted as: [<subnet_ name(s)>.]<node_name>.<module_name>Dot-separated subnet names only appear in the hierarchical name if the link is directly connected to a subnet containing the transceiver; otherwise the hierarchical name only consists of node and module names. Note 3: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants. Note 4: object ID of directly connected subnet or fixed node object. Note 5: object IDs of position objects that define tap path. Note 6: object ID of directly connected bus link object. Note 7: object ID of surrounding subnet object.
Table 28: Subnet View Object Attributes
| Name | Type | Default |
|---|---|---|
min x |
double |
-180.0 |
min y |
double |
90.0 |
sbar x |
double |
0.0 |
sbar y |
double |
0.0 |
grid step |
double |
15.0 |
resolution |
double |
2.5 |
grid style |
integer |
OPC_GRID_STYLE_NONE |
grid color |
integer |
OPC_GFX_COLOR_RGB111 |
Table 29: Shape Annotation Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
NULL |
shape |
integer |
0 |
fill |
toggle |
EMAC_DISABLED |
color |
color |
RED |
x position |
double |
0.0 |
y position |
double |
0.0 |
width |
double |
0.0 |
height |
double |
0.0 |
subnet |
object ID¹ |
Note 1: object ID of surrounding subnet object.
Table 30: Line Annotation Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
NULL |
color |
color |
BLUE |
drawing style |
integer |
0 |
line style |
integer |
0 |
head arrow |
toggle |
EMAC_DISABLED |
tail arrow |
toggle |
EMAC_DISABLED |
thickness |
double |
1.0 |
path |
array of object IDs¹ |
|
subnet |
object ID² |
Note 1: object IDs of position objects that define line path. Note 2: object ID of surrounding subnet object.
Table 31: Text Annotation Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
NULL |
text |
color |
NULL |
color |
color |
YELLOW |
font |
integer |
1 |
justification |
toggle |
0 |
x position |
double |
0.0 |
y position |
double |
0.0 |
width |
double |
0.0 |
height |
double |
0.0 |
subnet |
object ID¹ |
Note 1: object ID of surrounding subnet object.
Self Description
Table 32: Self Description Objects
| Object Type | Symbolic Constant |
|---|---|
| required self description | OBJ_SELFDESC_REQ |
| assigned self description | OBJ_SELFDESC_ASSGN |
| core self description | OBJ_SELFDESC_CORE |
| node self description | OBJ_SELFDESC_PORTGROUP |
Table 33: Required Self Description Object Attributes
| Name | Type | Default |
|---|---|---|
characteristic |
string |
"" |
comparator |
integer¹ |
OPC_SELFDESC_CMP_EQUALS |
value |
string |
"" |
Note 1: symbolic constant values for this attribute appear in Table 159 Self Description Comparator Symbolic Constants.
Table 34: Assigned Self Description Object Attributes
| Name | Type | Default |
|---|---|---|
attribute |
string |
"" |
type |
integer¹ |
OPC_SELFDESC_ASSGN_CONST |
value |
string |
"" |
requirements |
array of object IDs² |
"" |
assignments |
array of object IDs³ |
OPC_SELFDESC_ASSGN_CONST |
priority |
integer |
0 |
Note 1: symbolic constant values for this attribute appear in Table 160 Self Description Assignment Type Symbolic Constants. Note 2: object IDs of required self descriptions. Note 3: object IDs of assigned self descriptions.
Table 35: Portgroup Self Description Object Attributes
| Name | Type | Default |
|---|---|---|
portgroup core |
object IDs¹ |
|
lower range |
integer |
0 |
upper range |
integer |
0 |
receiver |
string |
"" |
transmitter |
string |
"" |
padding |
integer |
0 |
Note 1: object ID of core self description object.
Node Model
Table 36: Node Objects
| Object Type | Symbolic Constant |
|---|---|
| position | OBJ_ND_POS |
| interface description | OBJ_ND_INTF_DESC |
| attribute assignment | OBJ_ND_ATTR_ASSGN |
| processor | OBJ_ND_PROCESSOR |
| queue | OBJ_ND_QUEUE |
| external system module | OBJ_ND_ESYS |
| point-to-point transmitter | OBJ_ND_PT_TX |
| point-to-point receiver | OBJ_ND_PT_RX |
| bus transmitter | OBJ_ND_BU_TX |
| bus receiver | OBJ_ND_BU_RX |
| subqueue | OBJ_ND_SUBQ |
| pt.-to-pt. trans. channel | OBJ_ND_PT_TXCH |
| pt.-to-pt. rec. channel | OBJ_ND_PT_RXCH |
| bus transmitter channel | OBJ_ND_BU_TXCH |
| bus receiver channel | OBJ_ND_BU_RXCH |
| stream | OBJ_ND_STRM |
| statistics wire | OBJ_ND_STATWIRE |
| statistic interface description | OBJ_ND_STAT_INTF |
| logical association | OBJ_ND_ASSOC |
| external system | OBJ_ND_ESYS |
| shape annotation | OBJ_ND_ANNOT_SHAPE |
| line annotation | OBJ_ND_ANNOT_LINE |
| text annotation | OBJ_ND_ANNOT_TEXT |
| ETS handler function | OBJ_ND_ETS_HANDLER |
| annotation icon | OBJ_ND_ANNOT_ICON |
Table 37: Node Model Attributes
| Name | Type | Default |
|---|---|---|
stat intf descs |
array of object IDs¹ |
|
interface descriptions |
array of object IDs² |
|
attribute assignments |
array of object IDs³ |
|
model comments |
textlist⁴ |
(empty) |
keywords |
textlist⁵ |
(empty) |
fixed icon |
string⁶ |
(empty) |
mobile icon |
string⁶ |
(empty) |
satellite icon |
string⁶ |
(empty) |
doc file |
string |
(empty) |
tooltip |
string |
(empty) |
grid step |
double |
0.0 |
grid style |
integer |
0 |
grid color |
color |
OPC_GFX_COLOR_BLACK |
axis style |
integer |
0 |
axis color |
color |
OPC_GFX_COLOR_BLUE |
target style |
integer |
0 |
target color |
color |
OPC_GFX_COLOR_RED |
width |
integer |
100.0 |
resolution |
double |
20.0 |
center x |
double |
0.0 |
center y |
double |
0.0 |
center z |
double |
0.0 |
Note 1: object IDs of interface description objects for statistics. Note 2: object IDs of interface description objects for the model. Note 3: object IDs of attribute assignment objects. Note 4: textlist containing description of model. Note 5: textlist containing keywords (one per line) used in palette. Note 6: name of icon to use for this type of node.
Table 38: Position Object Attributes
| Name | Type | Default |
|---|---|---|
x |
set-required double |
|
y |
set-required double |
Table 39: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 40: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Table 41: Processor Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set-required string |
|
process model |
string¹ |
"sink" |
intrpt interval |
toggle double² |
(disabled) |
begsim intrpt |
toggle |
EMAC_DISABLED |
endsim intrpt |
toggle |
EMAC_DISABLED |
failure intrpts |
string³ |
"disabled" |
recovery intrpts |
string³ |
"disabled" |
icon name |
string⁴ |
"processor" |
position |
object ID⁵ |
|
priority |
integer |
0 |
super priority |
toggle |
EMAC_DISABLED |
doc file |
string |
"nd_module" |
Note 1: name of process model, without suffix. Note 2: in units of seconds. Note 3: valid values: "disabled", "local only", and "model wide". Note 4: name of icon in an icon database. Note 5: object ID of position object.
Table 42: Queue Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set-required string |
|
subqueue |
object ID¹ |
|
process model |
string² |
"pc_fifo" |
intrpt interval |
toggle double³ |
(disabled) |
begsim intrpt |
toggle |
EMAC_DISABLED |
endsim intrpt |
toggle |
EMAC_DISABLED |
failure intrpts |
string⁴ |
"disabled" |
recovery intrpts |
string⁴ |
"disabled" |
icon name |
string⁵ |
"queue" |
position |
object ID⁶ |
|
priority |
integer |
0 |
super priority |
toggle |
EMAC_DISABLED |
doc file |
string |
"nd_module" |
Note 1: object ID of subqueue compound value object. The subqueue compound value object is an EMA base object, containing the list and count attributes. Sub-objects named by list are subqueue compound objects described below. Note 2: name of process model, without suffix. Note 3: in units of seconds. Note 4: valid values: "disabled", "local only", and "model wide". Note 5: name of icon in an icon database. Note 6: object ID of position object.
Table 43: Subqueue Compound Object Attributes
| Name | Type | Default |
|---|---|---|
pk capacity |
double |
EMAC_DBL_INFINITY (pks) |
bit capacity |
double |
EMAC_DBL_INFINITY (bits) |
Table 44: External System Module Attributes
| Name | Type | Default |
|---|---|---|
name |
set-required string |
|
process model |
string¹ |
"sink" |
esd model |
string² |
"NONE" |
icon name |
string³ |
"esys_module" |
begsim intrpt |
toggle |
EMAC_DISABLED |
doc file |
string |
"nd_module" |
endsim intrpt |
toggle |
EMAC_DISABLED |
failure intrpts |
string⁴ |
"disabled" |
intrpt interval |
toggle double⁵ |
(disabled) |
priority |
integer |
0 |
recovery intrpts |
string⁴ |
"disabled" |
subqueue |
object ID⁶ |
|
super priority |
toggle |
EMAC_DISABLED |
position |
object ID⁷ |
Note 1: name of process model, without suffix. Note 2: name of external system description file, without suffix. Note 3: name of icon in an icon database. Note 4: valid values: "disabled", "local only", and "model wide". Note 5: in units of seconds. Note 6: object ID of subqueue compound value object. The subqueue compound value object is an EMA base object, containing the list and count attributes. Note 7: object ID of position object.
In the following tables, the value of all channel attributes specified for receiver and transmitter objects is the object ID of a compound value object. The compound value object is an EMA base object, containing the list and count attributes. Sub-objects named by list are channel objects described later in this section.
Table 45: Point-to-Point Receiver Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set-required string |
|
channel |
object ID¹ |
|
ecc threshold |
double |
0.0 (err/bit) |
icon name |
string² |
"pt_rx" |
position |
object ID³ |
|
doc file |
string |
"nd_ptp_receiver" |
Note 1: object ID of point-to-point receiver channel compound value object. Note 2: name of icon in an icon database. Note 3: object ID of position object.
Table 46: Bus Receiver Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set-required string |
|
channel |
object ID¹ |
|
ecc threshold |
double |
0.0 (err/bit) |
icon name |
string² |
"bu_rx" |
position |
object ID³ |
|
doc file |
string |
"nd_bus_receiver" |
Note 1: object ID of bus receiver channel compound value object. Note 2: name of icon in an icon database. Note 3: object ID of position object.
Table 47: Point-to-Point Transmitter Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set-required string |
|
channel |
object ID¹ |
|
icon name |
string² |
"pt_tx" |
position |
object ID³ |
|
doc file |
string |
"nd_ptp_transmitter" |
Note 1: object ID of point-to-point transmitter channel compound value object. Note 2: name of icon in an icon database. Note 3: object ID of position object.
Table 48: Bus Transmitter Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set-required string |
|
channel |
object ID¹ |
|
icon name |
string² |
"bu_tx" |
position |
object ID³ |
|
doc file |
string |
"nd_bus_transmitter" |
Note 1: object ID of bus transmitter channel compound value object. Note 2: name of icon in an icon database. Note 3: object ID of position object.
Table 49: Point-to-Point Receiver Channel Object Attributes
| Name | Type | Default |
|---|---|---|
data rate |
double |
1024.0 (bps) |
packet formats |
string¹ |
OPC_NT_LINK_ALLPKS |
Note 1: names of packet formats, separated by commas.
Table 50: Point-to-Point Transmitter Channel Object Attributes
| Name | Type | Default |
|---|---|---|
data rate |
double |
1024.0 (bps) |
packet formats |
string¹ |
OPC_NT_LINK_ALLPKS |
Note 1: names of packet formats, separated by commas.
Table 51: Bus Receiver Channel Object Attributes
| Name | Type | Default |
|---|---|---|
data rate |
double |
1024.0 (bps) |
packet formats |
string¹ |
OPC_NT_LINK_ALLPKS |
Note 1: names of packet formats, separated by commas.
Table 52: Bus Transmitter Channel Object Attributes
| Name | Type | Default |
|---|---|---|
data rate |
double |
1024.0 (bps) |
packet formats |
string¹ |
OPC_NT_LINK_ALLPKS |
Note 1: names of packet formats, separated by commas.
Table 53: Stream Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
src stream |
src strm |
set-required integer |
0 |
dest stream |
dest strm |
set-required integer |
0 |
color |
gfx color |
integer¹ |
OPC_GFX_COLOR_GREEN |
intrpt method |
integer² |
OPC_INTRPT_METHOD_SCHED |
|
delay |
double |
0.0 (sec) | |
src module |
set-required object ID³ |
||
dest module |
set-required object ID³ |
||
path |
array of object IDs⁴ |
||
doc file |
string |
"nd_packet_stream" |
Note 1: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants. Note 2: symbolic constant values for this attribute appear in Table 144 Interrupt Method Symbolic Constants. Note 3: object ID of connected module object. Note 4: object IDs of position objects that define stream path.
Table 54: Statistic Wire Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
delay |
double |
0.0 (sec) | |
color |
gfx color |
integer¹ |
OPC_GFX_COLOR_RGB331 |
src stat |
set-required string² |
||
dest stat |
set-required integer³ |
0 | |
intrpt method |
integer⁴ |
OPC_INTRPT_METHOD_SCHED |
|
src module |
set-required object ID⁵ |
||
dest module |
set-required object ID⁶ |
||
trigger |
integer⁷ |
OPC_TRIG_RISING_EDGE | OPC_TRIG_FALLING_EDGE |
|
path |
array of object IDs⁸ |
||
low thresh |
double |
0.0 | |
high thresh |
double |
0.0 | |
doc file |
string |
"nd_statistic_wire" |
Note 1: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants. Note 2: name of source module statistic (submodule statistics are prefixed by the submodule index, in brackets; e.g., "[2].pksize"); see Chapter 2 "Node Reference" on page 8 for a list of supported module statistics. Note 3: numeric index of destination processor or queue input statistic. Note 4: symbolic constant values for this attribute appear in Table 144 Interrupt Method Symbolic Constants. Note 5: object ID of connected module object. Note 6: object ID of connected processor or queue object. Note 7: symbolic constant values for this attribute appear in Table 145 Statistic Wire Trigger Symbolic Constants. Note 8: object IDs of position objects that define statistic wire path.
Table 55: Statistic Interface Description Object Attributes
| Name | Type | Default |
|---|---|---|
original name |
string |
|
promoted name |
string |
|
description |
toggle textlist¹ |
(empty) |
group name |
string |
|
capture mode |
string |
|
display mode |
string |
|
original group name |
string |
Note 1: textlist containing description of statistic.
Table 56: Logical Tx/Rx Association Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
color |
gfx color |
integer¹ |
OPC_GFX_COLOR_ORANGE |
src module |
set-required object ID² |
||
dest module |
set-required object ID³ |
||
path |
array of object IDs⁴ |
||
doc file |
string |
"nd_association" |
Note 1: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants. Note 2: object ID of connected transmitter or receiver module object. Note 3: object ID of connected transmitter or receiver module object. Note 4: object IDs of position objects that define association path.
Process Model
Table 57: Process Objects
| Object Type | Symbolic Constant |
|---|---|
| position | OBJ_PR_POS |
| interface description | OBJ_PR_INTF_DESC |
| attribute assignment | OBJ_PR_ATTR_ASSGN |
| state | OBJ_PR_STATE |
| transition | OBJ_PR_TRANS |
| statistic description | OBJ_PR_STAT_DESC |
| shape annotation | OBJ_PR_ANNOT_SHAPE |
| line annotation | OBJ_PR_ANNOT_LINE |
| text annotation | OBJ_PR_ANNOT_TEXT |
| annotation icon | OBJ_PR_ANNOT_ICON |
| intrpt code map | OBJ_PR_CODE_MAP |
Table 58: Position Object Attributes
| Name | Type | Default |
|---|---|---|
x |
set-required double |
|
y |
set-required double |
Table 59: Process Model Attributes
| Name | Type | Default |
|---|---|---|
state vars |
textlist¹ |
(empty) |
temp vars |
textlist¹ |
(empty) |
header block |
textlist¹ |
(empty) |
function block |
textlist¹ |
(empty) |
diag block |
textlist¹ |
(empty) |
termination block |
textlist¹ |
(empty) |
child processes |
textlist² |
(empty) |
ext fileset |
textlist³ |
(empty) |
simulation attributes |
array of object IDs⁴ |
(empty) |
global stat descs |
array of object IDs⁵ |
(empty) |
local stat descs |
array of object IDs⁵ |
(empty) |
model comments |
textlist⁶ |
(empty) |
interface descriptions |
array of object IDs⁷ |
(empty) |
attribute assignments |
array of object IDs⁸ |
(empty) |
packet formats |
textlist⁹ |
(empty) |
ODB labels |
textlist |
(empty) |
ODB labels descriptions |
textlist |
(empty) |
code language |
string |
"C" |
temp vars in diagnostic block |
toggle |
EMAC_DISABLED |
temp vars in termination block |
toggle |
EMAC_DISABLED |
Note 1: textlists containing Proto-C statements (see Chapter 5 "Process Domain" on page 169 for syntax guidelines). Note 2: textlist containing names of process models, without suffixes. Note 3: textlist containing names of external object files, without suffixes. Note 4: object IDs of attribute definition objects. Note 5: object IDs of statistic description objects. Note 6: textlist containing description of model. Note 7: object IDs of interface description objects for the model. Note 8: object IDs of attribute assignment objects. Note 9: textlist containing names of packet formats, without suffixes.
Table 60: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 61: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Table 62: State Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
enter execs |
textlist¹ |
(empty) | |
exit execs |
textlist¹ |
(empty) | |
status |
forced |
toggle² |
EMAC_DISABLED |
position |
object ID³ |
||
initial |
toggle⁴ |
EMAC_DISABLED |
Note 1: textlists containing Proto-C statements (see Chapter 5 "Process Domain" on page 169 for syntax guidelines).
Note 2: EMAC_DISABLED indicates state is unforced; EMAC_ENABLED indicates state is forced.
Note 3: object ID of position object.
Note 4: EMAC_ENABLED indicates state is initial.
Table 63: Transition Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
condition |
string¹ |
||
executive |
string² |
||
dest state |
set-required object ID³ |
||
src state |
set-required object ID³ |
||
drawing style |
spline |
toggle⁴ |
EMAC_ENABLED |
color |
gfx color |
integer⁵ |
OPC_GFX_COLOR_WHITE |
path |
array of object IDs⁶ |
||
label pos |
object ID⁷ |
Note 1: string containing Proto-C Boolean expression (see Chapter 5 "Process Domain" on page 169 for syntax guidelines).
Note 2: string containing Proto-C statement.
Note 3: object ID of process state object.
Note 4: EMAC_DISABLED indicates line drawing style; EMAC_ENABLED indicates spline drawing style.
Note 5: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants.
Note 6: object IDs of position objects that define transition path.
Note 7: object ID of position object for transition label.
Table 64: Statistic Description Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
count |
toggle integer |
EMA_DISABLED |
description |
textlist¹ |
(empty) |
group name |
string |
|
capture mode |
string |
|
display mode |
string |
|
low bound |
toggle double |
EMAC_DISABLED |
high bound |
toggle double |
EMAC_DISABLED |
Note 1: textlist containing description of attribute.
External System Definition
Table 65: External System Objects
| Name | Symbolic constant |
|---|---|
| Interface | OBJ_ESD_INTERFACE |
| External system definition | OBJ_ESD_BASE |
Table 66: Model Attributes of External System Definition
| Name | Type | Default |
|---|---|---|
model comments |
textlist (EMA only) |
"" |
Table 67: Interface Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set required string |
|
comment |
string |
"" |
type¹ |
set required integer |
integer |
direction² |
integer |
OPC_ESYS_DIR_IN |
dimension³ |
integer |
0 |
offset |
integer (EMA only) |
0 |
Note 1: The type attribute specifies the type of data that can be placed on the interface. Symbolic constant values for this attribute appear in Table 165 External System Interface Type Symbolic Constants. Note 2: The direction attribute indicates flow of data relative to the external system (therefore, "in" is Riverbed-to-cosimulation). Symbolic constant values for this attribute appear in Table 166 External System interface Direction Symbolic Constants. Note 3: The dimension attribute of interface objects refers to vector interfaces. The default value of zero means that the interface is not a vector interface. See Chapter 8 "External System Domain" on page 331 for more information about vector interfaces.
Table 68: External System Definition Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set required string |
"" |
simulator |
string |
"NONE" |
source description |
string |
"" |
Link Model
Table 69: Link Objects
| Object Type | Symbolic Constant |
|---|---|
| interface description | OBJ_LNK_INTF_DESC |
| attribute assignment | OBJ_LNK_ATTR_ASSGN |
| self description | OBJ_SELFDESC_CORE |
| ETS handler function | OBJ_LNK_ETS_HANDLER |
| statistic description | OBJ_LNK_STAT_DESC |
Table 70: Link Model Attributes
| Name | Type | Default |
|---|---|---|
model comments |
textlist¹ |
(empty) |
keywords |
textlist² |
|
simplex link icon |
string |
(empty string) |
duplex link icon |
string |
(empty string) |
bus link icon |
string |
(empty string) |
bus tap icon |
string |
(empty string) |
selfdescription |
array of object IDs³ |
|
tooltip |
string |
(empty string) |
doc file |
string |
(empty string) |
ets handlers |
array of object IDs⁴ |
|
local stat descs |
array of object IDs⁵ |
|
interface descriptions |
array of object IDs⁶ |
|
attribute assignments |
array of object IDs⁷ |
|
selfdescription |
object ID⁸ |
Note 1: textlist containing description of model.
Note 2: textlist containing keywords (one per line) used in palette.
Note 3: object IDs of type Vc_Selfdesc_Type
Note 4: object IDs of type Vc_ETS_Handler_Type
Note 5: object IDs of type Vc_Stat_Desc_Types
Note 6: object IDs of interface description objects for the model.
Note 7: object IDs of attribute assignment objects.
Note 8: object ID of OBJ_SELFDESC_CORE.
Table 71: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 72: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Path Model
Table 73: Path Objects
| Object Type | Symbolic Constant |
|---|---|
| interface description | OBJ_PATH_INTF_DESC |
| attribute assignment | OBJ_PATH_ATTR_ASSGN |
| self description | OBJ_SELFDESC_CORE |
| ETS handler function | OBJ_PATH_ETS_HANDLER |
| statistic description | OBJ_PATH_STAT_DESC |
Table 74: Path Model Attributes
| Name | Type | Default |
|---|---|---|
model comments |
textlist¹ |
(empty) |
keywords |
textlist² |
(empty) |
tooltip |
string |
(empty string) |
doc file |
string |
(empty string) |
icon |
string |
(empty string) |
connectivity |
string |
(empty string) |
ignore subnets |
Boolean integer |
0 |
allow cycles |
Boolean integer |
0 |
two endpoints only |
Boolean integer |
0 |
packet formats |
string |
all formats³ |
selfdescription |
object ID⁴ |
|
ets handlers |
object ID⁵ |
|
local stat descs |
array of object IDs⁶ |
|
interface description |
array of object IDs⁷ |
|
attribute assignment |
array of object IDs⁸ |
|
self description |
array of object IDs⁹ |
|
ets handler |
array of object IDs¹⁰ |
|
stat desc |
array of object IDs¹¹ |
Note 1: textlist containing description of model. Note 2: textlist containing keywords (one per line) used in palette. Note 3: string specifying all valid packet formats (OPC_NT_LINK_ALLPKS) Note 4: object ID of Path_Selfdesc_Type. Note 5: object IDs of type Path_ETS_Handler_Type Note 6: object IDs of type Path_Stat_Desc_Types Note 7: object IDs of interface description objects for the model. Note 8: object IDs of attribute assignment objects. Note 9: object IDs of type Vc_Selfdesc_Type Note 10: object IDs of ETS handler description objects Note 11: objects IDs of statistic description objects
Table 75: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 76: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Demand Model
Table 77: Demand Objects
| Object Type | Symbolic Constant |
|---|---|
| interface description | OBJ_DEMAND_INTF_DESC |
| attribute assignment | OBJ_DEMAND_ATTR_ASSGN |
| self description | OBJ_SELFDESC_CORE |
| ETS handler function | OBJ_DEMAND_ETS_HANDLER |
| statistic description | OBJ_DEMAND_STAT_DESC |
Table 78: Demand Model Attributes
| Name | Type | Default |
|---|---|---|
model comments |
textlist¹ |
(empty) |
keywords |
textlist² |
(empty) |
tooltip |
string |
(empty string) |
doc file |
string |
(empty string) |
icon |
string |
(empty string) |
selfdescription |
object ID³ |
|
ets handlers |
object ID⁴ |
|
local stat descs |
array of object IDs⁵ |
|
source required |
Boolean integer |
0 |
destination required |
Boolean integer |
0 |
path required |
Boolean integer |
0 |
demand type |
string |
"flow" |
acceptable path models |
string |
"all" |
interface description |
array of object IDs⁶ |
|
attribute assignment |
array of object IDs⁷ |
|
ets handler |
array of object IDs⁸ |
|
stat desc |
array of object IDs⁹ |
|
selfdescription |
array of object IDs¹⁰ |
Note 1: textlist containing description of model.
Note 2: textlist containing keywords (one per line) used in palette.
Note 3: object ID of OBJ_SELFDESC_CORE.
Note 4: object ID of type Vc_ETS_Handler_Type
Note 5: object IDs of type Vc_Stat_Desc_Types
Note 6: object IDs of interface description objects for the model.
Note 7: object IDs of attribute assignment objects.
Note 8: object IDs of ETS handler description objects
Note 9: objects IDs of statistic description objects
Note 10: object IDs of type Vc_Selfdesc_Type
Table 79: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 80: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Probability Density Function
Table 81: PDF Objects
| Object Type | Symbolic Constant |
|---|---|
| impulse | OBJ_PDF_IMPULSE |
Table 82: PDF Model Attributes
| Name | Type | Default |
|---|---|---|
outcome min |
double |
-10.0 |
outcome spacing |
double |
0.5 |
prob density |
double vector |
Table 83: Impulse Object Attributes
| Name | Type | Default |
|---|---|---|
outcome |
double |
|
mass |
double |
ICI Format
Table 84: ICI Format Objects
| Object Type | Symbolic Constant |
|---|---|
| attribute descriptor | OBJ_ICF_ATTR_DESC |
Table 85: ICI Format Model Attributes
| Name | Type | Default |
|---|---|---|
model comments |
textlist |
Table 86: ICI Attribute Descriptor Object Attributes
| Name | Type | Default |
|---|---|---|
type |
integer¹ |
OPC_ICA_TYPE_INTEGER |
default value |
string |
|
name |
string |
|
description |
textlist |
Note 1: symbolic constant values for this attribute appear in Table 148 ICI Attribute Type Symbolic Constants.
Packet Format
Table 87: Packet Format Objects
| Object Type | Symbolic Constant |
|---|---|
| field | OBJ_PF_FIELD |
| position | OBJ_PF_POS |
Table 88: Packet Model Attributes
| Name | Type | Default |
|---|---|---|
comments |
textlist |
|
conversion method |
string |
"none" |
supports conversion |
toggle |
EMAC_ENABLED |
bulk fill pattern |
string |
"0x0" |
Table 89: Packet Field Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set required string |
|
comments |
textlist |
|
type |
integer¹ |
OPC_PKF_TYPE_INTEGER |
encoding |
string² |
OPC_PKF_ENCODING_SIGNED_BIGE |
size |
integer³ |
32 |
default value |
string |
|
set at creation |
toggle |
INIT_ENABLED |
color |
integer |
OPC_GFX_COLOR_GREY |
conversion method |
string |
"NONE" |
conversion order |
integer |
|
position |
Object ID |
Note 1: symbolic constant values for this attribute appear in Table 146 Packet Field Type Symbolic Constants. Note 2: symbolic constant values for this attribute appear in Table 147 Packet Encoding Attribute Symbolic Constants. Note 3: in bits.
Probe List
Table 90: Probe List Objects
| Object Type | Symbolic Constant |
|---|---|
| position | OBJ_PB_POS |
| node statistic probe | OBJ_PB_SPROBE |
| automatic animation probe | OBJ_PB_AAPROBE |
| custom animation probe | OBJ_PB_CAPROBE |
| simulation attribute probe | OBJ_PB_SAPROBE |
| global statistic probe | OBJ_PB_GSPROBE |
| statistic animation probe | OBJ_PB_STANPROBE |
| live statistic probe | OBJ_PB_RTSPROBE |
| link probe | OBJ_PB_LKPROBE |
| path probe | OBJ_PB_PATHPROBE |
| demand probe | OBJ_PB_DEMANDPROBE |
Table 91: Probe List Model Attributes
| Name | Type | Default |
|---|---|---|
network name |
string¹ |
Note 1: name of network model, without suffix.
Table 92: Position Object Attributes
| Name | Type | Default |
|---|---|---|
x |
set-required double |
|
y |
set-required double |
Table 93: Statistic Probe Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
subnet |
string¹ |
||
node |
string² |
||
module |
string³ |
||
submodule |
string⁴ |
||
statistic |
string⁵ |
||
ordinate label |
string |
||
vector data |
toggle |
EMAC_ENABLED |
|
vector start |
start time |
double |
0.0 (sec) |
vector stop |
stop time |
double |
EMAC_DBL_INFINITY (sec) |
capture mode |
string⁶ |
"normal" | |
scalar data |
toggle |
EMAC_DISABLED |
|
scalar type |
end log |
string⁷ |
|
scalar start |
double |
0.0 | |
scalar stop |
double |
EMAC_DBL_INFINITY (sec) |
|
pos |
object ID⁸ |
||
doc file |
string |
"pb_node_stat_probe" | |
drawing style |
string |
||
group |
string |
||
threshold comparison |
string |
"disabled" | |
threshold value |
double |
0.0 | |
threshold percent |
double |
90.0 | |
tag |
string |
OVC_VECTOR_TAG_USER |
|
low bound |
toggle |
EMAC_DISABLED |
|
high bound |
toggle |
EMAC_DISABLED |
Note 1: name of subnet in associated network model. Note 2: name of node in associated network model. Note 3: name of module in node model referenced by associated network model. Note 4: formal name of submodule (e.g., "subqueue [0]"). Note 5: name of statistic supported by referenced module or submodule; see Chapter 2 "Node Reference" on page 8 for a list of supported module statistics. Note 6: valid values: "normal", "sample/<n>", "bucket/<n>/<mode>", "glitch removal"; where <n> is either a number (double) or a number followed by "sec"; <mode> is either "max value", "min value", "sum", "count", "sample mean", or "time average. Note 7: valid values: "last value", "sample mean", "time average", "variance", "min value", "max value". Note 8: object ID of position object.
Table 94: Automatic Animation Probe Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
subnet |
string¹ |
|
node |
string² |
|
module |
string³ |
|
representation |
string⁴ |
|
anim start |
double |
0.0 (sec) |
anim stop |
double |
EMAC_DBL_INFINITY (sec) |
window name |
string |
|
window x |
integer |
10 (pixels) |
window y |
integer |
10 (pixels) |
window width |
integer |
500 (pixels) |
window height |
integer |
300 (pixels) |
pos |
object ID⁵ |
|
doc file |
string |
"pb_auto_anim_probe" |
Note 1: name of subnet in associated network model. Note 2: name of node in associated network model. Note 3: name of module in node model referenced by associated network model. Note 4: name of automatic animation representation supported by referenced object. Note 5: object ID of position object.
Table 95: Custom Animation Probe Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
subnet |
string¹ |
|
node |
string² |
|
module |
string³ |
|
label |
string |
|
anim start |
double |
0.0 (sec) |
anim stop |
double |
EMAC_DBL_INFINITY (sec) |
window name |
string |
|
window x |
integer |
10 (pixels) |
window y |
integer |
10 (pixels) |
window width |
integer |
500 (pixels) |
window height |
integer |
300 (pixels) |
pos |
object ID⁴ |
|
doc file |
string |
"pb_custom_anim_probe" |
Note 1: name of subnet in associated network model. Note 2: name of node in associated network model. Note 3: name of module in node model referenced by associated network model. Note 4: object ID of position object.
Table 96: Attribute Probe Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
object |
string¹ |
|
attribute |
string² |
|
ordinate label |
string |
|
pos |
object ID³ |
|
doc file |
string |
"pb_attribute_probe" |
Note 1: full hierarchical name of probed object (empty for simulation attributes). Note 2: name of probed object’s attribute (simulation attribute name if a simulation attribute is referenced). Note 3: object ID of position object.
Table 97: Global Statistic Probe Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
global statistic |
string¹ |
|
ordinate label |
string |
|
vector data |
toggle |
EMAC_ENABLED |
vector start |
double |
0.0 (sec) |
vector stop |
double |
EMAC_DBL_INFINITY (sec) |
capture mode |
string² |
"normal" |
scalar data |
toggle |
EMAC_DISABLED |
scalar type |
string³ |
|
scalar start |
double |
0.0 |
scalar stop |
double |
EMAC_DBL_INFINITY (sec) |
pos |
object ID⁴ |
|
doc file |
string |
"pb_global_stat_probe" |
group |
string |
"disabled" |
threshold comparison |
double |
0.0 |
threshold value |
double |
90.0 |
threshold percent |
string |
OVC_VECTOR_TAG_USER |
tag |
toggle |
EMAC_DISABLED |
low bound |
toggle |
EMAC_DISABLED |
Note 1: name of global statistic. Note 2: valid values: "normal", "sample/<n>", "bucket/<n>/<mode>", "glitch removal"; where <n> is either a number (double) or a number followed by "sec"; <mode> is either "max value", "min value", "sum", "count", "sample mean", or "time average. Note 3: valid values: "last value", "sample mean", "time average", "variance", "min value", "max value". Note 4: object ID of position object.
Table 98: Statistic Animation Probe Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
statistic |
string¹ |
|
window name |
string² |
|
window x |
integer |
10 |
window y |
integer |
10 |
window width |
integer |
500 |
window height |
integer |
400 |
panel name |
string³ |
|
panel x |
integer |
10 |
panel y |
integer |
10 |
panel width |
integer |
442 |
panel height |
integer |
440 |
zone number |
integer |
1 |
zone height |
integer |
200 |
zone color |
integer |
OPC_GFX_COLOR_STEEL |
background color |
integer |
OPC_GFX_COLOR_SLATE |
scrolling |
toggle |
EMAC_DISABLED |
initial width |
double |
0.0 |
trace color |
integer |
OPC_GFX_COLOR_WHITE |
trace style |
string |
"linear" |
pos |
object ID⁴ |
|
doc file |
string |
"pb_stat_anim_probe" |
Note 1: name of statistic probe. Note 2: name of window in which to display this statistic; this window can display only Statistic Animation Probes. Note 3: name of panel within named window in which to display this statistic. Note 4: object ID of position object.
Table 99: Link Probe Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
subnet |
string¹ |
|
link |
string² |
|
channel |
string³ |
|
statistic |
string⁴ |
|
ordinate label |
string |
|
vector data |
toggle |
EMAC_ENABLED |
vector start |
double |
0.0 (sec) |
vector stop |
double |
EMAC_DBL_INFINITY (sec) |
capture mode |
string⁵ |
"normal" |
scalar data |
toggle |
EMAC_DISABLED |
scalar type |
string⁶ |
|
scalar start |
double |
0.0 |
scalar stop |
double |
EMAC_DBL_INFINITY (sec) |
pos |
object ID⁷ |
|
doc file |
string |
"pb_link_stat_probe" |
drawing style |
string |
|
group |
string |
|
threshold comparison |
double |
0.0 |
threshold value |
double |
90.0 |
threshold percent |
string |
OVC_VECTOR_TAG_USER |
tag |
toggle |
EMAC_DISABLED |
low bound |
toggle |
EMAC_DISABLED |
Note 1: name of subnet in associated network model. Note 2: name of link. Note 3: name of channel. Note 4: name of statistic supported by referenced module or submodule; see Chapter 2 "Node Reference" on page 8 for a list of supported module statistics. Note 5: valid values: "normal", "sample/<n>", "bucket/<n>/<mode>", "glitch removal"; where <n> is either a number (double) or a number followed by "sec"; <mode> is either "max value", "min value", "sum", "count", "sample mean", or "time average. Note 6: valid values: "last value", "sample mean", "time average", "variance", "min value", "max value". Note 7: object ID of position object.
Simulation Sequence
Table 100: Simulation Sequence Objects
| Object Type | Symbolic Constant |
|---|---|
| position | OBJ_SEQ_POS |
| simulation argument | OBJ_SEQ_ARG |
| simulation run | OBJ_SEQ_RUN |
Table 101: Simulation Sequence Model Attributes
-- No attributes are defined for this model type --
Table 102: Position Object Attributes
| Name | Type | Default |
|---|---|---|
x |
set-required double |
|
y |
set-required double |
Table 103: Simulation Argument Object Attributes
| Name | Type | Default |
|---|---|---|
value |
string¹ |
"TRUE" |
name |
string² |
Note 1: String representing the value or values that the attribute names by "name" is to take on. If multiple values are to be listed, they are separated by the'|' character (e.g. the string "5.0|6.0|7.0" represents three values that an attribute will take on). Note 2: The name of the attribute for which a value or values are provided.
Table 104: Simulation Run Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
name |
string |
||
aim program |
string¹ |
"op_runsim" | |
network |
string² |
||
probe file |
string³ |
||
vector file |
output file |
string⁴ |
|
seed |
integer⁵ |
0.0 | |
duration |
double⁶ |
1000.0 | |
update interval |
double⁶ |
500000 | |
noprompt |
toggle |
EMAC_DISABLED |
|
environment files |
textlist⁷ |
(empty) | |
anim attempts |
integer |
5 | |
anim hist |
string⁸ |
||
anim host |
string |
"localhost" | |
anim post |
integer |
0 | |
anim timeout |
double |
3.0 | |
anim view |
toggle |
EMAC_DISABLED |
|
anim hist enabled |
toggle |
EMAC_DISABLED |
|
multi vector files |
toggle |
EMAC_DISABLED |
|
argument list |
array of object IDs⁹ |
||
pos |
object ID¹⁰ |
||
collect count |
integer |
100 | |
tim file |
string |
||
enable logging |
toggle |
EMAC_DISABLED |
|
doc file |
string |
||
SLA probe files |
textlist¹¹ |
(empty) | |
Report probe files |
textlist¹² |
(empty) | |
Start date |
string |
||
Start time |
string |
||
Date recording |
string |
"not set" | |
Generate web report |
toggle |
EMAC_DISABLED |
Note 1: name of simulation program. Note 2: name of network model file, without suffix. Note 3: name of probe list file, without suffix. Note 4: name of output vector file, without suffix. Note 5: seed number given to random number generator. Note 6: in units of seconds. Note 7: textlist containing list of environmental files. Note 8: name of animation history file. Note 9: object IDs of child simulation argument objects. Note 10: object ID of position object. Note 11: textlist containing list of SLA probe files Note 12: textlist containing list of web report probe files
Output Vector
Table 105: Output Vector Objects
| Object Type | Symbolic Constant |
|---|---|
| vector | OBJ_OV_VECTOR |
| element | OBJ_OV_ELEMENT |
| scalar | OBJ_OV_SCALAR |
Table 106: Output Vector Model Attributes
| Name | Type | Default |
|---|---|---|
root element |
object ID¹ |
|
start date |
string |
|
start time |
string |
|
trend time units |
integer² |
OPC_OV_TIME_UNITS_SECONDS |
trend time delta |
toggle double |
EMAC_DISABLED |
scalars |
array of object IDs³ |
Note 1: This is the object ID for the root node object. The value EMAC_NULL_OBJ_ID means the model has a flat structure.
Note 2: Symbolic constant values for this attribute appear in Table 158 Output Vector Time Unit Symbolic Constants.
Note 3: Object IDs of output scalar statistic objects.
Table 107: Output Vector Object Attributes
| Name | Type | Default |
|---|---|---|
abscissa name |
string |
|
ordinate name |
string |
|
type |
integer¹ |
OPC_OV_TYPE_VECTOR_DOUBLE |
enum dictionary |
string |
"" |
time delta² |
double |
0 |
time start |
double |
0 |
drawing style |
integer³ |
OPC_OV_DRAW_STYLE_LINEAR |
abscissa vec |
double vector |
|
ordinate vec |
double vector |
|
time units |
integer⁴ |
OPC_OV_TIME_UNITS_SECONDS |
threshold mode |
integer⁵ |
OPC_OV_THRESHOLD_MODE_NONE |
threshold value |
double |
0.0 |
threshold percent |
double |
0.0 |
low bound |
toggle double |
EMAC_DISABLED |
high bound |
toggle double |
EMAC_DISABLED |
minimum vec |
double vector |
|
maximum vec |
double vector |
|
std dev vec |
double vector |
|
threshold total vec |
double vector |
|
threshold violations vec |
double vector |
Note 1: symbolic constant values for this attribute appear in Table 155 Output Vector Subelement Type Symbolic Constants. Note 2: If "time delta" has a value other than 0 (sec), the individual values of "abscissa vec" must be multiples of "time delta". For example, if "time delta" is 60 and abscissa vec [0] = 0, then abscissa vec [1] should be 60, abscissa vec [2] should be 120, and so on. Note 3: symbolic constant values for this attribute appear in Table 156 Output Vector Drawing Style Symbolic Constants. Note 4: symbolic constant values for this attribute appear in Table 158 Output Vector Time Unit Symbolic Constants. Note 5: symbolic constant values for this attribute appear in Table 157 Output Vector Threshold Mode Symbolic Constants.
Table 108: Output Vector Element Object Attributes
| Name | Type | Default |
|---|---|---|
type |
integer¹ |
OPC_OV_TYPE_OBJECT |
name |
string |
|
subelement |
array of object IDs² |
Note 1: symbolic constant values for this attribute appear in Table 155 Output Vector Subelement Type Symbolic Constants. Note 2: object IDs of either vector or node objects.
Table 109: Output Vector Scalar Object Attributes
| Name | Type | Default |
|---|---|---|
name |
string |
|
samples vec |
double vector |
0 |
Output Scalar
Table 110: Output Scalar Objects
| Object Type | Symbolic Constant |
|---|---|
| simulation run | OBJ_OS_RUN |
| statistic | OBJ_OS_STAT |
Table 111: Output Scalar Model Attributes
-- No attributes are defined for this model type --
Table 112: Output Scalar Run Object Attributes
| Name | Type | Default |
|---|---|---|
model name |
set-required string¹ |
|
seed |
set-required integer |
0 |
stat array |
array of object IDs² |
Note 1: name of simulation executable, without suffix. Note 2: object IDs of output scalar run statistic objects.
Table 113: Output Scalar Run Statistic Object Attributes
| Name | Type | Default |
|---|---|---|
name |
set-required string |
|
value |
set-required double |
0.0 |
Cartographic Data Set
Table 114: Cartographic Data Set Objects
| Object Type | Symbolic Constant |
|---|---|
| line | OBJ_CDS_LINE |
| object (city, label, etc.) | OBJ_CDS_OBJECT |
Table 115: Cartographic Data Set Attributes
| Name | Type | Default |
|---|---|---|
grid division |
double |
15.0 |
grid color |
integer¹ |
OPC_GFX_COLOR_RGB222 |
grid style |
integer² |
OPC_GRID_STYLE_NONE |
Note 1: symbolic constant values for this attribute appear in Table 143 Graphics Color Symbolic Constants. Note 2: symbolic constant values for this attribute appear in Table 142 Grid Style Symbolic Constants.
Table 116: Line Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
status |
toggle |
EMAC_ENABLED |
|
condition |
toggle |
EMAC_ENABLED |
|
color |
integer¹ |
OPC_GFX_COLOR_RGB221 |
|
rank |
integer |
0 | |
type |
integer² |
OPC_CDS_LINE_TYPE_COAST |
|
threshold |
double |
0.0 (pixels/deg) | |
latitude |
double vector³ |
||
longitude |
double vector³ |
Note 1: symbolic constant values for these attributes appear in Table 143 Graphics Color Symbolic Constants. Note 2: symbolic constant values for this attribute appear in Table 149 Cartographic Line Type Symbolic Constants. Note 3: vector values in units of degrees.
Table 117: Cartographic Object Attributes
| Name | Alias | Type | Default |
|---|---|---|---|
longitude |
x position |
double |
0.0 |
latitude |
y position |
double |
0.0 |
name |
|||
icon name |
icon |
string¹ |
"city_marker" |
threshold |
double |
0.0 (pixels/deg) | |
draw icon |
toggle |
EMAC_ENABLED |
|
text size |
integer² |
OPC_TEXT_SIZE_SMALL |
|
text color |
integer³ |
OPC_GFX_COLOR_RGB333 |
Note 1: name of icon in icon databases. Note 2: symbolic constants for this attribute appear in Table 150 Text Size Symbolic Constants. Note 3: symbolic constants for this attribute appear in Table 143 Graphics Color Symbolic Constants.
Public Attribute Description Model
Table 118: Public Attribute Description Model Objects
-- No objects are defined for this model type --
Table 119: Public Attribute Description Model Attributes
| Name | Type | Default |
|---|---|---|
properties |
set-required object ID¹ |
Note 1: object ID of properties object.
Traffic Model
Table 120: Traffic Objects
| Object Type | Symbolic Constant |
|---|---|
| conversation pair | OBJ_TIM_CONVERSATION |
| traffic profile | OBJ_TIM_PROFILE |
Table 121: Model Attributes of Traffic Model
| Name | Type | Default |
|---|---|---|
base year |
integer (EMA only) |
"" |
base month |
integer (EMA only) |
"" |
base day |
integer (EMA only) |
"" |
base seconds |
integer (EMA only) |
"" |
Table 122: Conversation Pair Object Attributes
| Name | Type | Default |
|---|---|---|
source |
string (EMA only) |
"" |
destination |
string (EMA only) |
"" |
profile |
object ID¹ (EMA only) |
Note 1: object ID of profile object
Table 123: Traffic Profile Object Attributes
| Name | Type | Default |
|---|---|---|
homogeneous |
toggle (EMA only) |
EMAC_ENABLED |
start time |
double vector (EMA only) |
"" |
end time |
double vector (EMA only) |
"" |
bits |
double vector (EMA only) |
"" |
packets |
double vector (EMA only) |
"" |
Derived Node Model
Table 124: Derived Node Model Objects
| Object Type | Symbolic Constant |
|---|---|
| interface description | OBJ_NDDER_INTF_DESC |
| attribute assignment | OBJ_NDDER_ATTR_ASSGN |
Table 125: Derived Node Model Attributes
| Name | Type | Default |
|---|---|---|
fixed icon |
string¹ |
|
parent model |
string |
|
model comments |
textlist² |
(empty) |
keywords |
textlist³ |
(empty) |
interface descriptions |
array of object IDs⁴ |
|
attribute assignments |
array of object IDs⁵ |
|
selfdescription |
object ID⁶ |
|
inherit selfdescription |
toggle |
EMAC_ENABLED |
tooltip |
string |
|
doc file |
string |
Note 1: name of icon to use for this type of node.
Note 2: textlist containing description of model.
Note 3: textlist containing keywords (one per line) used in palette.
Note 4: object IDs of interface description objects for the model.
Note 5: object IDs of attribute assignment objects.
Note 6: object ID of OBJ_SELFDESC_PORTGROUP.
Table 126: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 127: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Derived Link Model
Table 128: Derived Link Model Objects
| Object Type | Symbolic Constant |
|---|---|
| interface description | OBJ_LNKDER_INTF_DESC |
| attribute assignment | OBJ_LNKDER_ATTR_ASSGN |
Table 129: Derived Link Model Attributes
| Name | Type | Default |
|---|---|---|
duplex link icon |
string¹ |
|
simplex link icon |
string¹ |
|
bus link icon |
string¹ |
|
bus tap icon |
string¹ |
|
parent model |
string |
|
model comments |
textlist² |
(empty) |
keywords |
textlist³ |
(empty) |
interface descriptions |
array of object IDs⁴ |
|
attribute assignments |
array of object IDs⁵ |
|
selfdescription |
object ID⁶ |
|
inherit selfdescription |
toggle |
EMAC_ENABLED |
tooltip |
string |
|
doc file |
string |
Note 1: name of icon to use for this type of link.
Note 2: textlist containing description of model.
Note 3: textlist containing keywords (one per line) used in palette.
Note 4: object IDs of interface description objects for the model.
Note 5: object IDs of attribute assignment objects.
Note 6: object ID of OBJ_SELFDESC_CORE.
Table 130: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 131: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Derived Path Model
Table 132: Derived Path Model Objects
| Object Type | Symbolic Constant |
|---|---|
| interface description | OBJ_PATHDER_INTF_DESC |
| attribute assignment | OBJ_PATHDER_ATTR_ASSGN |
Table 133: Derived Link Model Attributes
| Name | Type | Default |
|---|---|---|
parent model |
string |
|
model comments |
textlist¹ |
(empty) |
keywords |
textlist² |
(empty) |
interface descriptions |
array of object IDs³ |
|
attribute assignments |
array of object IDs⁴ |
|
selfdescription |
object ID⁵ |
|
inherit selfdescription |
toggle |
EMAC_ENABLED |
tooltip |
string |
|
doc file |
string |
|
icon |
string |
(empty string) |
connectivity |
string |
(empty string) |
ignore subnets |
Boolean integer |
0 |
allow cycles |
Boolean integer |
0 |
two endpoints only |
Boolean integer |
0 |
packet formats |
string |
all formats⁶ |
Note 1: textlist containing description of model.
Note 2: textlist containing keywords (one per line) used in palette.
Note 3: object IDs of interface description objects for the model.
Note 4: object IDs of attribute assignment objects.
Note 5: object ID of OBJ_SELFDESC_CORE.
Note 6: string specifying all valid packet formats
Table 134: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 135: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Derived Demand Model
Table 136: Derived Demand Model Objects
| Object Type | Symbolic Constant |
|---|---|
| interface description | OBJ_DEMANDDER_INTF_DESC |
| attribute assignment | OBJ_DEMANDDER_ATTR_ASSGN |
Table 137: Derived Link Model Attributes
| Name | Type | Default |
|---|---|---|
parent model |
string |
|
model comments |
textlist¹ |
(empty) |
keywords |
textlist² |
(empty) |
interface descriptions |
array of object IDs³ |
|
attribute assignments |
array of object IDs⁴ |
|
selfdescription |
object ID⁵ |
|
inherit selfdescription |
toggle |
EMAC_ENABLED |
tooltip |
string |
|
doc file |
string |
|
source required |
Boolean integer |
0 |
destination required |
Boolean integer |
0 |
path required |
Boolean integer |
0 |
demand type |
string |
"flow" |
acceptable path models |
string |
"all" |
Note 1: textlist containing description of model.
Note 2: textlist containing keywords (one per line) used in palette.
Note 3: object IDs of interface description objects for the model.
Note 4: object IDs of attribute assignment objects.
Note 5: object ID of OBJ_SELFDESC_CORE.
Table 138: Interface Description Object Attributes
| Name | Type¹ | Default |
|---|---|---|
promotion name |
set-required string |
|
merged names |
set-required textlist |
|
flags |
integer |
0 |
properties |
object ID |
|
suppressed symbols |
textlist |
(empty) |
type |
integer |
-1 |
Note 1: See notes for Table 20 Interface Description Object Attributes for more complete details on specific attribute meanings.
Table 139: Attribute Assignment Object Attributes
| Name | Type¹ | Default |
|---|---|---|
name |
string |
|
operation |
integer |
|
value |
poly |
|
type |
integer |
-1 |
Note 1: See notes for Table 21 Attribute Assignment Object Attributes for more complete details on specific attribute meanings.
Symbol Map Object
Table 140: Symbol Map Object
| Object Type | Symbolic Constant |
|---|---|
| symbol map | OBJ_ATTR_SYMMAP |