Difference between revisions of "API Scope"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
Line 31: | Line 31: | ||
==Constants provided for this class== | ==Constants provided for this class== | ||
− | {| class="wikitable" | + | {| class="wikitable" width="85%" |
|- | |- | ||
− | !width=" | + | !width="15%"|Type |
− | !width=" | + | !width="25%"|Name |
− | !width=" | + | !width="20%"|Value |
+ | !width="50%"|Value | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Bound | |Op_Bound | ||
|1 | |1 | ||
+ | |Bound the current value to the expected range of the input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Scale | |Op_Scale | ||
|2 | |2 | ||
+ | |Divide the current value to the expected range of the input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Xor | |Op_Xor | ||
|3 | |3 | ||
+ | |Exclusive-or with the provided integer argument | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_AndNot | |Op_AndNot | ||
|4 | |4 | ||
+ | |Clear the bits in the provided integer argument | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_And | |Op_And | ||
|5 | |5 | ||
+ | |Isolate only the bits in the provided integer argument | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Orr | |Op_Orr | ||
|6 | |6 | ||
+ | |Set the bits in the provided integer argument | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Not | |Op_Not | ||
|7 | |7 | ||
+ | |Invert (ones-compliment) the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Add | |Op_Add | ||
|8 | |8 | ||
+ | |Add the argument to the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Sub | |Op_Sub | ||
|9 | |9 | ||
+ | |Subtract the argument from the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Mul | |Op_Mul | ||
|10 | |10 | ||
+ | |Multiply the argument by the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Div | |Op_Div | ||
|11 | |11 | ||
+ | |Divide the current input by the argument | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Pow | |Op_Pow | ||
|12 | |12 | ||
+ | |Raise the input to the power of the argument | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Neg | |Op_Neg | ||
|13 | |13 | ||
+ | |Negate (twos compliment) the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Recip | |Op_Recip | ||
|14 | |14 | ||
+ | |Perform the reciprocal on the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Sqrt | |Op_Sqrt | ||
|15 | |15 | ||
+ | |Perform a square root on the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Ln | |Op_Ln | ||
|16 | |16 | ||
+ | |Perform a natural logarithm on the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Ln2 | |Op_Ln2 | ||
|17 | |17 | ||
+ | |Perform a base-2 logarithm on the current input | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Cos | |Op_Cos | ||
|18 | |18 | ||
+ | |Convert the input to its cosine value (input is in radians) | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Sin | |Op_Sin | ||
|19 | |19 | ||
+ | |Convert the input to its sine value (input is in radians) | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Tan | |Op_Tan | ||
|20 | |20 | ||
+ | |Convert the input to its tangent value (input is in radians) | ||
|- | |- | ||
|LONG | |LONG | ||
|Op_Int | |Op_Int | ||
|21 | |21 | ||
+ | |Convert the input from a float to an integer (using the floor function) | ||
|} | |} | ||
Revision as of 21:17, 12 May 2013
<sidebar>API contents</sidebar> Data scope additions
Contents
Functions provided for this class
AddGroup | Adds a group to the scope to which streams may be added |
AddStream | Adds a stream to the given group suitable for inputs and operations |
AddPort | Adds an input to the stream from a port |
AddAnalog | Adds an input to the stream from an analog channel |
AddCustom | Adds an input to the stream from a custom injection |
AddOp | Adds an operation to act on the inputs of the stream |
SetCustom | Sets one of 32 custom analog values for the group |
Constants provided for this class
Type | Name | Value | Value |
---|---|---|---|
LONG | Op_Bound | 1 | Bound the current value to the expected range of the input |
LONG | Op_Scale | 2 | Divide the current value to the expected range of the input |
LONG | Op_Xor | 3 | Exclusive-or with the provided integer argument |
LONG | Op_AndNot | 4 | Clear the bits in the provided integer argument |
LONG | Op_And | 5 | Isolate only the bits in the provided integer argument |
LONG | Op_Orr | 6 | Set the bits in the provided integer argument |
LONG | Op_Not | 7 | Invert (ones-compliment) the current input |
LONG | Op_Add | 8 | Add the argument to the current input |
LONG | Op_Sub | 9 | Subtract the argument from the current input |
LONG | Op_Mul | 10 | Multiply the argument by the current input |
LONG | Op_Div | 11 | Divide the current input by the argument |
LONG | Op_Pow | 12 | Raise the input to the power of the argument |
LONG | Op_Neg | 13 | Negate (twos compliment) the current input |
LONG | Op_Recip | 14 | Perform the reciprocal on the current input |
LONG | Op_Sqrt | 15 | Perform a square root on the current input |
LONG | Op_Ln | 16 | Perform a natural logarithm on the current input |
LONG | Op_Ln2 | 17 | Perform a base-2 logarithm on the current input |
LONG | Op_Cos | 18 | Convert the input to its cosine value (input is in radians) |
LONG | Op_Sin | 19 | Convert the input to its sine value (input is in radians) |
LONG | Op_Tan | 20 | Convert the input to its tangent value (input is in radians) |
LONG | Op_Int | 21 | Convert the input from a float to an integer (using the floor function) |
Examples
No additional information
See also
No additional information