Custom Animation Probe Object

Custom animation probes are used to enable specific objects within a network model to act as sources of custom animation requests. Custom animation requests are generated by calls to the Kernel Procedures (KPs) of the Animation package in the Simulation Kernel. Calls to such KPs may be made by user-defined process models or pipeline stages. Therefore, the calls are associated with processors, queues, transmitters, and receivers.

For a custom animation KP call to be effective, the corresponding module (i.e., the module executing at the time of the call) must be enabled by a custom animation probe. The scope of a probe is determined hierarchically, using the same relationships that exist between objects in the various modeling domains. In other words, enabling a node implicitly enables all modules within it. Similarly, enabling a subnet enables all nodes within it, which in turn enables the modules contained within the nodes.

The following table lists the built-in attributes of the custom animation probe object. For attribute definitions, see Probe Object Attribute Descriptions.

Table 41: Custom Animation Probe Object Attributes

Name Data Type
name string
subnet string
node string
module string
label string
anim start double
anim stop double
window name string
window x integer
window y integer
window width integer
window height integer
src objid integer