This enum represents various options for the assignment or cloning of types. The enum values are powers of two such that they can be combined in a bitmask. Such a bitmask van be is passed to assign_from_to() and clone().

This enum represents possible events that can happen during assignment of types. The enum values are powers of two such that they can be combined in a bitmask. Such a bitmask is returned by assign_from_to().

Assigns the value(s) of source to target. Assignment succeeds if both source and target are of the same type. If not, the method tries to perform an assignment on a best effort basis. For example, an assignment between interfaces derived from mi::INumber might require a conversion as defined in the C/C++ standard. If both arguments are of type mi::IData_collection, assignment happens for all keys existing in both parameters.

The value 0 indicates that the assignment took place without any problems. Note that a non-zero value is not necessarily an error, it is up to the caller to interpret the result according to the context. For example, assigning from an instance of mi::IFloat32_3 to an instance of mi::IFloat32_2 will result in TARGET_KEY_MISSING because there is no key named "z" in mi::IFloat32_2. It is up to the caller to decide whether this is the intended behavior or not.

Parameters

source

The instance to assign from.

target

The instance to assign to.

options

See Assign_clone_options for possible options.

Returns

The return value is a bit field that indicates which events occurred during assignment. See Assign_result for possible events.

Creates a clone of a type. It is not possible to clone untyped pointers and collections that wrap/contain interface pointers that are not of type mi::IData.

Parameters

source

The instance to clone.

options

See Assign_clone_options for possible options.

Creates a clone of a type. It is not possible to clone untyped pointers and collections that wrap/contain interface pointers that are not of type mi::IData.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Parameters

source

The instance to clone.

options

See Assign_clone_options for possible options.

Compares two instances of mi::IData. The comparison operator for instances of mi::IData is defined as follows:

• If lhs or rhs is NULL, the result is the lexicographic comparison of the pointer addresses themselves.

• Otherwise, the type names of lhs and rhs are considered. If they are different, the result is determined by strcmp() on the type names. For example, this method never returns 0 if you compare a dynamic array and a static array, even if they have the same element type, length, and equal element values.

• Finally, the values of the elements are compared lexicographically, as defined by operator< or strcmp() with the following special cases for selected interfaces:

  • mi::IRef: If mi::IRef::get_reference_name() returns NULL for at least one operand, the result is the lexicographic comparison of the pointer addresses. Otherwise, the result is determined by strcmp() on the names of the referenced DB elements.

  • mi::IPointer and mi::IConst_pointer: If mi::IPointer::get_pointer() or mi::IConst_pointer::get_pointer() returns NULL for at least one operand, the result is the lexicographic comparison of the pointer addresses. Otherwise, if at least one pointer is not of the type mi::IData, the result is the lexicographic comparison of the pointer addresses. Finally (both pointers are of type mi::IData), the result is determined by the recursive invocation of this method on these pointers.

  • mi::IData_collection: First, if the collections have different length, this decides the comparison. Next, the elements are compared pairwise in lexicographic order of the element index. If the element keys are different, strcmp() on the element keys determines the result. Otherwise, the element values are compared by recursive invocation of this method (or lexicographic comparison of the pointer addresses if one element is not of type mi::IData). If they are different, this decides the result, otherwise the comparison continues with the next element. If all elements are equal, the result is 0.

• mi::IAttachable: If mi::IAttachable::get_reference_name() does not return NULL for either operand, the result is determined by strcmp() on the names of the referenced DB elements. If the methods returns NULL for exactly one operand, this operand is smaller than the other one. If the method returns NULL for both operands, the result is determined by the recursive invocation of this method on the pointers returned by mi::IAttachable::get_value().

Parameters

lhs

The left-hand side operand for the comparison.

rhs

The right-hand side operand for the comparison.

Returns

-1 if lhs < rhs , 0 if lhs == rhs , and +1 if lhs > rhs .

Creates an object of the type type_name. The arguments passed to this method are passed to the constructor of the created object.

This factory allows the creation of instances of mi::IData and derived interfaces.

It is not possible to create instances of mi::IRef, mi::IAttachable, or collections of these types.

The created object will be initialized in a manner dependent upon the passed type name. Each class has its own policy on initialization. So, one should not make any assumptions on the values of the various class members.

Parameters

type_name

The type name of the object to create. See Types for possible type names.

argc

The number of elements in argv.

argv

The array of arguments passed to the constructor.

Returns

A pointer to the created object on success, or NULL on failure (e.g., invalid type name).

Creates an object of the type type_name. The arguments passed to this method are passed to the constructor of the created object.

This factory allows the creation of instances of mi::IData and derived interfaces.

It is not possible to create instances of mi::IRef, mi::IAttachable, or collections of these types.

The created object will be initialized in a manner dependent upon the passed type name. Each class has its own policy on initialization. So, one should not make any assumptions on the values of the various class members.

Note that there are two versions of this templated member function, one that takes no arguments, and another one that takes one or three arguments (the type name, and two optional arguments passed to the factory class). The version with no arguments can only be used to create a subset of supported types: it supports only those types where the type name can be deduced from the template parameter, i.e., it does not support arrays, structures, maps, pointers, attachables, and calls. The version with one or three arguments can be used to create any type (but requires the type name as parameter, which is redundant for many types). Attempts to use the version with no arguments with a template parameter where the type name can not be deduced results in compiler errors.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Parameters

type_name

The type name of the object to create

argc

The number of elements in argv

argv

The array of arguments passed to the constructor

Returns

A pointer to the created object on success, or NULL on failure (e.g., invalid type name).

Creates an object of the type T. This factory allows the creation of instances of mi::IData and derived interfaces.

It is not possible to create instances of mi::IRef, mi::IAttachable, or collections of these types.

The created object will be initialized in a manner dependent upon the passed type name. Each class has its own policy on initialization. So, one should not make any assumptions on the values of the various class members.

Note that there are two versions of this templated member function, one that takes no arguments, and another one that takes one or three arguments (the type name, and two optional arguments passed to the factory class). The version with no arguments can only be used to create a subset of supported types: it supports only those types where the type name can be deduced from the template parameter, i.e., it does not support arrays, structures, maps, pointers, attachables, and calls. The version with one or three arguments can be used to create any type (but requires the type name as parameter, which is redundant for many types). Attempts to use the version with no arguments with a template parameter where the type name can not be deduced results in compiler errors.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Returns

A pointer to the created object on success, or NULL on failure (e.g., invalid type name).

Returns a textual representation of a type. The textual representation is of the form "type name = value" if name is not NULL, and of the form "value" if name is NULL. The representation of the value might contain line breaks, for example for structures and arrays. Subsequent lines have a suitable indentation. The assumed indentation level of the first line is specified by depth.

For readability reasons the type of instances of mi::ICall is abbreviated as "(call)" (this string is not a valid type name).

Returns a registered call declaration.

Parameters

call_name

The name of the call declaration to return.

Returns

The call declaration for name , or NULL if there is no call declaration for that name.

Returns a registered enum declaration.

Parameters

enum_name

The name of the enum declaration to return.

Returns

The enum declaration for name , or NULL if there is no enum declaration for that name.

Returns a registered structure declaration.

Parameters

structure_name

The name of the structure declaration to return.

Returns

The structure declaration for name , or NULL if there is no structure declaration for that name.