API Scope.AddOp - Revision history

JonnyW: XML import

2014-01-16T15:57:57Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:38Z

XML import of API documentation

JonnyW: XML import of updated API docs

2013-06-17T09:58:01Z

XML import of updated API docs

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:13Z

XML Import to change Variable types into Variable Types

JonnyW: XML import API changes

2013-05-14T13:15:30Z

XML import API changes

Admin: XML import

2013-05-12T21:53:25Z

XML import

Admin: XML import

2013-05-12T21:29:11Z

XML import

Admin: XML import

2013-05-12T21:17:42Z

XML import

Admin: XML import

2013-05-12T01:54:28Z

XML import

Admin: XML import

2013-05-11T22:10:01Z

XML import

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<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

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<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

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Adds an operation to act on the inputs of the stream
@@ Line 105: / Line 107: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddOp(streamh, ::Scope.Op_Bound, arg)</pre>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''

@@ Line 10: / Line 10: @@
 ==Parameters==
-[[Variable types|HANDLE]] ''StreamH''
+[[Variable Types|HANDLE]] ''StreamH''
 :A handle to a previously created datascope stream
-[[Variable types|ULONG]] ''FuncOp''
+[[Variable Types|ULONG]] ''FuncOp''
 :An operation to perform on the input
 :''Typical values for this parameter:''
@@ Line 85: / Line 85: @@
 |}
-[[Variable types|FLOAT]] ''Arg''
+[[Variable Types|FLOAT]] ''Arg''
 :An optional argument that may be used by the FuncOp
 :''The default value for this parameter is: '''''0'''
@@ Line 91: / Line 91: @@
 ==Return value==
-[[Variable types|BOOL]]
+[[Variable Types|BOOL]]
 Returns true if the operation is a success, else false

@@ Line 92: / Line 92: @@
 ==Return value==
 [[Variable types|BOOL]]
 Returns true if the operation is a success, else false

@@ Line 15: / Line 15: @@
 [[Variable types|ULONG]] ''FuncOp''
 :An operation to perform on the input
-''Typical values for this parameter:''
+:''Typical values for this parameter:''
-{| class="wikitable" width="75%"
+::{| class="wikitable" width="65%"
 |-
 ! width="30%" |Name
-! width="50%" |Description
+! width="55%" |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)
@@ Line 115: / Line 93: @@
 [[Variable types|BOOL]]
-''<span style="color:red;">No additional information</span>''
+Returns true if the operation is a success, else false

@@ Line 16: / Line 16: @@
 :An operation to perform on the input
 ''Typical values for this parameter:''
-{| class="wikitable" |-width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Op_Bound|1
+{| class="wikitable" width="75%"
-|-LONG|Op_Scale|2
+|-
-|-LONG|Op_Xor|3
+! width="20%" |Type
-|-LONG|Op_AndNot|4
+! width="30%" |Name
-|-LONG|Op_And|5
+! width="50%" |Description
-|-LONG|Op_Orr|6
+|-
-|-LONG|Op_Not|7
+|LONG
-|-LONG|Op_Add|8
+|Op_Bound
-|-LONG|Op_Sub|9
+|Bound the current value to the expected range of the input
-|-LONG|Op_Mul|10
+|-
-|-LONG|Op_Div|11
+|LONG
-|-LONG|Op_Pow|12
+|Op_Scale
-|-LONG|Op_Neg|13
+|Divide the current value to the expected range of the input
-|-LONG|Op_Recip|14
+|-
-|-LONG|Op_Sqrt|15
+|LONG
-|-LONG|Op_Ln|16
+|Op_Xor
-|-LONG|Op_Ln2|17
+|Exclusive-or with the provided integer argument
-|-LONG|Op_Cos|18
+|-
-|-LONG|Op_Sin|19
+|LONG
-|-LONG|Op_Tan|20
+|Op_AndNot
-|-LONG|Op_Int|21
+|Clear the bits in the provided integer argument
 |}

@@ Line 3: / Line 3: @@
 <div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API Scope|Scope]]
+====Class hierarchy====
 :[[API Scope|AddOp]]
 </div>
@@ Line 9: / Line 10: @@
 ==Parameters==
-''[[Variable types|HANDLE]] StreamH''
+[[Variable types|HANDLE]] ''StreamH''
 :A handle to a previously created datascope stream
-''[[Variable types|ULONG]] FuncOp''
+[[Variable types|ULONG]] ''FuncOp''
 :An operation to perform on the input
 ''Typical values for this parameter:''
@@ Line 38: / Line 39: @@
 |}
-''[[Variable types|FLOAT]] Arg''
+[[Variable types|FLOAT]] ''Arg''
 :An optional argument that may be used by the FuncOp
 :''The default value for this parameter is: '''''0'''
@@ Line 45: / Line 46: @@
 [[Variable types|BOOL]]
-No additional information
+''<span style="color:red;">No additional information</span>''
 ==Detailed description==
-''No additional information''
+''<span style="color:red;">No additional information</span>''
 ==Examples==
@@ Line 54: / Line 58: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddOp(streamh, ::Scope.Op_Bound, arg)</pre>