Public Member Functions | List of all members
AddInfo Class Reference

AddInfo objects store a set of attributes. More...

Public Member Functions

def clone
 returns a full copy of the current object
def cloneFullLayout
 creates a new addinfo object using the true storage layout that referring to the same storage object
def cloneView
 creates a new addinfo object with the provide view layout that refers to the same storage object
def columns
def eraseLayout
 removes the specified attributes from current object
def get
def index
def index
def isNull
def isView
def layout
def name
def restoreFullLayout
 removes any view layout and sets the true storage layout as (internal) layout
def semantic
def set
def setNull
def setView
 applies a certain layout view onto the current object
def size
def type

Detailed Description

AddInfo objects store a set of attributes.

Managing attributes, layout and views is a core feature of the DM library. Please refer to the Managing Attributes section for implementation concepts and to the examples section (attribute handling) for further details.

Member Function Documentation

def clone (   self)

returns a full copy of the current object

def cloneFullLayout (   self)

creates a new addinfo object using the true storage layout that referring to the same storage object

def cloneView (   self,
  layout,
  readOnly 
)

creates a new addinfo object with the provide view layout that refers to the same storage object

Whereas setView changes the current addinfo object, cloneView leafs the current object unchanged and creates an new addinfo object using the provide view layout that internal refers to the same storage object. See the attribute handling example in the examples section.

Parameters
[in]layoutview layout that should be used
[in]readOnlyflag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout
Returns
new addinfo object

def columns (   self)
Parameters
self(type: AddInfo) self pointer
Returns
(type: int)
def eraseLayout (   self,
  layout 
)

removes the specified attributes from current object

Parameters
[in]layoutcontains all attributes that should be erased from storage (and storage layout)

def get (   self,
  arg1 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: int) mandatory parameter
Returns
(type: object)
def index (   self,
  arg1 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: str) mandatory parameter
Returns
(type: int)

Referenced by AddInfo.index().

def index (   self,
  arg1 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: ColumnSemantic) mandatory parameter
Returns
(type: int)

References AddInfo.index().

def isNull (   self,
  arg1 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: int) mandatory parameter
Returns
(type: bool)
def isView (   self)
Parameters
self(type: AddInfo) self pointer
Returns
(type: bool)
def layout (   self)
Parameters
self(type: AddInfo) self pointer
Returns
(type: AddInfoLayout)
def name (   self,
  arg1 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: int) mandatory parameter
Returns
(type: str)
def restoreFullLayout (   self)

removes any view layout and sets the true storage layout as (internal) layout

def semantic (   self,
  arg1 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: int) mandatory parameter
Returns
(type: ColumnSemantic)
def set (   self,
  arg1,
  arg2 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: int) mandatory parameter
arg2(type: object) mandatory parameter
def setNull (   self,
  arg1,
  arg2 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: int) mandatory parameter
arg2(type: bool) mandatory parameter
def setView (   self,
  layout,
  readOnly 
)

applies a certain layout view onto the current object

In contrast to cloneView the function changes the visible layout of the current object. Since geometry object uses smart pointers to addinfo object this may affect other code parts. The read only parameter does not protect for writing attributes to the addinfo object. The parameter refers to the layout of storage object. The view layout is not necessarily a subset of the storage layout. In such a configuration the disjunct attributes can be added (readOnly = false) to the attribute storage (and storage layout) or not (readOnly = true). In the later case the disjunct attributes still exists in the view layout, but you will not be able to read or write them. Only the isNull check will be valid and, of course, it will always return true for disjunct attributes. In case you want to read/write all attributes of the view layout the read only parameter should be set to false

Parameters
[in]layoutview layout that should be set
[in]readOnlyflag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout

def size (   self,
  arg1 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: int) mandatory parameter
Returns
(type: int)
def type (   self,
  arg1 
)
Parameters
self(type: AddInfo) self pointer
arg1(type: int) mandatory parameter
Returns
(type: ColumnType)