3DiVi Face SDK  3.24.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups
VDT.FaceRecognition.SDK.Context Class Reference

Context is an interface object for storing data and interacting with methods from the Processing Block API. More...

Public Member Functions

void Invoke (object ctx)
 Assign context value. More...
 
Context GetItem (int key)
 Get Context from array by index. More...
 
Context GetItem (string key)
 Get Context from map by key. More...
 
ulong Length ()
 Get array Context size. More...
 
void PushBack (Context data)
 Add Context to array. More...
 
unsafe void SetStr (string value)
 Set Context value. More...
 
unsafe string GetString ()
 Get Context value. More...
 
unsafe void SetDouble (double value)
 Set Context value. More...
 
unsafe double GetDouble ()
 Get Context value. More...
 
unsafe void SetBool (bool value)
 Set Context value. More...
 
unsafe void SetDataPtr (byte[] value)
 Set Context value. More...
 
unsafe byte * GetDataPtr ()
 Get Context value. More...
 
unsafe byte[] GetBytes (int size)
 get an array of bytes from a container. More...
 
unsafe bool GetBool ()
 Get Context value. More...
 
unsafe void SetLong (long value)
 Set Context value. More...
 
unsafe long GetLong ()
 Get Context value. More...
 
unsafe ulong GetUnsignedLong ()
 Get Context value. More...
 
unsafe ulong GetLength ()
 Get array Context size. More...
 
unsafe ulong GetStringSize ()
 Get string size. More...
 
unsafe Context GetOrInsertByKey (string key)
 Returns or insert and returns Context. More...
 
unsafe Context GetByKey (string key)
 Get Context from map by key. More...
 
unsafe Context GetByIndex (int index)
 Get Context from array by index. More...
 
unsafe Context Clone ()
 Copy Context. More...
 
unsafe Context Copy (Context other)
 Copy data from other Context to this. More...
 
unsafe void Clear ()
 clears the contents of the container-Context.
 
unsafe void Erase (string key)
 deletes the contents of the container-Context stored by key. More...
 
unsafe void Reserve (long size)
 allocates memory for num elements in the array. More...
 
unsafe bool Contains (string key)
 checks the existence of an element by a specific key More...
 
unsafe bool Compare (Context dst)
 compares two Context objects More...
 
unsafe void SaveToJsonFile (string path)
 saves the contents of the container to a json file More...
 
unsafe void DictionaryParser (Dictionary< object, object > ctx)
 Add all values of Dictionary to Context map. More...
 
unsafe void ListParser (List< object > ctx)
 Add all values of List to Context array. More...
 
unsafe void StringParser (string ctx)
 Set Context value. More...
 
unsafe void LongParser (long ctx)
 Set Context value. More...
 
unsafe void DoubleParser (double ctx)
 Set Context value. More...
 
unsafe void BoolParser (bool ctx)
 Set Context value. More...
 
unsafe void ByteParser (byte[] ctx)
 Set Context value. More...
 
unsafe List< string > GetKeys ()
 Get all Context map keys. More...
 
List< string > Keys ()
 Get all Context map keys. More...
 
unsafe bool IsNone ()
 Check Context value is None. More...
 
unsafe bool IsArray ()
 Check Context value is array. More...
 
unsafe bool IsObject ()
 Check Context value is object. More...
 
unsafe bool IsBool ()
 Check Context value is bool. More...
 
unsafe bool IsLong ()
 Check Context value is long. More...
 
unsafe bool IsUnsignedLong ()
 Check Context value is unsigned long. More...
 
unsafe bool IsDouble ()
 Check Context value is double. More...
 
unsafe bool IsString ()
 Check Context value is string. More...
 
unsafe bool IsDataPtr ()
 Check Context value is pointer to bytes. More...
 
unsafe object GetValue ()
 Get current Context value. More...
 

Properties

Context this[int index] [get]
 Get Context from array by index. More...
 
Context this[string key] [get, set]
 Get Context from map by key. More...
 

Detailed Description

Context is an interface object for storing data and interacting with methods from the Processing Block API.

Member Function Documentation

unsafe void VDT.FaceRecognition.SDK.Context.BoolParser ( bool  ctx)
inline

Set Context value.

Parameters
ctxBool Context value
unsafe void VDT.FaceRecognition.SDK.Context.ByteParser ( byte[]  ctx)
inline

Set Context value.

Parameters
ctxArray of bytes
unsafe Context VDT.FaceRecognition.SDK.Context.Clone ( )
inline

Copy Context.

Returns
New Context
unsafe bool VDT.FaceRecognition.SDK.Context.Compare ( Context  dst)
inline

compares two Context objects

Parameters
[in]dst- container-Context
Returns
True if the objects are the same
unsafe bool VDT.FaceRecognition.SDK.Context.Contains ( string  key)
inline

checks the existence of an element by a specific key

Parameters
[in]key
Returns
True if the element exists
unsafe Context VDT.FaceRecognition.SDK.Context.Copy ( Context  other)
inline

Copy data from other Context to this.

Parameters
otherOther Context
Returns
this
unsafe void VDT.FaceRecognition.SDK.Context.DictionaryParser ( Dictionary< object, object >  ctx)
inline

Add all values of Dictionary to Context map.

Parameters
ctxContext key - value
unsafe void VDT.FaceRecognition.SDK.Context.DoubleParser ( double  ctx)
inline

Set Context value.

Parameters
ctxDouble Context value
unsafe void VDT.FaceRecognition.SDK.Context.Erase ( string  key)
inline

deletes the contents of the container-Context stored by key.

Parameters
[in]str.
unsafe bool VDT.FaceRecognition.SDK.Context.GetBool ( )
inline

Get Context value.

Returns
Bool value
unsafe Context VDT.FaceRecognition.SDK.Context.GetByIndex ( int  index)
inline

Get Context from array by index.

Parameters
indexArray index
Returns
Context
unsafe Context VDT.FaceRecognition.SDK.Context.GetByKey ( string  key)
inline

Get Context from map by key.

Parameters
keyMap key
Returns
Context
unsafe byte [] VDT.FaceRecognition.SDK.Context.GetBytes ( int  size)
inline

get an array of bytes from a container.

Parameters
[in]sizethe size of the byte array.
Returns
an array of bytes.
unsafe byte* VDT.FaceRecognition.SDK.Context.GetDataPtr ( )
inline

Get Context value.

Returns
Pointer to bytes
unsafe double VDT.FaceRecognition.SDK.Context.GetDouble ( )
inline

Get Context value.

Returns
Double value
Context VDT.FaceRecognition.SDK.Context.GetItem ( int  key)
inline

Get Context from array by index.

Parameters
keyArray index
Returns
Context
Context VDT.FaceRecognition.SDK.Context.GetItem ( string  key)
inline

Get Context from map by key.

Parameters
keyMap key
Returns
Context
unsafe List<string> VDT.FaceRecognition.SDK.Context.GetKeys ( )
inline

Get all Context map keys.

Returns
Context keys
unsafe ulong VDT.FaceRecognition.SDK.Context.GetLength ( )
inline

Get array Context size.

Returns
Context array size
unsafe long VDT.FaceRecognition.SDK.Context.GetLong ( )
inline

Get Context value.

Returns
Long value
unsafe Context VDT.FaceRecognition.SDK.Context.GetOrInsertByKey ( string  key)
inline

Returns or insert and returns Context.

Parameters
keyMap key
Returns
Context
unsafe string VDT.FaceRecognition.SDK.Context.GetString ( )
inline

Get Context value.

Returns
String value
unsafe ulong VDT.FaceRecognition.SDK.Context.GetStringSize ( )
inline

Get string size.

Returns
Context string value size
unsafe ulong VDT.FaceRecognition.SDK.Context.GetUnsignedLong ( )
inline

Get Context value.

Returns
Unsigned long value
unsafe object VDT.FaceRecognition.SDK.Context.GetValue ( )
inline

Get current Context value.

Returns
Current Context value
void VDT.FaceRecognition.SDK.Context.Invoke ( object  ctx)
inline

Assign context value.

Parameters
ctxNew context value
unsafe bool VDT.FaceRecognition.SDK.Context.IsArray ( )
inline

Check Context value is array.

Returns
Is Context array
unsafe bool VDT.FaceRecognition.SDK.Context.IsBool ( )
inline

Check Context value is bool.

Returns
Is Context bool
unsafe bool VDT.FaceRecognition.SDK.Context.IsDataPtr ( )
inline

Check Context value is pointer to bytes.

Returns
Is Context pointer to bytes
unsafe bool VDT.FaceRecognition.SDK.Context.IsDouble ( )
inline

Check Context value is double.

Returns
Is Context double
unsafe bool VDT.FaceRecognition.SDK.Context.IsLong ( )
inline

Check Context value is long.

Returns
Is Context long
unsafe bool VDT.FaceRecognition.SDK.Context.IsNone ( )
inline

Check Context value is None.

Returns
Is Context None
unsafe bool VDT.FaceRecognition.SDK.Context.IsObject ( )
inline

Check Context value is object.

Returns
Is Context object
unsafe bool VDT.FaceRecognition.SDK.Context.IsString ( )
inline

Check Context value is string.

Returns
Is Context string
unsafe bool VDT.FaceRecognition.SDK.Context.IsUnsignedLong ( )
inline

Check Context value is unsigned long.

Returns
Is Context unsigned long
List<string> VDT.FaceRecognition.SDK.Context.Keys ( )
inline

Get all Context map keys.

Returns
Context keys
ulong VDT.FaceRecognition.SDK.Context.Length ( )
inline

Get array Context size.

Returns
Context array size
unsafe void VDT.FaceRecognition.SDK.Context.ListParser ( List< object >  ctx)
inline

Add all values of List to Context array.

Parameters
ctxContext array values
unsafe void VDT.FaceRecognition.SDK.Context.LongParser ( long  ctx)
inline

Set Context value.

Parameters
ctxLong Context value
void VDT.FaceRecognition.SDK.Context.PushBack ( Context  data)
inline

Add Context to array.

Parameters
dataNew Context
unsafe void VDT.FaceRecognition.SDK.Context.Reserve ( long  size)
inline

allocates memory for num elements in the array.

Parameters
[in]size- the size of the array.
unsafe void VDT.FaceRecognition.SDK.Context.SaveToJsonFile ( string  path)
inline

saves the contents of the container to a json file

Parameters
[in]path- the path to the file
unsafe void VDT.FaceRecognition.SDK.Context.SetBool ( bool  value)
inline

Set Context value.

Parameters
valueBool value
unsafe void VDT.FaceRecognition.SDK.Context.SetDataPtr ( byte[]  value)
inline

Set Context value.

Parameters
valueArray of bytes
unsafe void VDT.FaceRecognition.SDK.Context.SetDouble ( double  value)
inline

Set Context value.

Parameters
valueDouble value
unsafe void VDT.FaceRecognition.SDK.Context.SetLong ( long  value)
inline

Set Context value.

Parameters
valueLong value
unsafe void VDT.FaceRecognition.SDK.Context.SetStr ( string  value)
inline

Set Context value.

Parameters
valueString value
unsafe void VDT.FaceRecognition.SDK.Context.StringParser ( string  ctx)
inline

Set Context value.

Parameters
ctxString Context value

Property Documentation

Context VDT.FaceRecognition.SDK.Context.this[int index]
get

Get Context from array by index.

Parameters
indexArray index
Returns
Context
Context VDT.FaceRecognition.SDK.Context.this[string key]
getset

Get Context from map by key.

Parameters
keyMap key
Returns
Context