Aimsun Next Scripting  22
Public Member Functions | List of all members
NodeCompute Class Referenceabstract
Inheritance diagram for NodeCompute:
FourStepLoop

Public Member Functions

FourStepsExperimentgetFourStepsExperiment () const
 
QString getName () const
 
qint32 getId () const
 
QUuid getUuid () const
 
GKObjectgetTarget ()
 
void setOutputObjects (const QString &slotId, const QVector< GKObject * > &objects)
 
QVector< NodeOutputElementgetSlotInputElements (const QString &slotId) const
 
QVector< NodeOutputElementgetSlotOutputElements (const QString &slotId) const
 
QVector< GKObject * > getInputObjects (const QString &slotId) const
 
QVector< GKObject * > getOutputObjects (const QString &slotId) const
 
virtual bool areConnectionsCompatible ()=0
 
virtual bool execute (QString taskId)=0
 
virtual QVector< GKObject * > candidates () const =0
 
virtual void predictOutputs (const NodeSlot *iSlot=nullptr) const =0
 
virtual NodeOutput getOutputList (const NodeSlot *iSlot)=0
 
QVector< NodeSlot * > getInputSlots () const
 
QVector< NodeSlot * > getOutputSlots () const
 

Detailed Description

This class is each box in a four-step diagram: the base class which represents GKObjects of the FourSteps context (MacroExperiment, GKODMatrix, ...). It contains NodeSlots with input or output data and it may also generate outputs (NodeCompute::execute). Additionally, it can determine which NodeOutputElements will be available at each output slot.

Member Function Documentation

◆ areConnectionsCompatible()

virtual bool NodeCompute::areConnectionsCompatible ( )
pure virtual

Checks whether the current set of connections is compatible with this NodeCompute.

◆ candidates()

virtual QVector< GKObject * > NodeCompute::candidates ( ) const
pure virtual

Gets the candidate GKObjects the Associated item can be. Example: in a NodeCompute Distribution candidates are Distribution Experiments.

◆ execute()

virtual bool NodeCompute::execute ( QString  taskId)
pure virtual

Executes the NodeCompute.

◆ getFourStepsExperiment()

FourStepsExperiment * NodeCompute::getFourStepsExperiment ( ) const

Gets the Four Steps Experiment to which this node belongs

◆ getId()

qint32 NodeCompute::getId ( ) const

Gets the id of this node (unique in the associated FourStepsExperiment).

◆ getInputObjects()

QVector< GKObject * > NodeCompute::getInputObjects ( const QString &  slotId) const

Gets the input objects for the given slotId.

◆ getInputSlots()

QVector< NodeSlot * > NodeCompute::getInputSlots ( ) const

Gets the input slots of the node.

◆ getName()

QString NodeCompute::getName ( ) const

Gets the Node name.

◆ getOutputList()

virtual NodeOutput NodeCompute::getOutputList ( const NodeSlot iSlot)
pure virtual

Gets the NodeOutput resulting from this node. If the slot provided is None, it returns the NodeOutput associated to all the output NodeSlots.

◆ getOutputObjects()

QVector< GKObject * > NodeCompute::getOutputObjects ( const QString &  slotId) const

Gets the output objects for the given slotId.

◆ getOutputSlots()

QVector< NodeSlot * > NodeCompute::getOutputSlots ( ) const

Gets the output slots of the node.

◆ getSlotInputElements()

QVector< NodeOutputElement > NodeCompute::getSlotInputElements ( const QString &  slotId) const

Gets the NodeOutputElement describing the inputs for a given slotId.

◆ getSlotOutputElements()

QVector< NodeOutputElement > NodeCompute::getSlotOutputElements ( const QString &  slotId) const

Gets the NodeOutputElement describing the outputs for a given slotId.

◆ getTarget()

GKObject * NodeCompute::getTarget ( )

Gets the target object associated to this node. For example, for a Distribution node it will be a Distribution Experiment or for a Script node a GKScript.

◆ getUuid()

QUuid NodeCompute::getUuid ( ) const

Gets the Unique id of this node.

◆ predictOutputs()

virtual void NodeCompute::predictOutputs ( const NodeSlot iSlot = nullptr) const
pure virtual

Predicts which GKObjects will result from the execution and stores this information in each output NodeSlot.

◆ setOutputObjects()

void NodeCompute::setOutputObjects ( const QString &  slotId,
const QVector< GKObject * > &  objects 
)

Sets the Output objects for the given slotId.

© Aimsun SLU
Aimsun ®