SyncWire extends Wire

Examples

• HiddenFieldSyncWire.iaml (source)
  • Connecting a hidden Label element with a SyncWire. [HiddenFieldSyncWire]
• InputTextFieldDataTypeSync.iaml (source)
  • SyncWires connected between InputTextFields ofdifferent types. [InputTextFieldDataTypeSync]
• SetWireSyncChained.iaml (source)
  • Chaining SetWires and SyncWirestogether across multiple Frames. [SetWireSyncChained]

Implementation Notes

• A new DomainType with inheritanceconnected to an InputForm witha SyncWire will populate the InputForm with an InputTextFieldfor all inherited DomainAttributes. [DomainInheritanceEditing]
• If a MapPoint is connected to a SyncWire, then the value obtained from the SyncWire will be used to initially populate the MapPoint if the value is empty. [MapPoint]
• A InputTextField connected by a SetWire or SyncWire to a Value with a defaultValue set will be initialised with this default value at runtime, if the text field does not yet have a value. [InputTextField]

Inference Rules

• An ActivityOperation named 'validate', used to check the validity of two type instances of two InputTextFields connected via a SyncWire, will be completed with the necessary ActivityNodes to implement this functionality. [validate]
• A SyncWire connecting two elements with a Function 'can sync?' will only permit synchronisation if the value can be cast successfully. [casting]
• When a Changeable is connected to a ContainsOperations by a SyncWire, the source element will call the 'update' Operation on the target when the source changes. [sync-wires]
• When a ContainsOperations element is connected to an Accessible element by a SyncWire, the source element will call the 'init' Operation on the target when the target is accessed. [sync-wires]
• When an InputTextField is connected to a ContainsOperations by a instant SyncWire, the source element will call the 'update' Operation on the target when the source input changes. [sync-wires]
• Two differently- typed InputTextFields connected via a SyncWire will define an Operation within the first field named 'validate'. [validate]
• A SyncWire connecting an DomainIterator to a CanBeSynced object will create sub- SyncWires between every contained object within the contained DomainInstance to every contained CanBeSynced object which have matching names. [sync-wires]
• A SyncWire connecting two objects will create sub- SyncWires between every contained object within these parent objects which have matching names. [sync-wires]
• For elements connected by a SyncWire, the onAccess Event executing the 'init' Operation will only execute if the source fieldValue can be cast successfully. [casting]
• For elements connected by a SyncWire, the onAccess Event will only call the 'validate' Operation if the relevant fieldValue is set. [casting]
• When a CanBeSynced element is connected to an CanBeSynced element by a SyncWire, the value of the source element will be provided as a Parameter to the updating ECARule. [sync-wires]
• An empty InputForm connected to a DomainIterator with a SyncWire will create an InputTextField in that form for every DomainAttributeInstance that is not a primary key or foreign key. [sync-wires]
• A SyncWire connecting a 'new' DomainIterator to an InputForm should only execute the 'init' Operation on the created Labels when the label is accessed if the DomainInstance is not empty. [sync-wires]
• All conditions against a SyncWire will be copied to each ECARule subsequently created as connected to the onAccess Events. [conditions]
• All conditions against a SyncWire will be copied to each ECARule subsequently created as connected to the onChange Events. [conditions]
• All Parameters for each conditions against a SyncWire will be copied to each ECARule subsequently created as connected to the onAccess Events. [conditions]
• All Parameters for each conditions against a SyncWire will be copied to each ECARule subsequently created as connected to the onChange Events. [conditions]
• An InputForm connected to another InputForm with a SyncWire will create an InputTextField in the target form for every InputTextField in the source form with the same name. [sync-wires]
• An InputForm connected to another InputForm with a SyncWire will create a Label in the target form for every Label in the source form with the same name. [sync-wires]
• The 'validate' Operation defined to validate the type instances of two differently- typed InputTextFields connected via a SyncWire will be executed when one of the fields change. [validate]
• When an InputTextField is connected to a CanBeSynced element by an instant SyncWire, the value of the source element will be provided as a Parameter to the updating ECARule. [sync-wires]
• For elements connected by a SyncWire, the 'onAccess' Event executing the 'init' Operation will only execute if the source fieldValue can be cast successfully. [casting]
• When a CanBeSynced element is connected to a CanBeSynced element by a SyncWire, the fieldValue of the source element will be used as a Parameter to initialise the target through the 'init' Operation. [sync-wires]
• A parent SyncWire connecting a Session-contained Frame to a ContainsOperations element outside of that Session, will call the 'init' Operation generated by each sub- SyncWire when the Session is initialised. [sync-wires]
• A parent SyncWire connecting a Session-contained VisibleThing to a ContainsOperations element outside of that Session, will call the 'init' Operation generated by each sub- SyncWire when the Session is initialised. [sync-wires]
• Every 'init' Operation executed when a Session is initialised due to a SyncWire between a Frame within that session, to another element outside of that session, will be provided the fieldValue of the source element as a Parameter. [sync-wires]
• Every 'init' Operation executed when a Session is initialised due to a SyncWire between a VisibleThing within that session, to another element outside of that session, will be provided the fieldValue of the source element as a Parameter. [sync-wires]
• A sub- SyncWire generated for a parent SyncWire connected to a DomainIterator will also be restricted with all of the SimpleConditions of the parent wire. [sync-wires]
• A sub- SyncWire generated for a parent SyncWire will also be restricted with all of the SimpleConditions of the parent wire. [sync-wires]
• All restrictions derived by copying the SimpleConditions of parent SyncWires involving a DomainIterator to their sub- SyncWires will also be provided with the same Parameters. [sync-wires]
• All restrictions derived by copying the SimpleConditions of parent SyncWires to their sub- SyncWires will also be provided with the same Parameters. [sync-wires]
• When a ContainsOperations element is connected to an Accessible element by a SyncWire, the target element will only be initialised if the source value is set. [sync-wires]

Constraints

• "A SyncWire cannot connect to itself" [Checks.chk]
• "You cannot have a SyncWire that connects to a QueryParameter" [Checks.chk]
• "You cannot have a SyncWire that connects to a read-only Property" [Checks.chk]
• "You cannot have a SyncWire connecting two Values" [Checks.chk]
• "A SyncWire cannot connect to an Email" [Checks.chk]
• "A Wire must have a 'from'" [Checks.chk] [from Wire]
• "A Wire must have a 'to'" [Checks.chk] [from Wire]

Attributes

• executeOnInput : EBoolean (optional)
  If true, then this SyncWire will also try to synchronise these two elements when the onInput event is triggered.

Inherited Attributes

• generatedRule : EString (optional)
  To assist in debugging, this attribute may be populated with the name of the model completion rule that created this element. More extensive traceability support may be provided in the future.
• id : EString (optional)
  A unique identifier for this model element. Should be globally unique.
• isGenerated : EBoolean (optional)
  Set to true if the current element has been generated.
• name : EString (optional)
  A non-unique string that names a given object.
• overridden : EBoolean (optional)
  If a GeneratesElements is overridden, then this element will not generate any elements directly.
• overriddenNames : EString (optional)
  When applying model completion, no NamedElements with these names will be generated by this element.

Children

Inherited Children

• conditionEdges : [0...*] SimpleCondition
  A list of contained SimpleConditions.
• constraintEdges : [0...*] ConstraintEdge
  A list of contained ConstraintEdges.
• ecaRules : [0...*] ECARule
  A list of contained ECARules.
• extendsEdges : [0...*] ExtendsEdge
  A list of contained ExecutionEdges.
• parameterEdges : [0...*] Parameter
  A list of contained Parameters.
• providesEdges : [0...*] ProvidesEdge
  A list of contained ProvidesEdges.
• requiresEdges : [0...*] RequiresEdge
  A list of contained RequiresEdges.
• schemaEdges : [0...*] SchemaEdge
  A list of contained SchemaEdges.
• selectEdges : [0...*] SelectEdge
  A list of contained SelectEdges.
• wires : [0...*] Wire
  A list of contained Wires.

References

Inherited References

• conditions : [0...*] ComplexTerm [opposite: conditioned]
  A list of incoming Conditions that may restrict the behaviour of this element.
• from : [1] WireSource [opposite: outWires]
  The source of a Wire.
• generatedBy : [0...*] GeneratesElements [opposite: generatedElements]
  A list of elements that generated this element; conversely, overriding the source will prevent this element from being created.
• generatedElements : [0...*] GeneratedElement [opposite: generatedBy]
  A list of GeneratedElements that this element has generated through model completion.
• inParameterEdges : [0...*] Parameter [opposite: parameterTerm]
  A list of incoming Parameters.
• to : [1] WireDestination [opposite: inWires]
  The target of a Wire.

Extensions

Inherited Extensions

• model::visual::Frame containingFrame(model::NamedElement this) [Extensions.ext]
• model::Scope containingScope(model::NamedElement this) [GeneratorExtensions.ext]
• model::visual::Frame frameContainingOperation(model::NamedElement this) [GeneratorExtensions.ext]
• safeName(model::GeneratedElement this) [GeneratorExtensions.ext]
• simpleName(model::NamedElement this) [GeneratorExtensions.ext]