csc.update.Group

class csc.update.Group

Group class

Variables:

node – overridden by name || node, access node by name or id

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
add_input(self, name)
add_output(self, name)
attributes(self, d)	array of all input and output attributes
constant_datas(self)	get virtual node to access constant datas
constant_settings(self)	get virtual node to access constant settings
create_group(self, name)
delete_node(self, node)
full_name(self)	name with all the parent nodes
group(self, nodes, name)
group_id(self)	create sub group
has_input(self, name)	check if there is an input with such a name
has_node(self, name)	check whether there is a child node with a given name
has_output(self, name)	check if there is an output with such a name
id(self)	get uniqui id
input(self, name)	shortcut if node has only one input attribute
input_interface_node(self)
inputs(self)	array of all the inputes attributes
interface_input(self, name)
interface_inputs(self)	get group attributes as interface attributes
interface_node(self, direction)	access the interface node
interface_output(self, name)
interface_outputs(self)
is_active(self)	check whether it is active for current actualities states (see Additional functionality in csc.update.UpdateEditor)
is_fictive(self)	whether it is a fictive node (constants, inputs, outputs of a group or external properties)
is_root(self)
leaf_children(self)	get all leaf nodes (settings, datas, functions)
name(self)	get name
node(*args, **kwargs)	Overloaded function.
node_deep(self, name)	access node by name or id recursively
node_with_type(self, type_name, name)	find node with name and type
node_with_type_deep(self, type_name, name)	find node with name and type recursively
nodes(self)	get all children (their children are not included)
output(self, name)	shortcut if node has only one output attribute
output_interface_node(self)
outputs(self)	array of all the outputs attributes
parent_group(self)	return parent group (where this group node is located)
parent_object(self)	return object of the node.
set_name(self, name)	rename node

__annotations__ = {}

__init__(*args, **kwargs)

__module__ = 'csc.update'

add_input(self: csc.update.Group, name: str) → csc.update.InterfaceAttribute

add_output(self: csc.update.Group, name: str) → csc.update.InterfaceAttribute

constant_datas(self: csc.update.Group) → csc.update.ConstantDatas

get virtual node to access constant datas

constant_settings(self: csc.update.Group) → csc.update.ConstantSettings

get virtual node to access constant settings

create_group(self: csc.update.Group, name: str) → csc.update.Group

delete_node(self: csc.update.Group, node: csc.update.Node) → None

group(self: csc.update.Group, nodes: Set[csc.update.Node], name: str) → csc.update.Group

group_id(self: csc.update.Group) → csc.update.GroupId

create sub group

has_node(self: csc.update.Group, name: str) → bool

check whether there is a child node with a given name

input_interface_node(self: csc.update.Group) → csc.update.InterfaceNode

interface_input(self: csc.update.Group, name: str) → csc.update.InterfaceAttribute

interface_inputs(self: csc.update.Group) → List[csc.update.InterfaceAttribute]

get group attributes as interface attributes

interface_node(self: csc.update.Group, direction: csc.Direction) → csc.update.InterfaceNode

access the interface node

interface_output(self: csc.update.Group, name: str) → csc.update.InterfaceAttribute

interface_outputs(self: csc.update.Group) → List[csc.update.InterfaceAttribute]

is_root(self: csc.update.Group) → csc.update.GroupId

leaf_children(self: csc.update.Group) → Set[csc.update.Node]

get all leaf nodes (settings, datas, functions)

node(*args, **kwargs)

Overloaded function.

1. node(self: csc.update.Group, name: str) -> csc.update.Node

2. node(self: csc.update.Group, node: Union[csc.update.GroupId, csc.update.InterfaceId, csc.update.ExternalPropertiesId, csc.update.ConstantDatasId, csc.update.ConstantSettingsId, csc.model.ObjectId, csc.model.HyperedgeId, csc.model.DataId, csc.model.SettingFunctionId, csc.model.SettingId]) -> csc.update.Node

node_deep(self: csc.update.Group, name: str) → csc.update.Node

access node by name or id recursively

node_with_type(self: csc.update.Group, type_name: str, name: str) → csc.update.Node

find node with name and type

node_with_type_deep(self: csc.update.Group, type_name: str, name: str) → csc.update.Node

find node with name and type recursively

nodes(self: csc.update.Group) → Set[csc.update.Node]

get all children (their children are not included)

output_interface_node(self: csc.update.Group) → csc.update.InterfaceNode