PDF
AGVC SDK  0.8.0
Path

Functions

std::vector< PathStationagvc_interface::AgvcInterface::getAllPaths ()
 Queries all path information on the current map.
std::vector< PathStationagvc_interface::AgvcInterface::getAllPathsOfTargetMap (const Header &map_header)
 Queries all path information on the specified map.
PathStation agvc_interface::AgvcInterface::getCurrentPath ()
 Queries the path currently being tracked by the AGV.
int agvc_interface::AgvcInterface::generatePath (const PathStation &path_station)
 Generates or modifies one path.
int agvc_interface::AgvcInterface::generatePaths (const std::vector< PathStation > &paths_station)
 Generates or modifies multiple paths.
int agvc_interface::AgvcInterface::deletePath (const Header &path_header)
 Deletes one path.
int agvc_interface::AgvcInterface::deletePaths (const std::vector< Header > &paths_header)
 Deletes multiple paths.

Detailed Description

Functions for generating, modifying, deleting, and querying AGVC map paths.

Function Documentation

◆ deletePath()

int agvc_interface::AgvcInterface::deletePath ( const Header & path_header)

Deletes one path.

Parameters
[in]path_headerPath information to delete (path ID, name, time, map ID).
Returns
10100000: path deleted successfully; else: failed to delete the path.

◆ deletePaths()

int agvc_interface::AgvcInterface::deletePaths ( const std::vector< Header > & paths_header)

Deletes multiple paths.

Parameters
[in]paths_headerPath information to delete (path ID, name, time, map ID).
Returns
10100000: paths deleted successfully; else: failed to delete paths.

◆ generatePath()

int agvc_interface::AgvcInterface::generatePath ( const PathStation & path_station)

Generates or modifies one path.

Parameters
[in]path_stationPath information to generate or modify.
Returns
10100000: path modified or generated successfully; else: failed to modify or generate the path.

◆ generatePaths()

int agvc_interface::AgvcInterface::generatePaths ( const std::vector< PathStation > & paths_station)

Generates or modifies multiple paths.

Parameters
[in]paths_stationPath information to generate or modify.
Returns
10100000: paths modified or generated successfully; else: failed to modify or generate paths.

◆ getAllPaths()

std::vector< PathStation > agvc_interface::AgvcInterface::getAllPaths ( )

Queries all path information on the current map.

Returns
All path information on the current map.

◆ getAllPathsOfTargetMap()

std::vector< PathStation > agvc_interface::AgvcInterface::getAllPathsOfTargetMap ( const Header & map_header)

Queries all path information on the specified map.

Parameters
[in]map_headerHeader of the specified map (command ID, name, time, map ID).
Returns
All path information on the specified map.

◆ getCurrentPath()

PathStation agvc_interface::AgvcInterface::getCurrentPath ( )

Queries the path currently being tracked by the AGV.

Returns
Information about the path currently being tracked.