Edge functions

Functions
int	CAtlas::AddEdge (int vID0, int vID1, AT_scalar value, void *userDef=NULL)
int	CAtlas::RemoveEdge (int vID0, int vID1)
int	CAtlas::SetEdgeConfiguration (int vID0, int vID1, AT_scalar value, void *userDef=NULL)
int	CAtlas::GetEdgeConfiguration (int vID0, int vID1, AT_scalar *value, void **userDef=NULL)
int	CAtlas::SetEdgeInvalidation (int vID0, int vID1, bool invalidate)

---

Function Documentation

int CAtlas::AddEdge (  int  vID0, int  vID1, AT_scalar  value, void *  userDef = NULL )  [inherited]

Adds a connection between two vertices. Parameters: vID0  The ID of the first vertex. vID1  The ID of the second vertex. value  The value of the edge, used by finding shortest paths. userDef  An optional pointer to store user defined data with the edge. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::RemoveEdge (  int  vID0, int  vID1 )  [inherited]

This function removes a connection from the graph. Parameters: vID0  The ID of the first vertex. vID1  The ID of the second vertex. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::SetEdgeConfiguration (  int  vID0, int  vID1, AT_scalar  value, void *  userDef = NULL )  [inherited]

This function sets the value of an edge. Parameters: vID0  The ID of the first vertex. vID1  The ID of the second vertex. value  The new value for the edge. userDef  An optional pointer to store user defined data with the vertex. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::GetEdgeConfiguration (  int  vID0, int  vID1, AT_scalar *  value, void **  userDef = NULL )  [inherited]

This function retrieves the value of an edge. Parameters: vID0  The ID of the first vertex. vID1  The ID of the second vertex. value  The value of the edge. userDef  Return value: optional, the user defined pointer associated with the vertex. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

int CAtlas::SetEdgeInvalidation (  int  vID0, int  vID1, bool  invalidate )  [inherited]

Temporarily invalidate an edge. Parameters: vID0  The ID of the first vertex. vID1  The ID of the second vertex. invalidate  Set to true or false. Returns: The function returns AT_SUCCESS on success, and an errorcode on failure.

---