Aimsun Next Scripting  22
Public Member Functions | List of all members
NodeOutputElement Class Reference

Public Member Functions

 NodeOutputElement ()
 
const QVector< qint32 > & getModes () const
 
qint32 getPurpose () const
 
QVector< GKObject * > getModes (GKModel *iModel) const
 
GKTripPurposegetTripPurpose (GKModel *iModel) const
 
qint32 getVehicle () const
 
void setTargetId (const uint &targetId)
 
uint getTargetId () const
 
QVector< FourSteps::DataDiscriminantgetDiscriminants () const
 
void setDiscriminant (const FourSteps::DataDiscriminant &iDiscriminant, const QVariant &dataVal)
 
QVariant getDiscriminant (const FourSteps::DataDiscriminant &iDiscriminant) const
 
void removeDiscriminant (const FourSteps::DataDiscriminant &iDiscriminant)
 
QString getOutputTypeName () const
 
EDataObjectType getOutputType () const
 
void setOutputType (const EDataObjectType iOutputType)
 

Detailed Description

This class describes the relevant properties (discriminants) of any object used as input or output in the FourStepsExperiment context. For instance, a Skim matrix can be described setting the output type to EDataObjecttype::eSkim and setting the specific characteristic such as the GKUserClass or the GKTimePeriod with the use of Discriminants. A NodeConnection will contain NodeOutputElement instances, that come from the connection origin Output Slot.

Constructor & Destructor Documentation

◆ NodeOutputElement()

NodeOutputElement::NodeOutputElement ( )

Member Function Documentation

◆ getDiscriminant()

QVariant NodeOutputElement::getDiscriminant ( const FourSteps::DataDiscriminant iDiscriminant) const

Gets the value associated to the discriminant in this NodeOutputElement.

◆ getDiscriminants()

QVector< FourSteps::DataDiscriminant > NodeOutputElement::getDiscriminants ( ) const

Gets the discriminants specified.

◆ getModes() [1/2]

const QVector< qint32 > & NodeOutputElement::getModes ( ) const

Gets the GKTransportationModes Ids associated.

◆ getModes() [2/2]

QVector< GKObject * > NodeOutputElement::getModes ( GKModel iModel) const

Gets the Transportation Modes.

◆ getOutputType()

EDataObjectType NodeOutputElement::getOutputType ( ) const

Gets the output type of the NodeOutputElement.

◆ getOutputTypeName()

QString NodeOutputElement::getOutputTypeName ( ) const

Gets the Type Name represented by the NodeOutputElement: Skim Matrix,OD Matrix, Volume(APA) or Generation/Attraction vector.

◆ getPurpose()

qint32 NodeOutputElement::getPurpose ( ) const

Gets the trip purpose Id.

◆ getTargetId()

uint NodeOutputElement::getTargetId ( ) const

Gets the Id of the GKObject that generated this NodeOutputElement (if any).

◆ getTripPurpose()

GKTripPurpose * NodeOutputElement::getTripPurpose ( GKModel iModel) const

Gets the GKTripPurpose.

◆ getVehicle()

qint32 NodeOutputElement::getVehicle ( ) const

Gets the GKVehicle Id.

◆ removeDiscriminant()

void NodeOutputElement::removeDiscriminant ( const FourSteps::DataDiscriminant iDiscriminant)

Removes the specified type of discriminant from this NodeOutputElement.

◆ setDiscriminant()

void NodeOutputElement::setDiscriminant ( const FourSteps::DataDiscriminant iDiscriminant,
const QVariant &  dataVal 
)

Sets the value of the specified discriminant.

◆ setOutputType()

void NodeOutputElement::setOutputType ( const EDataObjectType  iOutputType)

Sets the output type of the NodeOutputElement.

◆ setTargetId()

void NodeOutputElement::setTargetId ( const uint &  targetId)

Sets the Target Id.

© Aimsun SLU
Aimsun ®