Interface to a factory object for creating AddInfo layouts. More...
Public Member Functions | |
| def | __init__ |
| def | addColumn |
| def | addColumn |
| def | addColumn |
| def | addColumn |
| add pre- or user-defined attribute based on attributes stored within a datamanager In contrast to the other addColumn functions, this function supports adding user- and per-defined attributes. Whereas the type of pre-defined attributes is fixed, for user-defined attributes the type has to be specified. For accessing user-defined attributes in a datamanager, the corresponding type has to be known since it is not allow combining identical named columns with different types within one layout. Therefore the function takes a damanager reference as first parameter and checks the type all used-defined attributes within the datamanager. If there is a match of the attribute name, the type as in the datamanager is used. Otherwise the column is not or with the given default type added. | |
| def | clear |
| def | getLayout |
Detailed Description
Interface to a factory object for creating AddInfo layouts.
Constructor & Destructor Documentation
| def __init__ | ( | self | ) |
- Parameters
-
self (type: object) self pointer
- Returns
- (type: object)
Member Function Documentation
| def addColumn | ( | self, | |
| arg1 | |||
| ) |
- Parameters
-
self (type: AddInfoLayoutFactory) self pointer arg1 (type: ColumnSemantic) mandatory parameter
- Returns
- (type: AddInfoLayoutFactory)
Referenced by AddInfoLayoutFactory.addColumn().
| def addColumn | ( | self, | |
| arg1, | |||
| arg2 | |||
| ) |
- Parameters
-
self (type: AddInfoLayoutFactory) self pointer arg1 (type: ColumnType) mandatory parameter arg2 (type: str) mandatory parameter
- Returns
- (type: AddInfoLayoutFactory)
References AddInfoLayoutFactory.addColumn().
| def addColumn | ( | self, | |
| arg1, | |||
| arg2, | |||
| arg3 | |||
| ) |
- Parameters
-
self (type: AddInfoLayoutFactory) self pointer arg1 (type: ColumnType) mandatory parameter arg2 (type: str) mandatory parameter arg3 (type: int) mandatory parameter
- Returns
- (type: AddInfoLayoutFactory)
References AddInfoLayoutFactory.addColumn().
| def addColumn | ( | self, | |
| dm, | |||
| name, | |||
forceAdding = True, |
|||
defaultType = pyDM.ColumnType.float_, |
|||
caseSensitive = False |
|||
| ) |
add pre- or user-defined attribute based on attributes stored within a datamanager In contrast to the other addColumn functions, this function supports adding user- and per-defined attributes. Whereas the type of pre-defined attributes is fixed, for user-defined attributes the type has to be specified. For accessing user-defined attributes in a datamanager, the corresponding type has to be known since it is not allow combining identical named columns with different types within one layout. Therefore the function takes a damanager reference as first parameter and checks the type all used-defined attributes within the datamanager. If there is a match of the attribute name, the type as in the datamanager is used. Otherwise the column is not or with the given default type added.
- Parameters
-
[in] dm const reference to a datamanager object [in] name attribute name [in] forceAdding adds the attribute even if it's not within the datamanager [in] defaultType in case of user-defined attribute that are not in the manager the specified type will be used [in] caseSensitive check if the name should be compared case sensitive (or not) to the datamanager attributes
- Returns
- type of the attribute (or ColumnType::none if no attribute was added) and the flag if the attribute exists within the manager
References AddInfoLayoutFactory.addColumn().
| def clear | ( | self | ) |
- Parameters
-
self (type: AddInfoLayoutFactory) self pointer
| def getLayout | ( | self, | |
clear = True |
|||
| ) |
- Parameters
-
self (type: AddInfoLayoutFactory) self pointer clear (type: bool) optional parameter
- Returns
- (type: AddInfoLayout)
