Package autodesk_toxik :: Module graph :: Class SocketSpec

Class SocketSpec

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

Description of a input or output socket to be instanced by a specific tool. Socket specs are recursive; they may contain other socket specs.

Instance Methods

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

__reduce__(...)
helper for pickle

{str:SocketSpec}

getChildDict(...)
Returns: A dict of the contained socket specs (if not a single-valued socket).

[SocketSpec]

getChildList(...)
Returns: The list of contained socket specs.

DataTypeType

getDataType(...)
Returns: The type of data that flows through this socket (one of the DataTypeType enum).

DirectionType

getDirection(...)
Returns: The direction of the socket (one of the DirectionType enum).

LayoutType

getLayout(...)
Returns: The layout of the socket (one of the LayoutType enum).

LifeScopeType

getLifeScope(...)
Returns: The life scope of the socket (one of the LifeScopeType enum).

str

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

setName(...)
Sets the name of 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)

getChildDict(...)

Returns: {str:SocketSpec}: A dict of the contained socket specs (if not a single-valued socket).

getChildList(...)

Returns: [SocketSpec]: The list of contained socket specs.

getDataType(...)

Returns: DataTypeType: The type of data that flows through this socket (one of the DataTypeType enum).

getDirection(...)

Returns: DirectionType: The direction of the socket (one of the DirectionType enum).

getLayout(...)

Returns: LayoutType: The layout of the socket (one of the LayoutType enum).

getLifeScope(...)

Returns: LifeScopeType: The life scope of the socket (one of the LifeScopeType enum).

getName(...)

Returns: str: The name of the socket.

setName(...)

Sets the name of the socket.

Parameters:

name (str)