|
Adaptive Framework
0.9.0
|
Adaptive Function to_string<objectPath>
More...
Functions | |
| const afw_value_t * | afw_function_execute_add_properties (afw_function_execute_t *x) |
Adaptive Function add_properties More... | |
| const afw_value_t * | afw_function_execute_apply_object_options (afw_function_execute_t *x) |
Adaptive Function apply_object_options More... | |
| const afw_value_t * | afw_function_execute_local_object_meta_set_ids (afw_function_execute_t *x) |
Adaptive Function local_object_meta_set_ids More... | |
| const afw_value_t * | afw_function_execute_property_exists (afw_function_execute_t *x) |
Adaptive Function property_exists More... | |
| const afw_value_t * | afw_function_execute_property_get (afw_function_execute_t *x) |
Adaptive Function property_get More... | |
| const afw_value_t * | afw_function_execute_property_is_not_null (afw_function_execute_t *x) |
Adaptive Function property_is_not_null More... | |
Adaptive Function to_string<objectPath>
| x | function execute parameter. |
Converts objectPath value to string. For list values, the to_string() value for each entry is returned separated with commas.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
value - (objectPath) A objectPath value.
Returns:
(string) The string representation of the value.
Implemented by afw_function_execute_convert()
object adaptive functions.
| const afw_value_t* afw_function_execute_add_properties | ( | afw_function_execute_t * | x | ) |
Adaptive Function add_properties
| x | function execute parameter. |
Add the properties of one object to another replacing existing properties by the same name.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
target - (object) Target object. This object must not be immutable.
source - (1 or more object) Source object(s).
Returns:
(object) The modified target object.
Definition at line 52 of file afw_function_object.c.
| const afw_value_t* afw_function_execute_apply_object_options | ( | afw_function_execute_t * | x | ) |
Adaptive Function apply_object_options
| x | function execute parameter. |
This will return an object with the specified object options applied.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
object - (object) Object used to produce result.
options - (optional object AdaptiveObjectOptions) Object options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
Returns:
(object) This is an object with object options applied.
Definition at line 116 of file afw_function_object.c.
| const afw_value_t* afw_function_execute_local_object_meta_set_ids | ( | afw_function_execute_t * | x | ) |
Adaptive Function local_object_meta_set_ids
| x | function execute parameter. |
This is used to set the ids in a local mutable object. The ids are used to construct a local path.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
object - (object) Object to set ids in.
adaptorId - (string) Adaptor id for object.
objectType - (string) Object type id for object.
objectId - (string) Object id for object.
Returns:
(null)
Definition at line 177 of file afw_function_object.c.
| const afw_value_t* afw_function_execute_property_exists | ( | afw_function_execute_t * | x | ) |
Adaptive Function property_exists
| x | function execute parameter. |
Return true if the named property exists in an object.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
object - (object) Object to get property from.
name - (string) Name of property to check.
Returns:
(boolean) True if object has named property.
Definition at line 231 of file afw_function_object.c.
| const afw_value_t* afw_function_execute_property_get | ( | afw_function_execute_t * | x | ) |
Adaptive Function property_get
| x | function execute parameter. |
Return the value of a property of an object. If property is not available, return a default or null value.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
object - (object) Object to get property from.
name - (string) Name of property to get.
defaultValue - (optional any dataType) The default value of property if it does not exist in object. If not specified, null value is the default.
Returns:
(any dataType) Evaluated property value or default.
Definition at line 285 of file afw_function_object.c.
| const afw_value_t* afw_function_execute_property_is_not_null | ( | afw_function_execute_t * | x | ) |
Adaptive Function property_is_not_null
| x | function execute parameter. |
Return true if the named property exists in an object and is not null.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
object - (object) Object to get property from.
name - (string) Name of property to check.
Returns:
(boolean) True if object has named property that is not null.
Definition at line 344 of file afw_function_object.c.
| afw_function_definition_bag_size_object |
Adaptive Function bag<object>
| x | function execute parameter. |
Takes any number of object values and returns a list of list.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
values - (0 or more list object)
Returns:
(list object)
Implemented by afw_function_execute_bag()
Function definition bag_size<object>
Definition at line 19371 of file afw_function_bindings.h.
| afw_function_definition_clone_object |
Adaptive Function bag_size<object>
| x | function execute parameter. |
This returns the integer number of values in list.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
value - (list object)
Returns:
(integer)
Implemented by afw_function_execute_bag_size()
Function definition clone<object>
Definition at line 19405 of file afw_function_bindings.h.
| afw_function_definition_eq_object |
Adaptive Function clone<object>
| x | function execute parameter. |
Deep clone a object value.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
value - (object) The object value to clone.
Returns:
(object) The cloned object value.
Implemented by afw_function_execute_clone()
Function definition eq<object>
Definition at line 19439 of file afw_function_bindings.h.
| afw_function_definition_eqx_object |
Adaptive Function eq<object>
| x | function execute parameter. |
Determine if object arg1 is equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "eqx" ("===") instead if you want false to be returned if arg1 and arg2's data type don't match.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
arg1 - (object)
arg2 - (any dataType)
Returns:
(boolean)
Errors thrown:
conversion - arg2 cannot be converted to the data type of arg1.
Implemented by afw_function_execute_eq()
Function definition eqx<object>
Definition at line 19482 of file afw_function_bindings.h.
| afw_function_definition_ge_object |
Adaptive Function eqx<object>
| x | function execute parameter. |
Determine if for object arg1 is equal to the value and data type of arg2 then return the boolean result. Use "eq" ("==") instead if you want arg2 to be converted to the data type of arg1 before comparison.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
arg1 - (object)
arg2 - (any dataType)
Returns:
(boolean)
Implemented by afw_function_execute_eqx()
Function definition ge<object>
Definition at line 19521 of file afw_function_bindings.h.
| afw_function_definition_gt_object |
Adaptive Function ge<object>
| x | function execute parameter. |
Checks for object arg1 is greater than or equal to object arg2 and return the boolean result.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
arg1 - (object)
arg2 - (object)
Returns:
(boolean)
Implemented by afw_function_execute_ge()
Function definition gt<object>
Definition at line 19559 of file afw_function_bindings.h.
| afw_function_definition_is_object |
Adaptive Function gt<object>
| x | function execute parameter. |
Checks for object arg1 is greater than object arg2 and return the boolean result.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
arg1 - (object)
arg2 - (object)
Returns:
(boolean)
Implemented by afw_function_execute_gt()
Function definition is<object>
Definition at line 19597 of file afw_function_bindings.h.
| afw_function_definition_le_object |
Adaptive Function is<object>
| x | function execute parameter. |
Checks whether value is dataType object and return the boolean result.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
value - (any dataType) Value to check.
Returns:
(boolean)
Implemented by afw_function_execute_is()
Function definition le<object>
Definition at line 19631 of file afw_function_bindings.h.
| afw_function_definition_local_object_meta_set_ids |
Adaptive Function le<object>
| x | function execute parameter. |
Checks for object arg1 is less than or equal to object arg2 and return the boolean result.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
arg1 - (object)
arg2 - (any dataType)
Returns:
(boolean)
Implemented by afw_function_execute_le()
Function definition local_object_meta_set_ids
Definition at line 19669 of file afw_function_bindings.h.
| afw_function_definition_ne_object |
Adaptive Function lt<object>
| x | function execute parameter. |
Checks for object arg1 is less that object arg2 and return the boolean result.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
arg1 - (object)
arg2 - (object)
Returns:
(boolean)
Implemented by afw_function_execute_lt()
Function definition ne<object>
Definition at line 19750 of file afw_function_bindings.h.
| afw_function_definition_nex_object |
Adaptive Function ne<object>
| x | function execute parameter. |
Determine if object arg1 is not equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "nex" ("!==") instead if you want true to be returned if arg1 and arg2's data type don't match.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
arg1 - (object)
arg2 - (any dataType)
Returns:
(boolean)
Errors thrown:
conversion - arg2 cannot be converted to the data type of arg1.
Implemented by afw_function_execute_ne()
Function definition nex<object>
Definition at line 19793 of file afw_function_bindings.h.
| afw_function_definition_object |
Adaptive Function nex<object>
| x | function execute parameter. |
Determine if for object arg1 is not equal to the value or data type of arg2 then return the boolean result. Use "ne" ("!=") instead if you want arg2 to be converted to the data type of arg1 before comparison.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
arg1 - (object)
arg2 - (any dataType)
Returns:
(boolean)
Implemented by afw_function_execute_nex()
Function definition object
Definition at line 19832 of file afw_function_bindings.h.
| afw_function_definition_property_exists |
Adaptive Function object
| x | function execute parameter. |
Converts value to data type object returning object result.
This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.
Declaration:
Parameters:
value - (any dataType) Value to convert.
Returns:
(object) Converted value.
Errors thrown:
cast_error - value could not be converted
Implemented by afw_function_execute_convert()
Function definition property_exists
Definition at line 19870 of file afw_function_bindings.h.
1.9.1