Aimsun Next Scripting  22
Public Member Functions | List of all members
DTACentroid Class Reference
Inheritance diagram for DTACentroid:

Public Member Functions

const GKCentroidgetRelatedCentroid () const
 
uint getNumEntranceConnections () const
 
uint getNumExitConnections () const
 
int getNumEntranceSections () const
 
int getNumExitSections () const
 
bool hasExitSection (DTASection *sect) const
 
const DTASectiongetEntranceSection (uint pos) const
 
const DTASectiongetExitSection_ (uint pos) const
 
bool hasReservedEntranceConnection (const DTANetwork *network, uint pos) const
 
bool hasReservedExitConnection (const DTANetwork *network, uint pos) const
 
int getEntranceConnector (DTASection *asect) const
 
int getExitConnector (DTASection *asect) const
 
double getPercentageExitConnection (uint pos) const
 
double getPercentageEntranceConnection (uint pos) const
 
bool getAsOrigConsider_percentage () const
 
bool getAsDestConsider_percentage () const
 
bool getOnlyBestEntrance () const
 
uint getNbConnectorsConsiderAsDest () const
 
uint getNbConnectorsConsiderAsOrig () const
 
bool isValidExitConnectorForVehicleType (uint pos, const DTAVehicleType *vehType) const
 
bool isValidEntranceConnectorForVehicleType (uint pos, const DTAVehicleType *vehType) const
 
double evaluateRouteChoiceFunction (const DTAManager *manager, DTACentroid *origin, const DTAGenericPath *path, DTASection *entranceSection, DTAVehicleType *vehType, DTADescription::RouteChoiceType rcType, const GKFunctionCostContext *context)
 

Member Function Documentation

◆ evaluateRouteChoiceFunction()

double DTACentroid::evaluateRouteChoiceFunction ( const DTAManager manager,
DTACentroid origin,
const DTAGenericPath path,
DTASection entranceSection,
DTAVehicleType vehType,
DTADescription::RouteChoiceType  rcType,
const GKFunctionCostContext context 
)

Returns the probability of using the path form origin and this destination with vehicle type and using a the route choice function rcType.

◆ getAsDestConsider_percentage()

bool DTACentroid::getAsDestConsider_percentage ( ) const

Returns true if this centroid is using destination percentages.

◆ getAsOrigConsider_percentage()

bool DTACentroid::getAsOrigConsider_percentage ( ) const

Returns true if this centroid is using origin percentages.

◆ getEntranceConnector()

int DTACentroid::getEntranceConnector ( DTASection asect) const

Returns the index going from 0 to getNumEntranceConnections()-1 that has the section. Returns -1 if this section is not used in any connector.

◆ getEntranceSection()

const DTASection * DTACentroid::getEntranceSection ( uint  pos) const

Returns the entrance section by using the index going from 0 to getNumEntranceSections()-1.

◆ getExitConnector()

int DTACentroid::getExitConnector ( DTASection asect) const

Returns the index going from 0 to getNumExitConnections()-1 that has the section. Returns -1 if this section is not used in any connector.

◆ getExitSection_()

const DTASection * DTACentroid::getExitSection_ ( uint  pos) const

Returns the exit section by using the index going from 0 to getNumExitSections()-1.

◆ getNbConnectorsConsiderAsDest()

uint DTACentroid::getNbConnectorsConsiderAsDest ( ) const

Returns the number of exit connections taking into account if this centroid is using destination percentages. If it's not using destination percentages then returns 1.

◆ getNbConnectorsConsiderAsOrig()

uint DTACentroid::getNbConnectorsConsiderAsOrig ( ) const

Returns the number of entrance connections taking into account if this centroid is using origin percentages. If it's not using origin percentages then returns 1.

◆ getNumEntranceConnections()

uint DTACentroid::getNumEntranceConnections ( ) const

Returns the number of entrance connectors. Connectors that let vehicles enter into the network.

◆ getNumEntranceSections()

int DTACentroid::getNumEntranceSections ( ) const

Returns the number of entrance sections. Sections that let vehicles enter into the network.

◆ getNumExitConnections()

uint DTACentroid::getNumExitConnections ( ) const

Returns the number of exit connectors. Connectors that let vehicles exit the network.

◆ getNumExitSections()

int DTACentroid::getNumExitSections ( ) const

Returns the number of exit sections. Sections that let vehicles exit the network.

◆ getOnlyBestEntrance()

bool DTACentroid::getOnlyBestEntrance ( ) const

Returns true if this centroid is using the best entrance option.

◆ getPercentageEntranceConnection()

double DTACentroid::getPercentageEntranceConnection ( uint  pos) const

Returns the percentage of the connector defined by pos (from 0 to getNumExitConnections()-1). Returns 0 if this pos or this centroid is no using percentages.

◆ getPercentageExitConnection()

double DTACentroid::getPercentageExitConnection ( uint  pos) const

Returns the percentage of the connector defined by pos (from 0 to getNumEntranceConnections()-1). Returns 0 if this pos or this centroid is no using percentages.

◆ getRelatedCentroid()

const GKCentroid * DTACentroid::getRelatedCentroid ( ) const

Returns the related kernel centroid.

◆ hasExitSection()

bool DTACentroid::hasExitSection ( DTASection sect) const

Returns true if this centroid has the section as an exit section.

◆ hasReservedEntranceConnection()

bool DTACentroid::hasReservedEntranceConnection ( const DTANetwork network,
uint  pos 
) const

Returns true if the connection defined by pos (from 0 to getNumEntranceConnections()-1) is reserved by any vehicle type.

◆ hasReservedExitConnection()

bool DTACentroid::hasReservedExitConnection ( const DTANetwork network,
uint  pos 
) const

Returns true if the connection defined by pos (from 0 to getNumExitConnections()-1) is reserved by any vehicle type.

◆ isValidEntranceConnectorForVehicleType()

bool DTACentroid::isValidEntranceConnectorForVehicleType ( uint  pos,
const DTAVehicleType vehType 
) const

Returns true if this connector pos (from 0 to getNumEntranceConnections()-1) can be used by vehicle type.

◆ isValidExitConnectorForVehicleType()

bool DTACentroid::isValidExitConnectorForVehicleType ( uint  pos,
const DTAVehicleType vehType 
) const

Returns true if this connector pos (from 0 to getNumExitConnections()-1) can be used by vehicle type.

© Aimsun SLU
Aimsun ®