AGV.Connections
Description
An interface for accessing AGV control point connections.
The AGV.Connections class allows you to query and dereference control point connections. You construct an AGV.Connections instance with a constructor. Here you pass the owner of the connections, followed by the name of the connection.
AGV.Connections connections = AGV.Connections(current, "Location");
You then can query how many connections are present with the length property.
int numConnections = connections.length;
To dereference a specific connection, use the [] array dereference operator.
Object obj = connections[1];
Properties
length | Returns the number of connections present on the object. |
rank | Gets the rank of the connection type. |
Constructor
Connections | Creates a new set of connections with the passed owner and associated with the named connection. |
Operators
[] | Dereferences the connected object by control point connection rank. |
Details
AGV.Connections.length
readonly int length
Description
Returns the number of connections present on the object.
int numConnections = AGV.Connections(current, "PickupPoints").length;
AGV.Connections.rank
readonly int rank
Description
Gets the rank of the connection type.
This is for use in subsequent AGV.Connections() constructors.
AGV.Connections Constructor
Connections( Object owner , string connectionName ) |
Connections( Object owner , int connectionRank ) |
Parameters
owner | The owner of the control point connections. |
connectionName | The name of the control point connections. |
connectionRank | The rank of the control point connections. |
Description
Creates a new set of connections with the passed owner and associated with the named connection.
AGV.Connections.operator []
Object operator []( int index ) |
Parameters
index | The index of the connected object. |
Returns
Object | The target connected object. |
Description
Dereferences the connected object by control point connection rank.