ansys.dpf.core.Any#

class ansys.dpf.core.Any(any_dpf=None, server=None)#

Common wrapper representing any supported DPF Data Types.

Parameters:
  • any_dpf (ctypes.c_void_p, ansys.grpc.dpf.any_pb2.Any message, optional)

  • server (DPFServer, optional) – Server with channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Notes

Class available with server’s version starting at 7.0 (Ansys 2024 R1 pre0).

_server#
_api_instance = None#
_internal_type = None#
_get_as_method = None#
_new_from_string(str)#
static _get_as_string(self)#
static _get_as_string_as_bytes(self)#
_new_from_string_on_client(client, str)#
_new_from_string_as_bytes(str)#
_new_from_string_as_bytes_on_client(client, str)#
_type_to_new_from_get_as_method(obj)#
static new_from(obj, server=None)#

Return an Any instance from the given object.

Parameters:

obj (Object wrap as an Any)

Returns:

any – Wrapped any type.

Return type:

Any

property _api: ansys.dpf.gate.any_abstract_api.AnyAbstractAPI#
__str__()#

Describe the entity.

Returns:

description – Description of the entity.

Return type:

str

cast(output_type=None)#

Cast the Any back to its original type.

Parameters:

output_type (output_type, optional) – Used when the Any instance was retrieved from the server. Not necessary when the instance was created using the ansys.dpf.core.Any.new_from()

Returns:

Original object instance

Return type:

type

__del__()#

Delete the entry.