Bus¶

class Bus¶

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:: A copy of this object
Return type:: Bus

GetAccessPort(accessType)¶

Returns the bus port dependent on accessType.

Parameters:

accessType : str¶: ‘AccessActiveNode’, ‘AccessManipulation’, ‘ServiceApplicationLayer’

Returns:

Bus port

Return type:

str

GetAvailableChannelsAndProtocols()¶

Returns a list of all available channels and protocols of the bus.

Returns:: List of tuples (channel name, protocol)
Return type:: list[list[str]]

GetChannel()¶

Returns the channel of the bus.

Returns:: Channel of the bus
Return type:: str

GetDatabaseArtifactReference()¶

Returns the bus database artifact reference.

Returns:: The bus database artifact reference
Return type:: ArtifactReference

GetDatabaseFile()¶

Returns the bus database file.

Returns:: The bus database file
Return type:: str

GetName()¶

Returns the name of the bus.

Returns:: Name of the bus
Return type:: str

GetProtocol()¶

Returns the protocol of the bus.

Returns:: Protocol
Return type:: str

Rename(newBusKey)¶

Renames the bus.

Parameters:

newBusKey : str¶: New name of the bus object

SetAccessPort(accessType, accessPort)¶

Sets the bus port dependent on accessType.

Parameters:

accessType : str¶: ‘AccessActiveNode’, ‘AccessManipulation’, ‘ServiceApplicationLayer’
accessPort : str¶: Port to be set

SetChannel(channel)¶

Sets the channel of the bus.

Parameters:

channel : str¶: Channel of the bus

SetDatabaseArtifactReference(busDbReference)¶

Sets the bus database artifact reference.

Parameters:

busDbReference¶: bus database artifact reference to be set

SetDatabaseFile(database)¶

Sets the bus database file.

Parameters:

database : str¶: The bus database file

SetProtocol(protocol)¶

Sets the protocol of the bus.

Parameters:

protocol : str¶: Protocol to be set