Package autodesk_toxik :: Module graph :: Class StructuredInput

Class StructuredInput

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

A structured input is simply an input made of other inputs (structured or not).

Instance Methods

__getitem__(...)

Input

appendInput(...)
Appends a new input at the end of the inputs vector.

Input

appendStructuredInput(...)
Appends a new structured input at the end of the inputs vector.

Input

getInput(...)
Returns: The child input with the specified name.

int

getInputIndex(...)
Returns: The position of the given input in the vector or -1 if the given input cannot be found.

[Input]

getInputs(...)
Returns: A list with the child inputs.

int

getNbInputs(...)
Returns: The number of inputs in the structured input.

Input

insertInput(...)
Inserts a new input into the inputs vector before the given input.

Input

insertStructuredInput(...)
Inserts a new structured input into the inputs vector before the given input.

moveInput(...)
Moves an input in the inputs vector before the given input.

removeInput(...)
Remove the specified input from the inputs vector.

Input

retrieveInput(...)
Returns: The input in the vector at the specified index.

Inherited from Input: __rshift__, connect, disconnect, getInputPolicy, getOutput, getOwnerInput

Inherited from Socket: __cmp__, __init__, __reduce__, getDataType, getDirection, getGraph, getId, getLayout, getLifeScope, getName, getNode, getQualifiedName, isConnected, setName

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

appendInput(...)

Appends a new input at the end of the inputs vector.

Parameters:

name (str) - New input name. It should be unique within the structure.
type (DataTypeType) - Input data type.
cardinality (Cardinality) - Input cardinality.

Returns: Input

The new input.

appendStructuredInput(...)

Appends a new structured input at the end of the inputs vector.

Parameters:

name (str) - New input name. It should be unique within the structure.
structuredType (list of tuples) - The structured type is an ordered list of tuples that each describe an input in the structured input. In each tuple, the first item is a string that specifies the input name. The second item specifies the input type which can either be a simple type (DataTypeType) or a structured type (an ordered list of tuples as currently described). The third item of the tuple is optional and specifies the input cardinality (Cardinality) which defaults to Cardinality.SINGLEVALUED.
cardinality (Cardinality) - Input cardinality.

Returns: Input

The new structured input.

Raises:

StandardError - If the structuredType parameter is malformed.

getInput(...)

Parameters:

name (str)

Returns: Input

The child input with the specified name.

getInputIndex(...)

Parameters:

input (Input) - Input to find.

Returns: int

The position of the given input in the vector or -1 if the given input cannot be found.

getInputs(...)

Returns: [Input]: A list with the child inputs.

getNbInputs(...)

Returns: int: The number of inputs in the structured input.

insertInput(...)

Inserts a new input into the inputs vector before the given input. The new input is inserted at the end of the vector if the given input is None.

Parameters:

beforeInput (Input) - Input to insert the new input before or None to insert at the end.
name (str) - New input name. It should be unique within the structure.
type (DataTypeType) - Input data type.
cardinality (Cardinality) - Input cardinality.

Returns: Input

The new input.

insertStructuredInput(...)

Inserts a new structured input into the inputs vector before the given input. The new input is inserted at the end of the vector if the given input is None.

Parameters:

beforeInput (Input) - Input to insert the new input before or None to insert at the end.
name (str) - New input name. It should be unique within the structure.
structuredType (list of tuples) - The structured type is an ordered list of tuples that each describe an input in the structured input. In each tuple, the first item is a string that specifies the input name. The second item specifies the input type which can either be a simple type (DataTypeType) or a structured type (an ordered list of tuples as currently described). The third item of the tuple is optional and specifies the input cardinality (Cardinality) which defaults to Cardinality.SINGLEVALUED.
cardinality (Cardinality) - Input cardinality.

Returns: Input

The new structured input.

Raises:

StandardError - If the structuredType parameter is malformed.

moveInput(...)

Moves an input in the inputs vector before the given input. The input is moved to the end of the vector if the given input is None.

Parameters:

movedInput (Input) - Input to move.
beforeInput (Input) - Input is moved before this input or to the end if set to None.

removeInput(...)

Remove the specified input from the inputs vector.

Parameters:

input (Input)

Raises:

RuntimeError - If the specified input is static (input.getLifeScope() == graph.LifeScopeType.STATIC).

retrieveInput(...)

Parameters:

index (int)

Returns: Input

The input in the vector at the specified index.