Context

Classes
class	face_sdk.modules.context.ContextFormat
class	face_sdk.modules.context.Context
	Interface object for the container is Context. More...

Functions
def	face_sdk.modules.context.Context.__setitem__
	Changing the value by key. More...
def	face_sdk.modules.context.Context.__len__
	Get the size of the container. More...
def	face_sdk.modules.context.Context.push_back
	adds a object to the container.
def	face_sdk.modules.context.Context.get_bytes
	get a string of bytes from the container. More...
def	face_sdk.modules.context.Context.get_bytes_from_ptr
	get a string of bytes from the pointer. More...
def	face_sdk.modules.context.Context.clone
	copies the container-Context to the new object. More...
def	face_sdk.modules.context.Context.clear
	clears the contents of the container-Context.
def	face_sdk.modules.context.Context.erase
	deletes the contents of the container-Context stored by key. More...
def	face_sdk.modules.context.Context.reserve
	allocates memory for num elements in the array. More...
def	face_sdk.modules.context.Context.contains
	checks the existence of an element by a specific key More...
def	face_sdk.modules.context.Context.compare
	compares two Context objects More...
def	face_sdk.modules.context.Context.to_dict
	converts the container-Context to dict More...
def	face_sdk.modules.context.Context.keys
	returns a list of keys in the container-Context More...
def	face_sdk.modules.context.Context.is_none
	checks if there are no elements in the container More...
def	face_sdk.modules.context.Context.is_array
	checks whether the container is an array More...
def	face_sdk.modules.context.Context.is_object
	checks whether the container is an object More...
def	face_sdk.modules.context.Context.is_bool
	checks whether the container is a bool type value More...
def	face_sdk.modules.context.Context.is_long
	checks whether the container is a long type value More...
def	face_sdk.modules.context.Context.is_double
	checks whether the container is a double type value More...
def	face_sdk.modules.context.Context.is_string
	checks whether the container is a string type value More...
def	face_sdk.modules.context.Context.is_data_ptr
	checks whether the container is a pointer to the data More...
def	face_sdk.modules.context.Context.get_value
	returns the value contained in the container More...
def	face_sdk.modules.context.Context.save_to_json_file
	saves the contents of the container to a json file More...

Detailed Description

Function Documentation

def face_sdk.modules.context.Context.__len__

(

self

)

Get the size of the container.

Returns

the size of the container.

def face_sdk.modules.context.Context.__setitem__	(		self,
			key,
			value
	)

Changing the value by key.

Parameters

[in]	key	is the key for indexing.
[in]	value	new value

Returns

self.

def face_sdk.modules.context.Context.clone

(

self

)

copies the container-Context to the new object.

Returns

a new container object-Context.

def face_sdk.modules.context.Context.compare	(		self,
			other
	)

compares two Context objects

Parameters

[in]

other

- container-Context

Returns

True if the objects are the same

def face_sdk.modules.context.Context.contains	(		self,
			key
	)

checks the existence of an element by a specific key

Parameters

[in]

key

Returns

True if the element exists

def face_sdk.modules.context.Context.erase	(		self,
			key
	)

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

Parameters

[in]

key.

def face_sdk.modules.context.Context.get_bytes	(		self,
			size
	)

get a string of bytes from the container.

Parameters

[in]

size

the size of the byte string.

Returns

a string of bytes.

def face_sdk.modules.context.Context.get_bytes_from_ptr (   byte_ptr )

static

get a string of bytes from the pointer.

Parameters

[in]	byte_ptr	pointer.
[in]	size	the size of the byte string.

Returns

a string of bytes.

def face_sdk.modules.context.Context.get_value

(

self

)

returns the value contained in the container

Returns

value

def face_sdk.modules.context.Context.is_array	(		self,
			bool
	)

checks whether the container is an array

Returns

True if the container is an array

def face_sdk.modules.context.Context.is_bool	(		self,
			bool
	)

checks whether the container is a bool type value

Returns

True if the container is a bool type value

def face_sdk.modules.context.Context.is_data_ptr	(		self,
			bool
	)

checks whether the container is a pointer to the data

Returns

True if the container is a pointer to the data

def face_sdk.modules.context.Context.is_double	(		self,
			bool
	)

checks whether the container is a double type value

Returns

True if the container is a double type value

def face_sdk.modules.context.Context.is_long	(		self,
			bool
	)

checks whether the container is a long type value

Returns

True if the container is a long type value

def face_sdk.modules.context.Context.is_none	(		self,
			bool
	)

checks if there are no elements in the container

Returns

True if the container is empty

def face_sdk.modules.context.Context.is_object	(		self,
			bool
	)

checks whether the container is an object

Returns

True if the container is an object

def face_sdk.modules.context.Context.is_string	(		self,
			bool
	)

checks whether the container is a string type value

Returns

True if the container is a string type value

def face_sdk.modules.context.Context.keys	(		self,
			list
	)

returns a list of keys in the container-Context

Returns

key list

def face_sdk.modules.context.Context.reserve	(		self,
			size
	)

allocates memory for num elements in the array.

Parameters

[in]

size

- the size of the array.

def face_sdk.modules.context.Context.save_to_json_file	(		self,
			path
	)

saves the contents of the container to a json file

Parameters

[in]

path

- the path to the file

def face_sdk.modules.context.Context.to_dict

(

self

)

converts the container-Context to dict

Returns

dict