ansys.systemcoupling.core.adaptor.impl.types.Container

class ansys.systemcoupling.core.adaptor.impl.types.Container(name=None, parent=None)

Provides a Container object for primitive values and other settings objects.

A Container may contain child objects that are further objects of type Container, objects of the NamedContainer type, or various types of command object. Child objects are accessed as attributes.

Concrete instances of the Container object usually provide access to primitive settings (such as real values and string values) as Python properties.

Note

The following attributes are mainly for implementation purposes.

Attributes:

child_names: list[str]

List of names for the child objects.

command_names: list[str]

List of names of the commands.

property_names_types: List[Tuple[str, str, str]]

List of tuples, each comprising property name, System Coupling property name, and type identifier.

Methods

__init__([name, parent])	Initialize an instance of the Container class.
get_property_options(name)	Get the currently available options for a specified property
get_property_state(prop)	Get the state of the prop property .
get_state()	Get the state of the object.
print_state([out, indent_factor])	Print the state of the object.
set_property_state(prop, value)	Set the state of the prop property to value.
set_state(state)	Set the state of the object.
set_sycproxy(sycproxy)	Set sycproxy object.
to_python_keys(value)	Convert value to have keys with Python names.
to_python_name(name)	Convert native System Coupling property name to Python name.
to_syc_keys(value)	Convert value to have keys with System Coupling names.
to_syc_name(name)	Convert Python property name to native System Coupling name.

Attributes

child_names
command_names
obj_name	System Coupling name of this object.
path	Path of the object.
property_names_types
syc_name
syc_path	Path of the object in native System Coupling form.
sycproxy	Proxy object.