RubyEditConnector objects are sent by FlowStone to a RubyEdit's 'event' method in order to identify which connector just received a new value or trigger. They contain some clever code so that the connector can easily be identified either by its index or its label using pretty much the same code.
Multiplies the RubyEditConnector's index by the value and returns this value.
# File Flowstone API.rb, line 1265 def *(other) #DUMMY end
Adds the RubyEditConnector's index to the value and returns this value.
# File Flowstone API.rb, line 1238 def +(other) #DUMMY end
Subtracts the value from the RubyEditConnector's index and returns this value.
# File Flowstone API.rb, line 1256 def -(other) #DUMMY end
Divides the RubyEditConnector's index by the value and returns this value.
# File Flowstone API.rb, line 1247 def /(other) #DUMMY end
Returns true if the RubyEditConnector's index is less than the number.
# File Flowstone API.rb, line 1220 def <(other) #DUMMY end
Returns true if the RubyEditConnector's index is less than or equal to the number.
# File Flowstone API.rb, line 1229 def <=(other) #DUMMY end
Compares the index of the RubyEditConnector with the given number. Returns -1 if less, 0 if equal, or 1 if greater than the number.
# File Flowstone API.rb, line 1193 def <=>(other) #DUMMY end
Tests the identity of the connector. If an number is given, the connector's index is compared. If a String is given, the connector label is compared.
Example:
def event(in_id) if in_id == 0 watch "The first input was just triggered" end if in_id == "my_input" watch "The connector labelled 'my_input' was just triggered" end end
# File Flowstone API.rb, line 1128 def ==(other) #DUMMY end
You will be unlikely to use this directly in your code. '===' is the special form of comparison used by 'case' statements. Like '==', it can compare against either a connector's index, or its label.
Example:
def event(in_id) case in_id when 0 watch "The first input just triggered" when "my_input" watch "The connector labelled 'my_input' triggered" else watch "I don't recognise this input" end # the 'case' statement end
# File Flowstone API.rb, line 1151 def ===(other) #DUMMY end
Returns true if the RubyEditConnector's index is greater than the number.
# File Flowstone API.rb, line 1202 def >(other) #DUMMY end
Returns true if the RubyEditConnector's index is greater than or equal to the number.
# File Flowstone API.rb, line 1211 def >=(other) #DUMMY end
Generated with the Darkfish Rdoc Generator 2.