AddInfo Class Reference

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

Inheritance diagram for AddInfo:

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

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

clone()

def clone

(

self

)

returns a full copy of the current object

cloneFullLayout()

def cloneFullLayout

(

self

)

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

cloneView()

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]	layout	view layout that should be used
[in]	readOnly	flag 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

columns()

def columns

(

self

)

Parameters

self	(type: AddInfo) self pointer

Returns

(type: int)

eraseLayout()

def eraseLayout	(		self,
			layout
	)

removes the specified attributes from current object

Parameters

[in]

layout

contains all attributes that should be erased from storage (and storage layout)

get()

def get	(		self,
			arg1
	)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: object) mandatory parameter

Returns

(type: object)

index()

def index	(		self,
			arg1
	)

possible calls:

• index(self, arg1: str)
• index(self, arg1: ColumnSemantic)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: ColumnSemantic | str) mandatory parameter

Returns

(type: int)

isNull()

def isNull	(		self,
			arg1
	)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: object) mandatory parameter

Returns

(type: bool)

isView()

def isView

(

self

)

Parameters

self	(type: AddInfo) self pointer

Returns

(type: bool)

layout()

def layout

(

self

)

Parameters

self	(type: AddInfo) self pointer

Returns

(type: AddInfoLayout)

name()

def name	(		self,
			arg1
	)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: object) mandatory parameter

Returns

(type: str)

restoreFullLayout()

def restoreFullLayout

(

self

)

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

semantic()

def semantic	(		self,
			arg1
	)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: object) mandatory parameter

Returns

(type: ColumnSemantic)

set()

def set	(		self,
			arg1,
			arg2
	)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: object) mandatory parameter
arg2	(type: object) mandatory parameter

setNull()

def setNull	(		self,
			arg1,
			arg2
	)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: object) mandatory parameter
arg2	(type: object) mandatory parameter

setView()

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]	layout	view layout that should be set
[in]	readOnly	flag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout

size()

def size	(		self,
			arg1
	)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: object) mandatory parameter

Returns

(type: int)

type()

def type	(		self,
			arg1
	)

Parameters

self	(type: AddInfo) self pointer
arg1	(type: object) mandatory parameter

Returns

(type: ColumnType)