Pool Functions ¶ BlockGetData (Function) PoolCreateH (Function) PoolCreateP (Function) PoolDelete (Function) PoolExtendH (Function) PoolGetBlock (Function) PoolGetSize (Function) PoolPutBlock (Function)
BlockGetData (FUN) ¶ FUNCTION BlockGetData : CAA.PVOID InOut: Scope Name Type Return BlockGetData CAA.PVOID Input hBlock CAA.HANDLE peError POINTER TO ERROR
PoolCreateH (FUN) ¶ FUNCTION PoolCreateH : CAA.HANDLE Take a pool of ctNumBlocks * szBlockSize bytes from the Heap(OS) and build a block pool InOut: Scope Name Type Return PoolCreateH CAA.HANDLE Input ctNumBlocks CAA.COUNT szBlockSize CAA.SIZE eEmpty CB.EVENT peError POINTER TO ERROR
PoolCreateP (FUN) ¶ FUNCTION PoolCreateP : CAA.HANDLE Take as much as possible block of szBlockSize bytes from a PLC(IEC) provided memory and build a block pool InOut: Scope Name Type Return PoolCreateP CAA.HANDLE Input szBlockSize CAA.SIZE szMemSize CAA.SIZE pMemory CAA.PVOID eEmpty CB.EVENT peError POINTER TO ERROR
PoolDelete (FUN) ¶ FUNCTION PoolDelete : ERROR Deletes a block pool created by PoolCreateX provided that all blocks are free If a block is in use, this call aborts InOut: Scope Name Type Return PoolDelete ERROR Input hPool CAA.HANDLE
PoolExtendH (FUN) ¶ FUNCTION PoolExtendH : ERROR InOut: Scope Name Type Return PoolExtendH ERROR Input hPool CAA.HANDLE ctNumBlocks CAA.COUNT
PoolGetBlock (FUN) ¶ FUNCTION PoolGetBlock : CAA.HANDLE Gets the next available block from hPool and returns ist handle InOut: Scope Name Type Return PoolGetBlock CAA.HANDLE Input hPool CAA.HANDLE peError POINTER TO ERROR
MakeNormed3D (FUN) ¶ FUNCTION MakeNormed3D : BOOL This function will scale an input vector \(v \in \mathbb{R^{3}}\) to norm 1, as far as \(v\) is not the null vector. InOut: Scope Name Type Comment Return MakeNormed3D BOOL TRUE : If \(v\) is not the null vector Input pv POINTER TO VECTOR3D Pointer to input vector \(v \in \mathbb{R^{3}}\)
Norm3D (FUN) ¶ FUNCTION Norm3D : LREAL This function will return the length/norm of a three dimensional vector \(v \in \mathbb{R^{3}}\) InOut: Scope Name Type Comment Return Norm3D LREAL The length/norm of the input vector \(v\) Input pv POINTER TO VECTOR3D Pointer to input vector \(v \in \mathbb{R^{3}}\)
ScalProd3D (FUN) ¶ FUNCTION ScalProd3D : LREAL This function will calculate the scalar product of two vectors \(v_{1}, v_{2} \in \mathbb{R^{3}}\) InOut: Scope Name Type Comment Return ScalProd3D LREAL \(v_{1} \cdot v_{2} \in \mathbb{R}\) Input pv1 POINTER TO Vector3d Pointer to input vector \(v_{1} \in \mathbb{R}\) pv2 POINTER TO Vector3d Pointer to input vector \(v_{2} \in \mathbb{R}\)
