Node Object Attribute Descriptions
begsim intrpt
This attribute specifies whether a begin simulation interrupt is generated for the object's root process at the start of the simulation (that is, simulation time 0.0 sec). Some processes require such an interrupt to initialize before they begin mainstream event processing. Initializations typically include allocating and setting initial values for state variables, creating necessary child processes, and performing discovery of the surrounding environment at the network and node levels.
The process model can determine if this type of interrupt is being delivered by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_BEGSIM indicates a begin simulation interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write/promote | read |
| Default Value | disabled | |
| Units | ||
| Constraints |
bit capacity
This attribute specifies the maximum number of bits that can be held in a transmission queue or a subqueue. The size of the queue or subqueue (in bits) is the sum of the packet lengths for all packets presently contained in the queue. Attempts to insert a packet into the queue that would increase the total number of bits beyond the limit specified by this attribute return a failure status, indicating that the queue is full.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write/promote | read/write |
| Default Value | infinity | |
| Units | bits | |
| Constraints | bit capacity >= 0 |
channel
This attribute specifies the incoming channels supported by a receiver or the outgoing channels supported by a transmitter. It consists of any number of channel objects of the appropriate type:
- For point-to-point receivers, one Point-to-Point Receiver Channel Object for each channel supported by the point-to-point receiver
- For point-to-point transmitters, one Point-to-Point Transmitter Channel Object for each channel supported by the point-to-point transmitter
- For bus receivers, one Bus Receiver Channel Object for each channel supported by the bus receiver
- For bus transmitters, one Bus Transmitter Channel Object for each channel supported by the bus transmitter
| Editing | Simulation | |
|---|---|---|
| Data Type | compound | compound |
| Access | read/write/promote | read |
| Default Value | ||
| Units | ||
| Constraints |
color
This attribute is the color of the object when drawn in the Node Editor workspace. You can choose the value of this attribute from a menu or palette of available colors. The value of this attribute has no effect on behavior of simulations.
| Editing | Simulation | |
|---|---|---|
| Data Type | typed file | not applicable |
| Access | read/write | not applicable |
| Default Value | #FF8000 (logical association) blue (packet stream) red (statistic wire) |
|
| Units | ||
| Constraints |
data rate
This attribute specifies the rate at which information can be accepted over the channel. Typically, this attribute has the same value for corresponding transmitter and receiver channels. In addition, the link object (“Simplex Point-to-Point Link Object”, “Duplex Point-to-Point Link Object”, or “Bus Link Object”) has a data rate attribute that must match the data rate of channel [0] for correct operation. The special value “unspecified” can be assigned to the data rate attribute on a transmitter or receiver so that it will automatically acquire the data rate of the link and the corresponding channel.
See Chapter 7 “Network Domain” on page 292 for more information about matching data rates to achieve link consistency.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write/promote | read/write |
| Default Value | “unspecified” | |
| Units | bits/second | |
| Constraints | data rate > 0.0 |
delay
This attribute is the simulation time interval from the time when a packet is sent through the packet stream to the time when the packet arrives at the destination module. This delay is in addition to the delay due to sending packets via op_pk_send_delayed(), if this KP is used. For example, if at simulation time 10.0 a packet is sent via op_pk_send() and “delay” is 5.0 for the packet stream through which the packet is sent, the stream interrupt occurs at the destination module at time 15.0. If the same packet is instead sent via op_pk_send_delayed() with the “delay” argument equal to 2.0, the stream interrupt occurs at time 17.0.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write/promote | read/write |
| Default Value | 0.0 | |
| Units | seconds | |
| Constraints | delay >= 0.0 |
dest stat
This attribute specifies the name of the input statistic to which the statistic wire is connected. This value is always of the form “instat (n)”, where n is the input statistic index. This input statistic index is used to identify the statistic when using Kernel Procedures such as op_stat_local_read(). The value of this input statistic changes as a result of changes in the associated output statistic at the source module.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | integer |
| Access | read/write | read |
| Default Value | lowest available instat | |
| Units | ||
| Constraints |
dest stream
This attribute is the index of the input stream of the destination module to which the packet stream object is connected. For example, if this attribute has a value of 2, processes in the destination module must pass 2 as the argument (i.e., the stream index) to the KP op_pk_get() to receive packets that have been received via the stream.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | lowest available stream | |
| Units | ||
| Constraints |
ecc threshold
This attribute is the highest proportion of bit errors allowed in a packet for the packet to be accepted by the receiver and forwarded to an output stream. As an example, a receiver with an “ecc threshold” value of 0.20 will accept packets with no more than 20 percent of their bits in error. This attribute provides a coarse model of error correction capability at the receiver module. The value of this attribute is typically used by the error correction stage (ecc model) of the bus link transceiver pipeline.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write/promote | read/write |
| Default Value | 0.0 | |
| Units | errors/bit | |
| Constraints | 0.0 <= ecc threshold <= 1.0 |
endsim intrpt
This attribute specifies whether an end simulation interrupt is generated for the object's root process at the end of simulation. Certain processes require this type of interrupt to do special functions at the end of the simulation. These functions generally involve reporting of information that has been gathered during the course of the simulation, typically scalar statistics, or reports in a proprietary format.
The process model can determine if this type of interrupt is being delivered by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_ENDSIM indicates an end simulation interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write/promote | read |
| Default Value | disabled | |
| Units | ||
| Constraints |
esd model
This attribute is the name of the external system definition (ESD) used to interface with another simulator during a cosimulation. External system definitions can be developed in the External System Editor to customize the transfer of data between simulations. See Chapter 8 “External System Domain” on page 325 for more information about external systems modeling.
The referenced model must be a file ending in the .esd.m suffix.
| Editing | Simulation | |
|---|---|---|
| Data Type | typed file | string |
| Access | read/write | read |
| Default Value | None | |
| Units | ||
| Constraints |
failure intrpts
This attribute specifies whether failure interrupts are generated for the object's root process upon failure of nodes or links in the network model. (Failure is signaled by transition of the “condition” attribute of the node or link from a value of “enabled” to “disabled”.) Possible values for this attribute are:
- disabled – No failure interrupts are scheduled for this module.
- local only – A failure interrupt is scheduled for this module only if the node which contains this processor object fails.
- network wide – A failure interrupt is scheduled for this module if any node or link in the network fails.
Symbolic constants corresponding to the three possible values of this attribute are OPC_INTRPT_DISABLED, OPC_INTRPT_LOCAL_ONLY, and OPC_INTRPT_NETWORK_WIDE.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | integer |
| Access | read/write/promote | read/write |
| Default Value | disabled | |
| Units | ||
| Constraints |
falling edge trigger
If enabled, this attribute specifies that a statistic interrupt is to be generated at the destination module if the value of the destination module's input statistic is updated, and the new value is less than the previous value. The value of this attribute, like all statistic wire triggers, is examined at the time that a statistic update is received at the destination module, not when the statistic is updated at the source module.
A process in the destination module can determine if this type of interrupt is the cause of its invocation by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_STAT indicates a statistic interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write/promote | read/write |
| Default Value | enabled | |
| Units | ||
| Constraints |
high threshold trigger
If enabled, this attribute specifies that a statistic interrupt is to be generated at the destination module if the value of the destination module's input statistic is updated, and the new value is greater than or equal to the specified threshold value. The value of this attribute, like all statistic wire triggers, is examined at the time that a statistic update is received at the destination module, not when the statistic is updated at the source module.
A process in the destination module can determine if this type of interrupt is the cause of its invocation by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_STAT indicates a statistic interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle-double | toggle-double |
| Access | read/write/promote | read/write |
| Default Value | disabled | |
| Units | ||
| Constraints |
icon name
This attribute specifies the name of the icon used to represent the object in node model diagrams. You can create custom icons with the icon editor. The value of this attribute has no effect on simulation behavior.
| Editing | Simulation | |
|---|---|---|
| Data Type | icon | not applicable |
| Access | read/write | not applicable |
| Default Value | bu_rx (bus receivers) bu_tx (bus transmitters) processor (processors) pt_rx (point-to-point receivers) pt_tx (point-to-point transmitters) queue (queues) |
|
| Units | ||
| Constraints |
intrpt interval
This attribute specifies how often regular interrupts are scheduled for the root process of a processor or queue. If this attribute is disabled, no regular interrupts occur. If this attribute is enabled (that is, has a valid double value), the value of the attribute is the number of simulation-time seconds between regular interrupts.
If this attribute is modified during a simulation, the next scheduled regular interrupt for the object is canceled and a new regular interrupt is scheduled for one interval after the current simulation time.
The process model can determine if this type of interrupt is being delivered by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_REGULAR indicates a regular interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle-double | toggle-double |
| Access | read/write/promote | read/write |
| Default Value | disabled | |
| Units | seconds | |
| Constraints | intrpt interval > 0.0 |
intrpt method
This attribute specifies the manner in which packets are forwarded to the destination module of a packet stream or statistic wire.
Packet streams: If the value of this attribute is “scheduled”, sending a packet through the stream causes a stream interrupt to be scheduled for the appropriate process in the destination module. Execution of the source process continues. Later (at the same simulation time, if the packet stream attribute “delay” is set to 0.0), the stream interrupt is delivered to the destination process. If the value of this attribute is “forced”, the stream interrupt is processed immediately upon the call to op_pk_send(). Execution of the source process is temporarily suspended and resumed after the destination process blocks. This attribute is not relevant when the stream source is a processor or queue module.
Statistic wires: If the value of this attribute is “scheduled”, sending a statistic through the wire causes a statistic interrupt to be scheduled for the appropriate process in the destination module. Execution of the source process continues. Later (at the same simulation time, if the statistic wire attribute “delay” is set to 0.0), the statistic interrupt is delivered to the destination process. If the value of this attribute is “forced”, the statistic interrupt is processed immediately upon the change in the statistic value. Execution of the source process is temporarily suspended and resumed after the destination process blocks.
This attribute can be modified during simulation using op_ima_obj_attr_set() utilizing the following constants; OPC_INTRPT_METHOD_FORCED, OPC_INTRPT_METHOD_SCHED, and (for packet streams) OPC_INTRPT_METHOD_QUIET.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | integer |
| Access | read/write/promote | read/write |
| Default Value | scheduled | |
| Units | ||
| Constraints | scheduled, quiet, forced (packet streams) scheduled, forced (statistic wires) |
low threshold trigger
If enabled, this attribute specifies that a statistic interrupt is to be generated at the destination module if the value of the destination module's input statistic is updated, and the new value is less than or equal to the specified threshold value. The value of this attribute, like all statistic wire triggers, is examined at the time that a statistic update is received at the destination module, not when the statistic is updated at the source module. A process in the destination module can determine if this type of interrupt is the cause of its invocation by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_STAT indicates a statistic interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle-double | toggle-double |
| Access | read/write/promote | read/write |
| Default Value | disabled | |
| Units | ||
| Constraints |
name
This attribute is a user-assigned identification for the object. The value assigned to this attribute appears below the object icon in node diagrams. It can also be used to refer to the object during simulation or in node model reports. The Simulation Kernel itself makes no use of this attribute. See op_id_from_name() on page 6 for more information.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | br_n; n >= 0 (bus receivers) bt_n; n >= 0 (bus transmitters) assoc (logical associations) strm (packet streams) p_n; n >= 0 (processors) pr_n; n >= 0 (point-to-point receivers) pt_n; n >= 0 (point-to-point transmitters) q_n; n >= 0 (queues) stat_n; n >= 0 (statistic wires) |
|
| Units | ||
| Constraints | unique in node model; no dots |
packet formats
For receiver channels, this attribute specifies the types of packets a channel can receive and forward to other modules in its node. Other types of packets are rejected by the receiver after they have been fully received. The purpose of this attribute is to prevent packets from being received that are inappropriate and cannot be properly processed by the modules connected to the receiver.
For transmitter channels, this attribute specifies the types of packets a channel can accept from other modules in its node and successfully transmit. Other types of packets are enqueued by the transmitter channel, but are discarded when they reach the head of the queue. The purpose of this attribute is to prevent packets from being sent that cannot be properly processed by the nodes that will receive them.
For the channel to be operational, the list specified in this attribute must have at least one packet format in common with the list specified in the packet formats attribute of the bus link.
Note: This attribute is stored as a “comma-separated” string that concatenates sub-strings for each of the supported packet formats. The special sub-string “unformatted” allows the channel to support unformatted packets.
Network models use this attribute as part of a link consistency determination that verifies the compatibility of nodes and links. For more information about link consistency, see Chapter 7 “Network Domain” on page 292.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | “all formatted, unformatted” | |
| Units | ||
| Constraints |
pk capacity
This attribute specifies the maximum number of packets that can be held in a transmission queue or a subqueue. The size of the queue or subqueue (in packets) is the sum of all packets presently contained in the queue. Attempts to insert a packet into the queue that would increase the total number of packets beyond the limit specified by this attribute return a failure status, indicating that the queue is full.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write/promote | read/write |
| Default Value | 1000.0 (transmitter channel) infinity (subqueue) |
|
| Units | packets | |
| Constraints | packet capacity >= 0 |
priority
This attribute is used to determine the execution order of events that are scheduled to occur at the same simulation time. Events scheduled to occur at modules with high priority are processed before events scheduled to occur at modules with lower priority.
Event priority is evaluated hierarchically: subnet priority is more significant than node priority, and node priority is more significant than module priority. For a set of events at the same simulation time, all events in a subnet with high priority are processed before any events in a subnet with low priority. The module priority is used only to order events that occur at modules with identical subnet and node priorities.
This attribute is not used by the parallel simulation kernel.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write/promote | read |
| Default Value | 0 | |
| Units | ||
| Constraints | -32767 <= priority <= 32767 |
process model
This attribute is the name of the process model used for the module's root process. Process models can be developed in the Process Editor to represent any software or hardware functionality. See Chapter 5 “Process Domain” on page 165 for more information on process modeling.
The processor default process model (sink) simply discards packets as it receives them.
The queue default process model (pc_fifo) enqueues packets in the order in which it receives them by adding them to the tail of the queue. It dequeues packets in a first-in-first-out order by removing them from the head of the queue when requested.
| Editing | Simulation | |
|---|---|---|
| Data Type | typed file | string |
| Access | read/write | read/write |
| Default Value | sink (processors) pc_fifo (queues) |
|
| Units | ||
| Constraints |
recovery intrpts
This attribute specifies whether recovery interrupts are scheduled for the object's root process upon recovery of nodes or links in the network model. (Recovery is signaled by transition of the “condition” attribute of the node or link from a value of “disabled” to “enabled”.) Possible values for this attribute are:
- disabled – No recovery interrupts are generated at this module.
- local only – A recovery interrupt is generated at this module only if the node which contains this processor object recovers.
- network wide – A recovery interrupt is generated at this module if any node or link in the network recovers.
Symbolic constants corresponding to the three possible values of this attribute are OPC_INTRPT_DISABLED, OPC_INTRPT_LOCAL_ONLY, and OPC_INTRPT_NETWORK_WIDE.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | integer |
| Access | read/write/promote | read/write |
| Default Value | disabled | |
| Units | ||
| Constraints |
repeated value trigger
If enabled, this attribute specifies that a statistic interrupt is to be generated at the destination module if the value of the destination module's input statistic is updated, and the new value is equal to the old value. The value of this attribute, like all statistic wire triggers, is examined at the time that a statistic update is received at the destination module, not when the statistic is updated at the source module.
A process in the destination module can determine if this type of interrupt is the cause of its invocation by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_STAT indicates a statistic interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write/promote | read/write |
| Default Value | disabled | |
| Units | ||
| Constraints |
rising edge trigger
If enabled, this attribute specifies that a statistic interrupt is to be generated at the destination module if the value of the destination module's input statistic is updated, and the new value is greater than the previous value. The value of this attribute, like all statistic wire triggers, is examined at the time that a statistic update is received at the destination module, not when the statistic is updated at the source module.
A process in the destination module can determine if this type of interrupt is the cause of its invocation by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_STAT indicates a statistic interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write/promote | read/write |
| Default Value | enabled | |
| Units | ||
| Constraints |
src stat
This attribute is the name of the output statistic which acts as the source for the statistic wire. Both pre-defined and user-defined statistics are supported. For user-defined statistics reported by processes, values are updated using the KP op_stat_write().
See the descriptions of specific objects in Node Reference for more information about possible sources of statistics and how they relate to the operation of statistic wires.
Note: Do not use the bit error rate statistic as a value for this attribute.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | string |
| Access | read/write | read |
| Default Value | based on module type | |
| Units | ||
| Constraints | based on module type |
src stream
This attribute is the index of the output stream of the source module to which the packet stream is connected. For example, if this attribute has a value of 2, processes in the source module must pass 2 as the second argument (i.e., the stream index argument) to the KP op_pk_send() to send packets through the stream.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | lowest available stream | |
| Units | ||
| Constraints |
submodule
This attribute is the name of the submodule whose output statistic acts as the source of the statistic wire. The submodule must reside within the statistic wire's source module. The possible submodules are subqueues and the various channel objects associated with the different types of transmitters and receivers. The default value (None) indicates that the output statistic to which this statistic wire is connected belongs to the source module itself, rather than to a submodule included within it. Not all types of source modules support submodules.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | integer |
| Access | read/write | read |
| Default Value | “None” | |
| Units | ||
| Constraints |
subqueue
This attribute specifies the subqueues supported by a queue. The value of this attribute is a compound attribute object (CA object) whose children are the Subqueue Objects. See Chapter 4 “Modeling Framework” on page 80 for more information about compound attributes.
| Editing | Simulation | |
|---|---|---|
| Data Type | compound | compound |
| Access | read/write/promote | read |
| Default Value | ||
| Units | ||
| Constraints |
super priority
This attribute is used to determine the execution order of events that are scheduled to occur at the same simulation time. For a set of events at the same simulation time, all events at modules with this attribute enabled are processed before any events at modules with this attribute disabled, regardless of their hierarchically defined priorities. If more than one module has this attribute enabled, the order of events at these modules is determined according to the normal hierarchical priority scheme.
This attribute is not used by the parallel simulation kernel.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write/promote | read/write |
| Default Value | disabled | |
| Units | ||
| Constraints |
zero crossing trigger
If enabled, this attribute specifies that a statistic interrupt is to be generated at the destination module if the value of the destination module's input statistic is updated, and the new value is one of the following:
- positive, and the old value was negative
- negative, and the old value was positive
- equal to zero
The value of this attribute, like all statistic wire triggers, is examined at the time that a statistic update is received at the destination module, not when the statistic is updated at the source module.
A process in the destination module can determine if this type of interrupt is the cause of its invocation by examining the return value of the Kernel Procedure op_intrpt_type(). A return value of OPC_INTRPT_STAT indicates a statistic interrupt.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write/promote | read/write |
| Default Value | disabled | |
| Units | ||
| Constraints |