GvRun Class Reference

#include <c4d_graphview.h>

Detailed Description

Contains helper functions for controlling node evaluation. Cannot be instantiated.

Public Member Functions
void	SetCalculationTable (GvCalcTable *t)
Bool	AddNodeToCalculationTable (GvNode *node, Bool force_add=false)
Bool	CalculateTable (GvCalc *calc)
Int32	GetCpuID ()
void	IncrementID ()
void	SetError (GvCalcError error)
GvCalcError	GetError ()
void	SetState (GvCalcState state)
GvCalcState	GetState ()
Bool	IsIterationPath ()

Private Member Functions
	GvRun ()
	~GvRun ()

Constructor & Destructor Documentation

GvRun()

GvRun ( )

private

~GvRun()

~GvRun ( )

private

Member Function Documentation

SetCalculationTable()

void SetCalculationTable

(

GvCalcTable *

t

)

Attaches a calculation table.

Parameters

[in]

t

The calculation table to attach. The caller owns the pointed table.

AddNodeToCalculationTable()

Bool AddNodeToCalculationTable	(	GvNode *	node,
		Bool	force_add = false
	)

Marks a node to be calculated with the next CalculateTable(). A node is only added once. Equivalent to GvCalcTable::AddNodeToTable().

Parameters

[in]	node	The node to add. The caller owns the pointed node.
[in]	force_add	true to disable checks for recursion and iteration. Should never be used under normal circumstances.

Returns

true if the node was added to the calculation table, otherwise false.

CalculateTable()

Bool CalculateTable

(

GvCalc *

calc

)

Calculates all nodes added to the calculation table.

Parameters

[in]

calc

The calculation helper. The caller owns the pointed calculation helper.

Returns

true if the table was calculated, otherwise false.

GetCpuID()

Int32 GetCpuID

(

)

Retrieves the ID of the calculated CPU.

Returns

The CPU ID. Normally 0.

IncrementID()

void IncrementID

(

)

Increments the run ID. Used to check if a port is already calculated.

SetError()

void SetError

(

GvCalcError

error

)

Sets the error flag.

Parameters

[in]

error

The error flag: GvError

GetError()

GvCalcError GetError

(

)

Gets the error flag.

Returns

The error flag: GvError

SetState()

void SetState

(

GvCalcState

state

)

Sets the failure state.

Parameters

[in]

state

The failure state: GvCalcState

GetState()

GvCalcState GetState

(

)

Gets the failure state.

Returns

The failure state: GvCalcState

IsIterationPath()

Bool IsIterationPath

(

)

Checks if the current calculation is an iteration (a recalculation of a part of the graph).

Returns

true if this is an iteration path, otherwise false.