Definition at line 2527 of file objectclasses.py.
Public Member Functions | |
| def | __init__ |
| def | GetSystem |
| def | GetSaveStatus |
| def | GetName |
| def | GetNodeTo |
| def | GetNodeFrom |
| def | GetPortTo |
| def | GetColor |
| def | GetPortFrom |
| def | GetPortTypeTo |
| def | GetPortTypeFrom |
| def | GetReverseLink |
| def | GetType |
| def | GetBidirectional |
| def | GetLinkUsed |
| def | GetLinkInfo |
| def | GetErrorMessage |
| def | SetErrorMessage |
| def | SetSaveStatus |
| def | SetName |
| def | SetNodeTo |
| def | SetNodeFrom |
| def | SetPortTo |
| def | SetPortFrom |
| def | SetPortTypeTo |
| def | SetPortTypeFrom |
| def | SetReverseLink |
| def | SetSystem |
| def | SetLinkInfo |
| def | IsTypeChanged |
| def | IsBidirChanged |
| def | IsLkusedChanged |
| def | IsReversed |
| def | IsLkInfoChanged |
| def | SetType |
| def | SetBidirectional |
| def | SetLinkUsed |
| def | SetDict |
| def | GetObjectInfo |
| def | Update |
| def | PrintSaveFunction |
| def | Save |
| def | UpdateLinkID |
| def | SetLinkIDByDeviceAndPort |
| def | Delete |
| def | Modify |
| def | Create |
Private Attributes | |
| _deviceInfo | |
| __reverseLink | |
| __cfg | |
| __errormessage | |
| __errormesage | |
| def objectclasses::Link::__init__ | ( | self, | ||
| systemname, | ||||
linkID = -1, |
||||
reverseLink = False, |
||||
new = True | ||||
| ) |
Constructor.
Parameters: - (Obsolete) Name of the subsystem a link is in, but is now longer needed to be set because the subsystem it is in can be retrieved from the devices it connects. - If already stored in ConfDB the linkID is set, otherwise it is -1 - only used when creating links in path view. If this is true the link is the opposite of what that is set (from = to and to = from) - whether the link is being created (True), or already created (False).
Definition at line 2541 of file objectclasses.py.
| def objectclasses::Link::GetSystem | ( | self | ) |
Definition at line 2582 of file objectclasses.py.
| def objectclasses::Link::GetSaveStatus | ( | self | ) |
Definition at line 2584 of file objectclasses.py.
| def objectclasses::Link::GetName | ( | self | ) |
Definition at line 2586 of file objectclasses.py.
| def objectclasses::Link::GetNodeTo | ( | self | ) |
Definition at line 2588 of file objectclasses.py.
| def objectclasses::Link::GetNodeFrom | ( | self | ) |
Definition at line 2590 of file objectclasses.py.
| def objectclasses::Link::GetPortTo | ( | self | ) |
Definition at line 2592 of file objectclasses.py.
| def objectclasses::Link::GetColor | ( | self | ) |
Definition at line 2594 of file objectclasses.py.
| def objectclasses::Link::GetPortFrom | ( | self | ) |
Definition at line 2596 of file objectclasses.py.
| def objectclasses::Link::GetPortTypeTo | ( | self | ) |
Definition at line 2598 of file objectclasses.py.
| def objectclasses::Link::GetPortTypeFrom | ( | self | ) |
Definition at line 2600 of file objectclasses.py.
| def objectclasses::Link::GetReverseLink | ( | self | ) |
Definition at line 2602 of file objectclasses.py.
| def objectclasses::Link::GetType | ( | self | ) |
Definition at line 2604 of file objectclasses.py.
| def objectclasses::Link::GetBidirectional | ( | self | ) |
Definition at line 2606 of file objectclasses.py.
| def objectclasses::Link::GetLinkUsed | ( | self | ) |
Definition at line 2608 of file objectclasses.py.
| def objectclasses::Link::GetLinkInfo | ( | self | ) |
Definition at line 2610 of file objectclasses.py.
| def objectclasses::Link::GetErrorMessage | ( | self | ) |
Get the error message that was set most recently.
!return - the error message string
Reimplemented from objectclasses::DBInfo.
Definition at line 2612 of file objectclasses.py.
| def objectclasses::Link::SetErrorMessage | ( | self, | ||
| msg | ||||
| ) |
Set the error message so that it can be looked up. - the message string
Reimplemented from objectclasses::DBInfo.
Definition at line 2614 of file objectclasses.py.
| def objectclasses::Link::SetSaveStatus | ( | self, | ||
| state | ||||
| ) |
Definition at line 2618 of file objectclasses.py.
| def objectclasses::Link::SetName | ( | self, | ||
| name | ||||
| ) |
Definition at line 2620 of file objectclasses.py.
| def objectclasses::Link::SetNodeTo | ( | self, | ||
| node | ||||
| ) |
Definition at line 2624 of file objectclasses.py.
| def objectclasses::Link::SetNodeFrom | ( | self, | ||
| node | ||||
| ) |
Definition at line 2627 of file objectclasses.py.
| def objectclasses::Link::SetPortTo | ( | self, | ||
| port | ||||
| ) |
Definition at line 2630 of file objectclasses.py.
| def objectclasses::Link::SetPortFrom | ( | self, | ||
| port | ||||
| ) |
Definition at line 2633 of file objectclasses.py.
| def objectclasses::Link::SetPortTypeTo | ( | self, | ||
| porttype | ||||
| ) |
Definition at line 2636 of file objectclasses.py.
| def objectclasses::Link::SetPortTypeFrom | ( | self, | ||
| porttype | ||||
| ) |
Definition at line 2639 of file objectclasses.py.
| def objectclasses::Link::SetReverseLink | ( | self, | ||
| reverse | ||||
| ) |
Definition at line 2642 of file objectclasses.py.
| def objectclasses::Link::SetSystem | ( | self, | ||
| system | ||||
| ) |
Definition at line 2644 of file objectclasses.py.
| def objectclasses::Link::SetLinkInfo | ( | self, | ||
| linkinfo, | ||||
changed = True | ||||
| ) |
Definition at line 2648 of file objectclasses.py.
| def objectclasses::Link::IsTypeChanged | ( | self | ) |
Definition at line 2655 of file objectclasses.py.
| def objectclasses::Link::IsBidirChanged | ( | self | ) |
Definition at line 2657 of file objectclasses.py.
| def objectclasses::Link::IsLkusedChanged | ( | self | ) |
Definition at line 2659 of file objectclasses.py.
| def objectclasses::Link::IsReversed | ( | self | ) |
Definition at line 2661 of file objectclasses.py.
| def objectclasses::Link::IsLkInfoChanged | ( | self | ) |
Definition at line 2663 of file objectclasses.py.
| def objectclasses::Link::SetType | ( | self, | ||
| linktype, | ||||
changed = True | ||||
| ) |
Update linktype name for a link.
Definition at line 2669 of file objectclasses.py.
| def objectclasses::Link::SetBidirectional | ( | self, | ||
| bidir, | ||||
changed = True | ||||
| ) |
Definition at line 2676 of file objectclasses.py.
| def objectclasses::Link::SetLinkUsed | ( | self, | ||
| lkused, | ||||
changed = True | ||||
| ) |
Definition at line 2683 of file objectclasses.py.
| def objectclasses::Link::SetDict | ( | self, | ||
| newdict | ||||
| ) |
Copy member variable (parameters) information from a link object to another (this)
Definition at line 2694 of file objectclasses.py.
| def objectclasses::Link::GetObjectInfo | ( | self, | ||
doNotLookUp = True | ||||
| ) |
Get all info about a Point-to-Point connection (link).
TODO: Here we can have checks whether we need to look for link information in dirty objects list or ConfDB if this is the most recent version of the link object.
- whether we should look for information about this object in dirty objects list and ConfDB (False) or not(True).
Definition at line 2709 of file objectclasses.py.
| def objectclasses::Link::Update | ( | self, | ||
doNotCheckInDirtyList = False | ||||
| ) |
Update the information/parameters for this link with the most recent information, and also return the member variable dictionary.
Parameters: - if set to True, we do not check in the dirty objects list for a version of the object.
!return - the member variable dictionary of parameters for the link
Definition at line 2726 of file objectclasses.py.
| def objectclasses::Link::PrintSaveFunction | ( | self, | ||
first = False, |
||||
insertmany = False, |
||||
commit = True | ||||
| ) |
A function that returns the string to the function that will be called in the ConfDBLibrary for the given save and modify status of this data object, as well as use of single or multiple insert.
Parameters: Same as for Save(...)
!return - returns a String with the function name as well as all set parameters
Definition at line 2829 of file objectclasses.py.
| def objectclasses::Link::Save | ( | self, | ||
first = False, |
||||
insertmany = False, |
||||
commit = True | ||||
| ) |
Update changes to the ConfDB for this object.
Parameters: - if first is True; it is the first kind of this db update; prepare and initialize cache, if first is False, add it to the already existing cache. cache is only used if insertmany = True. - If insertmany is set to false, the single insert function will be used, which is optimized for single inserts. If insertmany is set to true, the multiple insert function will be used, which is optimized for multiple inserts (use of cache) - if commit is set to false, no data will be commited, put are put on hold in the cache, if commit is set to true, all data that are put on hold in the cache will be commited.
Definition at line 2897 of file objectclasses.py.
| def objectclasses::Link::UpdateLinkID | ( | self | ) |
Before we store a link in the ConfDB, the linkID/name is a temporary name that is automatically assigned; this has to be changed to the unique ID set to the link in the ConfDB. This method updates the linkID to what it was set to in the ConfDB.
!return - False if an error occurs, True otherwise
Definition at line 3002 of file objectclasses.py.
| def objectclasses::Link::SetLinkIDByDeviceAndPort | ( | self, | ||
| dev_from, | ||||
| port_from, | ||||
| porttype_from, | ||||
| dev_to, | ||||
| port_to, | ||||
| porttype_to | ||||
| ) |
This is the method that actually finds the new link ID to a link that was just stored in the ConfDB, by retrieving information about the link that is connected to the devices and ports this link is connected to.
Parameters: - the device name where the link is connected to the OUT port - the port number of the device that the link is connected to on the from-device (OUT port) - the port type of the device that the link is connected to on the from-device (OUT port) - the device name where the link is connected to the IN port - the port number of the device that the link is connected to on the to-device (IN port) - the port type of the device that the link is connected to on the to-deivce (IN port)
!return - True if successful, False otherwise.
Definition at line 3034 of file objectclasses.py.
| def objectclasses::Link::Delete | ( | self | ) |
Sets the save status of this object to delete, and adds it to the dirty objects list for later update in the ConfDB.
Reimplemented from objectclasses::DBInfo.
Definition at line 3080 of file objectclasses.py.
| def objectclasses::Link::Modify | ( | self | ) |
Sets the save status of this object to modify, and adds it to the dirty objects list for later update in the ConfDB. Modify status is set in respective Set-methods.
Reimplemented from objectclasses::DBInfo.
Definition at line 3090 of file objectclasses.py.
| def objectclasses::Link::Create | ( | self | ) |
Sets the save status of this object to create, and adds it to the dirty objects list for later update in the ConfDB.
Reimplemented from objectclasses::DBInfo.
Definition at line 3098 of file objectclasses.py.
objectclasses::Link::_deviceInfo [private] |
Definition at line 2543 of file objectclasses.py.
objectclasses::Link::__reverseLink [private] |
Definition at line 2572 of file objectclasses.py.
objectclasses::Link::__cfg [private] |
Definition at line 2574 of file objectclasses.py.
objectclasses::Link::__errormessage [private] |
objectclasses::Link::__errormesage [private] |
Definition at line 2987 of file objectclasses.py.
1.5.3