|Call (organized by subsystem)||Parameters & examples (see also comments in code)||Return Value||Description||Status||Requested by||Reply to request||Comments / Issues|
|[ ] = may be omitted, x | y = choose x or y||Your name||My response||Any comments or issues you may have with requested or existing features|
|UI_||new_signaling_event||event_name, state_model, domain, [ev_num]|
ex: 'open', 'door', 'elevator'
-- 'door' is the name of a class lifecycle state model
ex: 'customer arrived', 5, 'store management'
-- 5 is the rnum for an assigner state model
|event_number, event_id||Creates a new Signaling Event on the specified Lifecycle. An Event ID will be generated along with an Event Specification number, if none is specified. Both the assigned Event.ID and Event Specification.Number will be returned. If a desired Event Specification number is specified, it will be used unless the number is already taken, in which case any available number will be assigned.|
Also a Non-Transition Response of 'Can't Happen' is created by default for each State in the State Model.
|UI_||new_creation_event||event_name, class_name, to_state, domain, [ev_num]||event_number, event_id||Defines a new Creation Event on the specified Lifecycle. An Event ID will be generated along with an Event Specification number, if none is specified. Both the assigned Event.ID and Event Specification.Number will be returned. If a desired Event Specification number is specified, it will be used unless the number is already taken, in which case any available number will be assigned.||Tested OK|
|UI_||set_creation_state||class_name, domain, new_to_state||none||Changes the State where an instances are created with the existing Creation Event.||Tested OK|
|UI_||new_polymorphic_event||event_name, superclass_name, domain, [gen_rnum], [ev_num]|
ex: 'Start', 'Connector', 'Gas', 2, 12
Poly event spec '12:Start' is defined on the 'Connector' superclass and delegated down Generalization R2 only.
ex: 'Start', 'Connector', 'Gas'
Poly event spec '<n>:Start' is defined on the 'Connector' superclass and delegated down ALL Generalizations where 'Connector' is the superclass.
|event_number, event_id||Creates a Polymorphic Event Specification, a Delegated Event for the specified Superclass and an Inherited Effective Event on each Subclass reached through the supplied Generalization. The user can further delegate a subclass event if desired by further delegating it in a separate operation.|
If the specified Class plays multiple Superclass roles (is the root of a compound Generalization), the event will be delegated down each Generalization. If an Rnum is supplied, however, the event will be delegated down the specified Generalization only.
The Event Spec number and Local Delegated Event ID is returned.
|UI_||delete_event||state_model, event_name, domain||none||Deletes an Event Specification and any corresponding Events. If this is a Monomorphic Event Specification, then only one Event will be deleted. Otherwise, it is polymorphic and all descendant Events (Inherited / Delegated) will be deleted.||Tested OK|
|UI_||delegate_event||event_name, evspec class name, domain, [delegation class name], [delegation rnum]||none||Delegates an Effective Signaling Event so that it is handled in the Subclass Lifecycle State Models of the specified Generalization. If no Generalization is specified, the Event is delegated down all Generalizations rooted in the specified Class.||Tested OK|
|UI_||undelegate_event||event_name, evspec class name, domain, delegation class name, [delegation rnum]||none||Migrates a Delegated Event to an Effective Event. If the specified Event is a Local Delegated Event (on the same class as its Polymorphic Event Spec), and un-delegation would result in no Inherited Effective Events descended from the Polymorphic Event Spec, the Polymorphic Event Spec is migrated to Monomorphic.||Tested OK|
|UI_||add_param_to_state_sig||param_name, type, state_name, state_model, domain||none||Defines a new State Model Parameter and associates it with an existing State Model Signature. An attempt is made to update each of the Event Signatures associated with any Signaling Events on Transitions leading into the State.||Tested OK|
|UI_||add_param_to_event_sig||param_name, type, event_name, state_model, domain||none||Defines a new State Model Parameter and associates it with an existing Event Signature. An attempt is made to update any State Signature on the destination of any Transition triggered by an Event defined by the Event Specification.||Tested OK|
|UI_||new_deletion_pstate||state_name, class_name, domain||none||Creates a new Deletion Pseudo State in the specified Lifecycle State Model.||Tested OK|
|UI_||new_state||state_name, state_model, domain, [snum]||state_number||Creates a new State in the specified State Model. Uses the optional state number if it is not currently in use in the same State Model. Otherwise, the lowest available number is assigned. In either case the number is returned. Fails if the State Model does not exist or it already has a State with the same name.||Tested OK|
|UI_||set_dest_name||old_name, domain, new_name||none||Renames a Destination (State or Deletion Pseudo State).||Tested OK|
|UI_||delete_state||state_name, state_model, domain||none||Deletes a Destination which may be a State or Deletion Pseudo State.||Tested OK|
|UI_||set_state_number||state_name, domain, new_number||none||Attempts to assign the desired state number. Fails if the number already assigned to another State in the same State Model.||Tested OK|
|UI_||new_lifecycle||class_name, domain||none||Creates a new Lifecycle State Model on the specified Class. Error returned if one is already defined.||Tested OK|
|UI_||new_single_assigner||assoc_rnum, domain||none||Creates a new Single Assigner State Model on the specified Association. Error returned if one is already defined.||Tested OK|
|UI_||new_multiple_assigner||assoc_rnum, loop_number, partition_class_name, domain|
-- The rnum and the partition class must be in the same loop
|none||Creates a new Multiple Assigner State Model on the specified Association. Error returned if one is already defined. Also, both Constrained Loop and partitioning Class will be validated to ensure that the meet requirements annotated in signature above.||Tested OK|
|UI_||delete_state_model||state_model, domain||none||Removes a State Model along with any of its Events, States, Transitions, etc.||Tested OK|
|UI_||set_partition_class||assoc_rnum, domain, new_part_class_name||none||Changes the partitioning Class defined on an Multiple Assigner.||Tested OK|
|UI_||multiple_assigner_to_single||assoc_rnum, domain||none||Converts a Multiple to a Single Assigner||Tested OK|
|UI_||single_assigner_to_multiple||assoc_rnum, domain, partition_class_name, loop_number||none||Converts a SIngle to a Multiple Assigner||Tested OK|
|Event Response / Transition|
|UI_||new_transition||from_state_name, dest_name, event_name, state_model, domain||none||Creates a Transition from a State to a Destination State or Deletion Pseudo State.||Tested OK|
|UI_||delete_transition||from_state_name, event_name, state_model, domain, ['CH' | 'IGN'], [reason]||none||Deletes the specified Transition. Actually, it converts a Transition Response into a Non-Transition Response which is CH (can't happen), by default. By default the reason is 'Transition deleted'.||Tested OK|
|UI_||set_transition_destination||from_state_name, event_name, state_model, domain, new_dest_name||none||Changes the destination of an existing Transition.||Tested OK|
|UI_||set_nt_response||state_name, event_name, state_model, domain, ['CH' | 'IGN' ], [reason]||none||Sets the behavior and reason characteristics of an existing Non-Transition Event Response.||Tested OK|
|UI_||set_default_initial_state_name||name||none||Sets the default name that will be used for the state automatically created with a new State Model.||Tested OK|
|UI_||set_max_event_specs||ceiling_value||none||This number is used as the maximum bound when searching for duplicate values during ev spec number assignment. It should always be MUCH higher than the anticipated maximum events specified on any single State Model. Since it is typical to have 1-30 events on a State Model, the number should never be lower than 100. Too high a value will increast the time it takes to assign a new event spec number. So don't make it 1,000,000! Unless there is some reason to change it, 200 is a safe ceiling. There's something terribly wrong with a State Model that approaches even 100 event specs.|
The number cannot be changed to a value lower than the maximum assigned event spec number, across ALL domains. This maximum event spec value, can be changed to a lower value so that the ceiling can be lowered, however.
|UI_||set_max_states||ceiling_value||none||This number is used as the maximum bound when searching for duplicate values during state number assignment. It should always be MUCH higher than the anticipated maximum states in any single State Model. Since it is typical to have 1-20 events on a State Model, the number should never be lower than 50. Too high a value will increast the time it takes to assign a new event spec number. So don't make it 1,000,000! Unless there is some reason to change it, 200 is a safe ceiling. There's something terribly wrong with a State Model that approaches even 30 states.|
The number cannot be changed to a value lower than the maximum assigned state number, across ALL domains. This maximum state number value, can be changed to a lower value so that the ceiling can be lowered, however.
|Request calls below|