Package autodesk_toxik :: Module graph :: Class Socket

Class Socket

 object --+    
          |    
Boost.Python.instance --+
              |
             Socket

Known Subclasses:

Input
, Output

Base class for socket objects. There is a hierarchy of socket classes used to represent the node sockets.

Instance Methods

__cmp__(...)

__init__(...)
Raises an exception This class cannot be instantiated from Python

__reduce__(...)
helper for pickle

DataTypeType

getDataType(...)
Returns: The data type of the socket.

DirectionType

getDirection(...)
Returns: The direction of the socket.

Graph

getGraph(...)
Returns: The version (composition graph) that owns this socket.

int

getId(...)
Returns: Unique identifier of the socket within its graph.

LayoutType

getLayout(...)
Returns: The layout of the socket.

LifeScopeType

getLifeScope(...)
Returns: The life scope of the socket (static vs dynamic).

str

getName(...)
Returns: The socket name.

Node

getNode(...)
Returns: The node to which this socket belongs.

str

getQualifiedName(...)
Returns: The fully qualified name of the socket formed by appending the enclosing node's qualified name with the socket qualified name separated by a colon.

bool

isConnected(...)
Returns: True if the socket is connected.

setName(...)
Renames the socket.

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(...)
(Constructor)

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

getDataType(...)

Returns: DataTypeType: The data type of the socket.

getDirection(...)

Returns: DirectionType: The direction of the socket.

getGraph(...)

Returns: Graph: The version (composition graph) that owns this socket.

getId(...)

Returns: int: Unique identifier of the socket within its graph.

getLayout(...)

Returns: LayoutType: The layout of the socket.

getLifeScope(...)

Returns: LifeScopeType: The life scope of the socket (static vs dynamic).

getName(...)

Returns: str: The socket name.

getNode(...)

Returns: Node: The node to which this socket belongs.

getQualifiedName(...)

Returns: str: The fully qualified name of the socket formed by appending the enclosing node's qualified name with the socket qualified name separated by a colon. It is of the form: "node1.node2.node3:socket1.socket2.socket3".

isConnected(...)

Returns: bool: True if the socket is connected.

setName(...)

Renames the socket. Not all sockets can be renamed; only dynamic sockets can and only if the tool allows for it.

Parameters:

name (str) - New socket name

Raises:

StandardError - If the socket cannot be renamed.