Difference between revisions of "API Scope.AddOp"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
wiki page name
+
<sidebar>API Contents</sidebar>
 
Adds an operation to act on the inputs of the stream
 
Adds an operation to act on the inputs of the stream
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API Scope|Scope]]
 +
:[[API Scope|AddOp]]
 +
</div>
 +
__TOC__
  
−
===Parameters===
+
==Parameters==
−
''[[Variable types|HANDLE]] StreamH''
+
[[Variable Types|HANDLE]] ''StreamH''
 
:A handle to a previously created datascope stream
 
:A handle to a previously created datascope stream
  
−
''[[Variable types|ULONG]] FuncOp''
+
[[Variable Types|ULONG]] ''FuncOp''
 
:An operation to perform on the input
 
:An operation to perform on the input
−
''Typical values for this parameter:''
+
:''Typical values for this parameter:''
−
{| class="wikitable" |+width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Op_Bound|1
+
::{| class="wikitable" width="65%"
−
|-LONG|Op_Scale|2
+
|-
−
|-LONG|Op_Xor|3
+
! width="30%" |Name
−
|-LONG|Op_AndNot|4
+
! width="55%" |Description
−
|-LONG|Op_And|5
+
|-
−
|-LONG|Op_Orr|6
+
|Op_Bound
−
|-LONG|Op_Not|7
+
|Bound the current value to the expected range of the input
−
|-LONG|Op_Add|8
+
|-
−
|-LONG|Op_Sub|9
+
|Op_Scale
−
|-LONG|Op_Mul|10
+
|Divide the current value to the expected range of the input
−
|-LONG|Op_Div|11
+
|-
−
|-LONG|Op_Pow|12
+
|Op_Xor
−
|-LONG|Op_Neg|13
+
|Exclusive-or with the provided integer argument
−
|-LONG|Op_Recip|14
+
|-
−
|-LONG|Op_Sqrt|15
+
|Op_AndNot
−
|-LONG|Op_Ln|16
+
|Clear the bits in the provided integer argument
−
|-LONG|Op_Ln2|17
+
|-
−
|-LONG|Op_Cos|18
+
|Op_And
−
|-LONG|Op_Sin|19
+
|Isolate only the bits in the provided integer argument
−
|-LONG|Op_Tan|20
+
|-
−
|-LONG|Op_Int|21
+
|Op_Orr
 +
|Set the bits in the provided integer argument
 +
|-
 +
|Op_Not
 +
|Invert (ones-compliment) the current input
 +
|-
 +
|Op_Add
 +
|Add the argument to the current input
 +
|-
 +
|Op_Sub
 +
|Subtract the argument from the current input
 +
|-
 +
|Op_Mul
 +
|Multiply the argument by the current input
 +
|-
 +
|Op_Div
 +
|Divide the current input by the argument
 +
|-
 +
|Op_Pow
 +
|Raise the input to the power of the argument
 +
|-
 +
|Op_Neg
 +
|Negate (twos compliment) the current input
 +
|-
 +
|Op_Recip
 +
|Perform the reciprocal on the current input
 +
|-
 +
|Op_Sqrt
 +
|Perform a square root on the current input
 +
|-
 +
|Op_Ln
 +
|Perform a natural logarithm on the current input
 +
|-
 +
|Op_Ln2
 +
|Perform a base-2 logarithm on the current input
 +
|-
 +
|Op_Cos
 +
|Convert the input to its cosine value (input is in radians)
 +
|-
 +
|Op_Sin
 +
|Convert the input to its sine value (input is in radians)
 +
|-
 +
|Op_Tan
 +
|Convert the input to its tangent value (input is in radians)
 +
|-
 +
|Op_Int
 +
|Convert the input from a float to an integer (using the floor function)
 
|}
 
|}
  
−
''[[Variable types|FLOAT]] Arg''
+
[[Variable Types|FLOAT]] ''Arg''
 
:An optional argument that may be used by the FuncOp
 
:An optional argument that may be used by the FuncOp
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
  
−
===Return value===
 
−
[[Variable types|BOOL]]
 
  
−
No additional information
+
==Return value==
 +
[[Variable Types|BOOL]]
  
−
===Detailed description===
+
Returns true if the operation is a success, else false
−
''No additional information''
 
  
−
===Examples===
+
 
−
====Calling in a calculation====
+
==Detailed description==
 +
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
−
* Add to a calculation icon: result = ::Scope.AddOp(streamh, ::Scope.Op_Bound, arg)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddOp(streamh, ::Scope.Op_Bound, arg)</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Adds an operation to act on the inputs of the stream

Class hierarchy

Scope

AddOp

Parameters

HANDLE StreamH

A handle to a previously created datascope stream

ULONG FuncOp

An operation to perform on the input
Typical values for this parameter:
Name Description
Op_Bound Bound the current value to the expected range of the input
Op_Scale Divide the current value to the expected range of the input
Op_Xor Exclusive-or with the provided integer argument
Op_AndNot Clear the bits in the provided integer argument
Op_And Isolate only the bits in the provided integer argument
Op_Orr Set the bits in the provided integer argument
Op_Not Invert (ones-compliment) the current input
Op_Add Add the argument to the current input
Op_Sub Subtract the argument from the current input
Op_Mul Multiply the argument by the current input
Op_Div Divide the current input by the argument
Op_Pow Raise the input to the power of the argument
Op_Neg Negate (twos compliment) the current input
Op_Recip Perform the reciprocal on the current input
Op_Sqrt Perform a square root on the current input
Op_Ln Perform a natural logarithm on the current input
Op_Ln2 Perform a base-2 logarithm on the current input
Op_Cos Convert the input to its cosine value (input is in radians)
Op_Sin Convert the input to its sine value (input is in radians)
Op_Tan Convert the input to its tangent value (input is in radians)
Op_Int Convert the input from a float to an integer (using the floor function)

FLOAT Arg

An optional argument that may be used by the FuncOp
The default value for this parameter is: 0


Return value

BOOL

Returns true if the operation is a success, else false


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon: 
    result = ::Scope.AddOp(streamh, ::Scope.Op_Bound, arg)

No additional examples

Retrieved from "https://www.matrixtsl.com/wikiv7/index.php?title=API_Scope.AddOp&oldid=13872"