objectclasses::LinkType Class Reference

Inheritance diagram for objectclasses::LinkType:

objectclasses::DBInfo cdbVisCore::dbUpdate

List of all members.


Detailed Description

Create a link type, which is an abstract object. Common properties for physical links of a given type; f.ex. HV, gas, data etc.

Definition at line 3107 of file objectclasses.py.


Public Member Functions

def __init__
def GetOldName
def GetSaveStatus
def GetName
def GetSystem
def GetID
def GetCompositeLinks
def GetErrorMessage
def SetErrorMessage
def SetOldName
def SetSaveStatus
def SetName
def SetSystem
def SetID
def SetCompositeLinks
def SetDict
def GetObjectInfo
def Update
def PrintSaveFunction
def Save
def Delete
def Modify
def Create

Private Attributes

 _deviceInfo
 __cfg
 __errormessage

Member Function Documentation

def objectclasses::LinkType::__init__ (   self,
  systemName,
  linkTypeName = "",
  new = True 
)

Constructor.

Parameters: - name of the subsystem this linktype is created in (Obsolete). Now all link types are available in all subsystems, because there are not that many of them. - the unique link type name set by the user - whether the link type is being created (True) or that it has already been created (False)

Definition at line 3118 of file objectclasses.py.

def objectclasses::LinkType::GetOldName (   self  ) 

Definition at line 3141 of file objectclasses.py.

def objectclasses::LinkType::GetSaveStatus (   self  ) 

Definition at line 3143 of file objectclasses.py.

def objectclasses::LinkType::GetName (   self  ) 

Definition at line 3145 of file objectclasses.py.

def objectclasses::LinkType::GetSystem (   self  ) 

Definition at line 3147 of file objectclasses.py.

def objectclasses::LinkType::GetID (   self  ) 

Definition at line 3149 of file objectclasses.py.

def objectclasses::LinkType::GetCompositeLinks (   self  ) 

Definition at line 3151 of file objectclasses.py.

def objectclasses::LinkType::GetErrorMessage (   self  ) 

Get the error message that was set most recently.

!return - the error message string

Reimplemented from objectclasses::DBInfo.

Definition at line 3153 of file objectclasses.py.

def objectclasses::LinkType::SetErrorMessage (   self,
  msg 
)

Set the error message so that it can be looked up. - the message string

Reimplemented from objectclasses::DBInfo.

Definition at line 3155 of file objectclasses.py.

def objectclasses::LinkType::SetOldName (   self,
  oldname 
)

Definition at line 3157 of file objectclasses.py.

def objectclasses::LinkType::SetSaveStatus (   self,
  status 
)

Definition at line 3159 of file objectclasses.py.

def objectclasses::LinkType::SetName (   self,
  name 
)

Definition at line 3161 of file objectclasses.py.

def objectclasses::LinkType::SetSystem (   self,
  name 
)

Definition at line 3164 of file objectclasses.py.

def objectclasses::LinkType::SetID (   self,
  id 
)

Definition at line 3166 of file objectclasses.py.

def objectclasses::LinkType::SetCompositeLinks (   self,
  concanlist 
)

Definition at line 3169 of file objectclasses.py.

def objectclasses::LinkType::SetDict (   self,
  newdict 
)

Definition at line 3172 of file objectclasses.py.

def objectclasses::LinkType::GetObjectInfo (   self,
  doNotLookUp = True 
)

Get all info about a link type.

TODO: Here we can have checks whether we need to look for link type information in dirty objects list or ConfDB if this is the most recent version of the link type object.

- whether we should look for information about this object in dirty objects list and ConfDB (False) or not(True).

Definition at line 3187 of file objectclasses.py.

def objectclasses::LinkType::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 type

Definition at line 3203 of file objectclasses.py.

def objectclasses::LinkType::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 3264 of file objectclasses.py.

def objectclasses::LinkType::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 3313 of file objectclasses.py.

def objectclasses::LinkType::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 3371 of file objectclasses.py.

def objectclasses::LinkType::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 3381 of file objectclasses.py.

def objectclasses::LinkType::Create (   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 3389 of file objectclasses.py.


Member Data Documentation

objectclasses::LinkType::_deviceInfo [private]

Definition at line 3120 of file objectclasses.py.

objectclasses::LinkType::__cfg [private]

Definition at line 3133 of file objectclasses.py.

objectclasses::LinkType::__errormessage [private]

Reimplemented from objectclasses::DBInfo.

Definition at line 3138 of file objectclasses.py.


The documentation for this class was generated from the following file:
Generated on Fri Aug 31 11:11:20 2007 for CDBVis by  doxygen 1.5.3