Sammi Object Model

 


som

index
/builds3/sammi7/sammi_7.0.05/ub1004_7.0.05/lib/som.py

# This file was automatically generated by SWIG (http://www.swig.org).

# Version 1.3.40

#

# Do not make changes to this file unless you know what you are doing--modify

# the SWIG interface file instead.

Modules

      
_som weakref

Classes

      
__builtin__.object
CurveSetData
DataAccessType
DataColumn
DataRow
DataSet
DataTable
DisplayObj
CompositeObj
LayerObj
Ddo
AdvancedListManager
AdvancedMenu
AdvancedSelectList
Alarm
AnnotatedText
Bar
BarChart
BitmapSymbol
Button
ButtonGroup
CurveSet
Dobj
DrawPort
FslMeter
Gauge
GraphicDataField
InputDdo
CustomTime
Equation
FormattedNumeric
Integer
Real
TextBox
Menu
Meter
MslMeter
ObjIcon
OptionMenu
PanedWindow
PieChart
Plot
Region
ScrollBar
SelectList
Slider
Tabular
TextBrowser
TextField
TextSymbol
ToolBar
Trend
VectorSymbol
Shape
Arc
DisplayVectorSymbol
Ellipse
Frame
Image
PolyLine
Polygon
Rectangle
Spline
Text
VText
Format
LocalData
UniversalData
Point
SwigPyIterator

class AdvancedListManager(Ddo)

   
Method resolution order:
AdvancedListManager
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_AdvancedListManager>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class AdvancedMenu(Ddo)

   
Method resolution order:
AdvancedMenu
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_AdvancedMenu>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class AdvancedSelectList(Ddo)

   
Method resolution order:
AdvancedSelectList
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_AdvancedSelectList>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Alarm(Ddo)

   
Method resolution order:
Alarm
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Alarm>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class AnnotatedText(Ddo)

   
Method resolution order:
AnnotatedText
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_AnnotatedText>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Arc(Shape)

    Provides access to various properties to query and manipulate the arc object instance in SAMMI.
Method resolution order:
Arc
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

Center
- Point : Gets the center point.
Radii
- Point : Gets the x and y radius values.
StartAngle
- int : Gets or sets the start angle in degrees.
SweepAngle
- int : Gets or sets the sweep angle in degrees.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Arc>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Bar(Ddo)

   
Method resolution order:
Bar
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Bar>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class BarChart(Ddo)

   
Method resolution order:
BarChart
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_BarChart>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class BitmapSymbol(Ddo)

   
Method resolution order:
BitmapSymbol
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getCurrentSymbolName(self)
Returns the symbol name currently being displayed.

Return type: string


Data descriptors defined here:

TableName
- string : Gets or sets the table name.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_BitmapSymbol>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Button(Ddo)

   
Method resolution order:
Button
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

SelectedLabelName
- string : Gets the selected label name.
UnselectedLabelName
- string : Gets or sets the unselected label name.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Button>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class ButtonGroup(Ddo)

   
Method resolution order:
ButtonGroup
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_ButtonGroup>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class CompositeObj(DisplayObj)

    Provides access to various methods to query and manipulate the composite object instance in SAMMI.
Method resolution order:
CompositeObj
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getDisplayObjById(self, *args)
Returns a display object with a given object id within the composite instance.

Parameters:

name - string : the object id that needs to be searched.

Return type: DisplayObj

getDisplayObjByName(self, *args)
Returns a display object with a given object name within the composite instance.

Parameters:

name - string : the object name that needs to be searched.

Return type: DisplayObj

getDisplayObjects(self)
Returns list of display objects that are part of this composite instance.

Return type: list of DisplayObj

insertObject(self, *args)
Inserts a display object instance at specific location in the composite object list.

Parameters:

dpyObj - DisplayObj : the display object instance that needs to be inserted

prevObj - DisplayObj : the display instance after which the object should be inserted

succObj - DisplayObj : the display instance before which the object should be inserted.

insertObjectInBack(self, *args)
Inserts a display object instance at the end of the composite object list.

Parameters:

dpyObj - DisplayObj : the display object instance to be inserted

insertObjectInFront(self, *args)
Inserts a display object instance at the front of the composite object list.

Parameters:

dpyObj - DisplayObj : the display object instance to be inserted

removeObject(self, *args)
Removes a given display object instance from the composite object.

Parameters:

dpyObj - DisplayObj : the display object instance to be removed.


Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_CompositeObj>

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class CurveSet(Ddo)

   
Method resolution order:
CurveSet
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_CurveSet>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class CurveSetData(__builtin__.object)

    Methods defined here:

__del__ lambda self
__init__(self)
__repr__ = _swig_repr(self)

Data descriptors defined here:

__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_CurveSetData>

class CustomTime(InputDdo)

   
Method resolution order:
CustomTime
InputDdo
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_CustomTime>

Data descriptors inherited from InputDdo:

DisplayColumns
- int : Gets or sets the number of display columns.
DisplayRows
- int : Gets or sets the number of display rows.
MaxColumns
- int : Gets or sets the maximum number of columns.
MaxRows
- int : Gets or sets the maximum number of rows.
ResizeOnZoom
- bool : Gets or sets the value that determines whether the ddo should resize on zoom.
ShowScrollIndicator
- bool : Gets or sets the value that determines whether the input ddo should show scroll bars at runtime.
ShowThickness
- int : Gets or sets shadow thickenss value for the ddo.

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class DataAccessType(__builtin__.object)

    Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getCurveSetData(self)
Returns the curveset data configuration.

Return type : CurveSetData

getLocalData(self)
Returns the local data configuration.

Return type : LocalData

getUniversalData(self)
Returns the universal data configuration.

Return type : UniversalData


Data descriptors defined here:

DataConfigType
- DataConfigType : Gets or sets the data configuratition type. {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_DataAccessType>

class DataColumn(__builtin__.object)

    Methods defined here:

__del__ lambda self
__init__(self, *args)
Creates a data column.

Parameters:

name - string : The column name

col_type - int : The column type. {UNDEF_DATA_TYPE, SHORT_DATA_TYPE, LONG_DATA_TYPE, FLOAT_DATA_TYPE, DOUBLE_DATA_TYPE, FIXSTR_DATA_TYPE, VARSTR_DATA_TYPE, DLONG_DATA_TYPE, MISC_DATA_TYPE, TREND_DATA_TYPE, PLOT_DATA_TYPE, CURVE_SET_DATA_TYPE, LONG32_DATA_TYPE}

__repr__ = _swig_repr(self)

Data descriptors defined here:

Name
- string : Gets the name associated with column.
Type
- int : Gets the type associated with the column. {UNDEF_DATA_TYPE, SHORT_DATA_TYPE, LONG_DATA_TYPE, FLOAT_DATA_TYPE, DOUBLE_DATA_TYPE, FIXSTR_DATA_TYPE, VARSTR_DATA_TYPE, DLONG_DATA_TYPE, MISC_DATA_TYPE, TREND_DATA_TYPE, PLOT_DATA_TYPE, CURVE_SET_DATA_TYPE, LONG32_DATA_TYPE}
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_DataColumn>

class DataRow(__builtin__.object)

    Methods defined here:

__del__ lambda self
__init__(self, *args)
Creates a new data row element.

Parameters:

cols - list of DataColumn : the list of data columns to associate with data row.

__repr__ = _swig_repr(self)

Data descriptors defined here:

Columns
- list of DataColumn : Gets the columns associated with the data row.
Values
- list of string : Gets the values associated with the data row.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_DataRow>

class DataSet(__builtin__.object)

    Methods defined here:

__del__ lambda self
__init__(self)
Creates a new dataset.
__repr__ = _swig_repr(self)
addTable(self, *args)
Adds a data table to the dataset.

Parameters:

dt - DataTable : data table instance to be added to the dataset


Data descriptors defined here:

Tables
- list of DataTable : Gets the table collection associated with the dataset.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_DataSet>

class DataTable(__builtin__.object)

    Methods defined here:

__del__ lambda self
__init__(self, *args)
Creates a new data table.

Parameters:

cols - list of DataColumn : the list of columns to associate with the data table.

__repr__ = _swig_repr(self)
newRow(self)
Creates a new data row based on the column schema associated with the data table.

Return type: DataRow


Data descriptors defined here:

Columns
- list of DataColumn : Gets the columns associated with the table.
QualityValues
- list of int : Gets the list of quality values with each data row in the table.
Rows
- list of DataRow : Gets or sets the data rows.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_DataTable>

class Ddo(DisplayObj)

    This base class provides access to various methods and properties to query and manipulate the ddo instance in SAMMI.
Method resolution order:
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors defined here:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Ddo>

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class DisplayObj(__builtin__.object)

    This base class provides access to query and manipulate all object instances in SAMMI.
Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors defined here:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_DisplayObj>

class DisplayVectorSymbol(Shape)

   
Method resolution order:
DisplayVectorSymbol
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_DisplayVectorSymbol>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Dobj(Ddo)

   
Method resolution order:
Dobj
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getObjects(self)
Returns the list of objects being controlled by this Dobj object.

Return type: list of DisplayObj


Data descriptors defined here:

TableName
- string : Gets or sets the table name.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Dobj>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class DrawPort(Ddo)

   
Method resolution order:
DrawPort
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_DrawPort>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Ellipse(Shape)

    Provides access to various properties to query and manipulate the ellipse object instance in SAMMI.
Method resolution order:
Ellipse
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

Center
- Point : Gets the center point.
Radii
- Point : Gets the x and y radius values.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Ellipse>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Equation(InputDdo)

   
Method resolution order:
Equation
InputDdo
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Equation>

Data descriptors inherited from InputDdo:

DisplayColumns
- int : Gets or sets the number of display columns.
DisplayRows
- int : Gets or sets the number of display rows.
MaxColumns
- int : Gets or sets the maximum number of columns.
MaxRows
- int : Gets or sets the maximum number of rows.
ResizeOnZoom
- bool : Gets or sets the value that determines whether the ddo should resize on zoom.
ShowScrollIndicator
- bool : Gets or sets the value that determines whether the input ddo should show scroll bars at runtime.
ShowThickness
- int : Gets or sets shadow thickenss value for the ddo.

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Format(__builtin__.object)

    Provides access to various properties and methods associated with SAMMI format instance.
Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
addDataUpdateCallback(self, *args)
Allows a callback to be setup which will be called when DDO data update occurs within the format.

Parameters:

callback - method reference: A method instance with ddo as its parameter ie. format_data_update(ddo).

getDisplayObjById(self, *args)
Returns object instance within the format based on given display object id.

Parameters:

id - integer : the target display object id.

Return type: DisplayObj instance.

getDisplayObjByName(self, *args)
Returns object instance within the format based on given display object name.

Parameters:

name - string : the target display object name.

Return type: DisplayObj instance.

getLayers(self)
Returns list of layers within the format.

Return type: list of LayerObj instances.

popup(self)
Pops up the format window.
removeDataUpdateCallback(self, *args)
Removes registered data update callback from the format.

Parameters:

callback - method reference: A method instance that was registered with addDataUpdateCallback.

repaint(self)
Forces the whole format to redraw itself.
resetModified(self)
Resets the isModified flag to be false.
setObjectAddedCallback(self, *args)
Allows a callback to be setup for object added event in the format.

Parameters:

callback - method reference: A method instance with format and newly added object instance as parameters.

setObjectChangedCallback(self, *args)
Allows a callback to be setup for object changed event in the format.

Parameters:

callback - method reference: A method instance with format and changed objects as parameters ie. obj_changed_cb(format,oldObj,newObj).

setObjectRemovedCallback(self, *args)
Allows a callback to be setup for object removed event in the format.

Parameters:

callback - method reference: A method instance with format and removed object as parameter ie. obj_removed_cb(format,obj).

setTimerCallback(self, *args)
Allows callback to be associated with the format which will be called after the specified time value has elapsed.

Parameters:

timer_val - integer: A time value in miliseconds after which the callback will be triggered.

callback - method reference: A method instance reference with data as parameter ie. timer_cb(data).

data - any object: The data object that should be passed as argument to callback method.

setZoomChangedCallback(self, *args)
Allows a callback to be setup for format zoom event.

Parameters:

callback - method reference: A method instance with format as its parameter ie. zoom_change_cb(format)


Data descriptors defined here:

BackColor
- int : Gets or sets format background color.
DirPath
- string : Gets directory path in which the format is located.
Extension
- string : Gets file extension associated with the format instance.
InEdit
- bool : Determines whether the format is currently being edited.
IsModified
- bool : Determines whether the format has been modified.
Name
- string : Gets format name.
Title
- string : Gets the title associated with the format.
WindowId
- int : Gets the format's X Window id.
ZoomFactor
- float : Returns format's current zoom factor.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Format>

class FormattedNumeric(InputDdo)

   
Method resolution order:
FormattedNumeric
InputDdo
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_FormattedNumeric>

Data descriptors inherited from InputDdo:

DisplayColumns
- int : Gets or sets the number of display columns.
DisplayRows
- int : Gets or sets the number of display rows.
MaxColumns
- int : Gets or sets the maximum number of columns.
MaxRows
- int : Gets or sets the maximum number of rows.
ResizeOnZoom
- bool : Gets or sets the value that determines whether the ddo should resize on zoom.
ShowScrollIndicator
- bool : Gets or sets the value that determines whether the input ddo should show scroll bars at runtime.
ShowThickness
- int : Gets or sets shadow thickenss value for the ddo.

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Frame(Shape)

    Provides access to various properties to query and manipulate the frame object instance in SAMMI.
Method resolution order:
Frame
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

BorderType
- int : Gets or sets the frame border type. {BORDER_ETCHED_IN=5, BORDER_ETCHED_OUT=6, BORDER_IN=7, BORDER_OUT=8}
BorderWidth
- int : Gets or sets the border width.
Fill
- bool : Determines whether the frame should be filled.
FrameColor
- int : Gets or sets the frame color.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Frame>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class FslMeter(Ddo)

   
Method resolution order:
FslMeter
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_FslMeter>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Gauge(Ddo)

   
Method resolution order:
Gauge
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Gauge>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class GraphicDataField(Ddo)

   
Method resolution order:
GraphicDataField
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_GraphicDataField>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Image(Shape)

    Provides access to various properties to query and manipulate the image object instances in SAMMI.
Method resolution order:
Image
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

FileName
- string : Gets the image file name.
ImageType
- int : Gets the image type. {IMAGE_TYPE_XBM=1, IMAGE_TYPE_GIF=2, IMAGE_TYPE_XWD=3, IMAGE_TYPE_XPM=4, IMAGE_TYPE_SYM=5}
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Image>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class InputDdo(Ddo)

    Provides access common properties and methods to query and manipulate the input based ddo object instances in SAMMI.
Method resolution order:
InputDdo
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

DisplayColumns
- int : Gets or sets the number of display columns.
DisplayRows
- int : Gets or sets the number of display rows.
MaxColumns
- int : Gets or sets the maximum number of columns.
MaxRows
- int : Gets or sets the maximum number of rows.
ResizeOnZoom
- bool : Gets or sets the value that determines whether the ddo should resize on zoom.
ShowScrollIndicator
- bool : Gets or sets the value that determines whether the input ddo should show scroll bars at runtime.
ShowThickness
- int : Gets or sets shadow thickenss value for the ddo.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_InputDdo>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Integer(InputDdo)

   
Method resolution order:
Integer
InputDdo
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Integer>

Data descriptors inherited from InputDdo:

DisplayColumns
- int : Gets or sets the number of display columns.
DisplayRows
- int : Gets or sets the number of display rows.
MaxColumns
- int : Gets or sets the maximum number of columns.
MaxRows
- int : Gets or sets the maximum number of rows.
ResizeOnZoom
- bool : Gets or sets the value that determines whether the ddo should resize on zoom.
ShowScrollIndicator
- bool : Gets or sets the value that determines whether the input ddo should show scroll bars at runtime.
ShowThickness
- int : Gets or sets shadow thickenss value for the ddo.

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class LayerObj(CompositeObj)

    Provides access to various properties and methods to query and manipulate the layer object instance in SAMMI.
Method resolution order:
LayerObj
CompositeObj
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

Declutter
- bool : Gets or sets value that determines whether the declutter should be enabled for the layer.
MaxDeclutter
- int : Gets or sets the maximum declutter value associated with the layer.
MinDeclutter
- int : Gets or sets the minimum declutter value associated with the layer.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_LayerObj>

Methods inherited from CompositeObj:

getDisplayObjById(self, *args)
Returns a display object with a given object id within the composite instance.

Parameters:

name - string : the object id that needs to be searched.

Return type: DisplayObj

getDisplayObjByName(self, *args)
Returns a display object with a given object name within the composite instance.

Parameters:

name - string : the object name that needs to be searched.

Return type: DisplayObj

getDisplayObjects(self)
Returns list of display objects that are part of this composite instance.

Return type: list of DisplayObj

insertObject(self, *args)
Inserts a display object instance at specific location in the composite object list.

Parameters:

dpyObj - DisplayObj : the display object instance that needs to be inserted

prevObj - DisplayObj : the display instance after which the object should be inserted

succObj - DisplayObj : the display instance before which the object should be inserted.

insertObjectInBack(self, *args)
Inserts a display object instance at the end of the composite object list.

Parameters:

dpyObj - DisplayObj : the display object instance to be inserted

insertObjectInFront(self, *args)
Inserts a display object instance at the front of the composite object list.

Parameters:

dpyObj - DisplayObj : the display object instance to be inserted

removeObject(self, *args)
Removes a given display object instance from the composite object.

Parameters:

dpyObj - DisplayObj : the display object instance to be removed.


Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class LocalData(__builtin__.object)

    Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
setDefaultDataType(self, *args)
Sets the default data type for the local data.

Parameters:

data_type - int : The data type to associated with local data.


Data descriptors defined here:

NumPoints
- int : Gets or sets number of points.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_LocalData>

class Menu(Ddo)

   
Method resolution order:
Menu
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Menu>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Meter(Ddo)

   
Method resolution order:
Meter
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Meter>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class MslMeter(Ddo)

   
Method resolution order:
MslMeter
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_MslMeter>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class ObjIcon(Ddo)

   
Method resolution order:
ObjIcon
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getCurrentSymbolName(self)
Returns the symbol name currently being displayed.

Return type: string


Data descriptors defined here:

TableName
- string : Gets or sets the table name.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_ObjIcon>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class OptionMenu(Ddo)

   
Method resolution order:
OptionMenu
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_OptionMenu>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class PanedWindow(Ddo)

   
Method resolution order:
PanedWindow
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_PanedWindow>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class PieChart(Ddo)

   
Method resolution order:
PieChart
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_PieChart>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Plot(Ddo)

   
Method resolution order:
Plot
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet


Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Plot>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Point(__builtin__.object)

    Methods defined here:

__del__ lambda self
__init__(self, *args)
__repr__ = _swig_repr(self)

Data descriptors defined here:

X
- int : Gets or sets the x value.
Y
- int : Gets or sets the y value.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Point>

class PolyLine(Shape)

    Provides access to various properties to query and manipulate the polyline object instance in SAMMI.
Method resolution order:
PolyLine
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

BackwardArrow
- bool : Determines whether to show backward arrow.
ForwardArrow
- bool : Determines whether to show forward arrow.
Points
- list of Point : Returns list of points that make up the polyline.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_PolyLine>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Polygon(Shape)

    Provides access to various properties to query and manipulate the polygon object instance in SAMMI.
Method resolution order:
Polygon
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

Points
- list of Point : Returns list of points that make up the polygon.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Polygon>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Real(InputDdo)

   
Method resolution order:
Real
InputDdo
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Real>

Data descriptors inherited from InputDdo:

DisplayColumns
- int : Gets or sets the number of display columns.
DisplayRows
- int : Gets or sets the number of display rows.
MaxColumns
- int : Gets or sets the maximum number of columns.
MaxRows
- int : Gets or sets the maximum number of rows.
ResizeOnZoom
- bool : Gets or sets the value that determines whether the ddo should resize on zoom.
ShowScrollIndicator
- bool : Gets or sets the value that determines whether the input ddo should show scroll bars at runtime.
ShowThickness
- int : Gets or sets shadow thickenss value for the ddo.

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Rectangle(Shape)

   
Method resolution order:
Rectangle
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Rectangle>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Region(Ddo)

   
Method resolution order:
Region
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Region>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class ScrollBar(Ddo)

   
Method resolution order:
ScrollBar
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_ScrollBar>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class SelectList(Ddo)

   
Method resolution order:
SelectList
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_SelectList>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Shape(DisplayObj)

    This base class provides access to various properties to query and manipulate the various shape instances in SAMMI.
Method resolution order:
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Shape>

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Slider(Ddo)

   
Method resolution order:
Slider
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Slider>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Spline(Shape)

    Provides access to various properties to query and manipulate the spline object instance in SAMMI.
Method resolution order:
Spline
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

BackwardArrow
- bool : Determines whether to show backward arrow.
ForwardArrow
- bool : Determines whether to show forward arrow.
Points
- list of Point : Returns list of points that make up the spline.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Spline>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class SwigPyIterator(__builtin__.object)

    Methods defined here:

__add__(self, *args)
__del__ lambda self
__eq__(self, *args)
__iadd__(self, *args)
__init__(self, *args, **kwargs)
__isub__(self, *args)
__iter__(self)
__ne__(self, *args)
__next__(self)
__repr__ = _swig_repr(self)
__sub__(self, *args)
advance(self, *args)
copy(self)
decr(self, n=1)
distance(self, *args)
equal(self, *args)
incr(self, n=1)
next(self)
previous(self)
value(self)

Data descriptors defined here:

__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_SwigPyIterator>

class Tabular(Ddo)

   
Method resolution order:
Tabular
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Tabular>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Text(Shape)

    Provides access to various properties to query and manipulate the text object instance in SAMMI.
Method resolution order:
Text
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

FontIndex
- int : Gets or sets the font index.
Text
- string : Gets or sets the text string.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Text>

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class TextBox(InputDdo)

    Provides access to various properties and methods to query and manipulate the txt ddo instance in SAMMI.
Method resolution order:
TextBox
InputDdo
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getValues(self)
Gets text values from the display buffer.

Return type: list of strings


Data descriptors defined here:

InputMask
- string : Gets or sets the input mask string.
PasswordStyle
- bool : Gets or sets the the value to determine whether the ddo will support password style input.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_TextBox>

Data descriptors inherited from InputDdo:

DisplayColumns
- int : Gets or sets the number of display columns.
DisplayRows
- int : Gets or sets the number of display rows.
MaxColumns
- int : Gets or sets the maximum number of columns.
MaxRows
- int : Gets or sets the maximum number of rows.
ResizeOnZoom
- bool : Gets or sets the value that determines whether the ddo should resize on zoom.
ShowScrollIndicator
- bool : Gets or sets the value that determines whether the input ddo should show scroll bars at runtime.
ShowThickness
- int : Gets or sets shadow thickenss value for the ddo.

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class TextBrowser(Ddo)

   
Method resolution order:
TextBrowser
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_TextBrowser>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class TextField(Ddo)

   
Method resolution order:
TextField
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_TextField>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class TextSymbol(Ddo)

   
Method resolution order:
TextSymbol
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getCurrentSymbolName(self)
Returns the symbol name currently being displayed.

Return type: string


Data descriptors defined here:

TableName
- string : Gets or sets the table name.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_TextSymbol>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class ToolBar(Ddo)

   
Method resolution order:
ToolBar
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_ToolBar>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class Trend(Ddo)

   
Method resolution order:
Trend
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet


Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_Trend>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class UniversalData(LocalData)

   
Method resolution order:
UniversalData
LocalData
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

KeyType
- int : Gets or sets the key value for universal data.
LogicalServer
- string : Gets or sets the logical server value.
ReadKey
- string : Gets or sets the read key string.
WriteKey
- string : Gets or sets the write key string.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_UniversalData>

Methods inherited from LocalData:

setDefaultDataType(self, *args)
Sets the default data type for the local data.

Parameters:

data_type - int : The data type to associated with local data.


Data descriptors inherited from LocalData:

NumPoints
- int : Gets or sets number of points.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class VText(Text)

   
Method resolution order:
VText
Text
Shape
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)

Data descriptors defined here:

thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_VText>

Data descriptors inherited from Text:

FontIndex
- int : Gets or sets the font index.
Text
- string : Gets or sets the text string.

Data descriptors inherited from Shape:

BackColor
- int : Gets or sets the background color.
FillRule
- int : Gets or sets the shape fill rule. {EVEN_ODD_FILL=0,WINDING_FILL=1}
FillStyle
- int : Gets or sets the shape fill style. {FS_SOLID=0,FS_NO_FILL=1,FS_STIPPLED=2,FS_OPAQUE_STIPPLED=3}
ForeColor
- int : Gets or sets the foreground color.
LineCap
- int : Gets or sets the line cap type. {LC_NONE = 0,LC_BUTT = 1,LC_ROUND = 2,LC_PROJECT=3}
LineDash
- int : Gets or sets line dash type.
LineJoint
- int : Gets or sets line joint type. {LJ_MITER=0, LJ_ROUND=1, LJ_BEVEL=2}
LineStyle
- int : Gets or sets shape's line style. {LS_SOLID=0,LS_DASH=1,LS_DOUBLEDASH=2}
LineThickness
- int : Gets or sets the line thickness.
Outline
- bool : Gets or sets a value that determines whether to show shape outline.
OutlineBackColor
- int : Gets or sets the outline's background color.
OutlineColor
- int : Gets or sets the outline color.
StipplePattern
- int : Gets or sets the shape fill pattern.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Name
- string : Gets or sets object name.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

class VectorSymbol(Ddo)

   
Method resolution order:
VectorSymbol
Ddo
DisplayObj
__builtin__.object

Methods defined here:

__del__ lambda self
__init__(self, *args, **kwargs)
__repr__ = _swig_repr(self)
getCurrentSymbolName(self)
Returns the symbol name currently being displayed.

Return type: string


Data descriptors defined here:

TableName
- string : Gets or sets the table name.
thisown
The membership flag

Data and other attributes defined here:

__swig_destroy__ = <built-in function delete_VectorSymbol>

Methods inherited from Ddo:

addDataUpdateCallback(self, *args)
Allows ddo data update event callback to be setup. The callback will be called after the data is placed in ddo's runtime data buffer.

Parameters:

callback: A method instance reference with ddo as a parameter ie. ddo_data_update(ddo)

adjust(self)
Checks and adjusts the ddo properties to ensure that they are consistent.

Return type: bool

getData(self)
Gets the data stored in ddo's runtime data buffer.

Return type: DataSet

getDataConfig(self)
Gets or sets data access type for the ddo. (i.e. none, local, universal etc.)

Return type: DataAccessType

getDefaultDataType(self)
Gets the default data type associated with the ddo.

Return type: int

getSupportedDataTypes(self)
Gets the list of supported data types with the ddo.

Return type: list of int

isValidDataConfigType(self, *args)
Determines whether a partcular data configuration type is valid for the ddo.

Parameters:

dct - DataConfigType : {DA_NONE,DA_TIME,DA_LOCAL,DA_UNIVERSAL,DA_CURVE_SET}

Return type: bool

removeDataUpdateCallback(self, *args)
Allows the data update event callback registered via addDataUpdateCallback to be removed.

Parameters:

callback: A method instance reference registred via addDataUpdateCallback


Data descriptors inherited from Ddo:

BackColor
- int : Gets or sets the background color.
CommandDestination
- int : Gets or sets command destination type. {CMD_DST_FIELD=0,CMD_DST_SERVER=1}
ConfirmEntry
- bool : Gets or sets value that determines whether the ddo should generate confirmation on input.
DataRefreshType
- int : Gets or sets the data refresh type. {DA_POLL=0, DA_PEER=1}
Enterable
- bool : Gets or sets value that determines whether the ddo is enterable at runtime.
Equation
- string : Gets or sets the equation string associated with the ddo.
FontIndex
- int : Gets or sets the font index.
ForeColor
- int : Gets or sets the foreground color.
HelpFileName
- string : Gets or sets a help file with the ddo.
LogEntries
- bool : Gets or sets value that determines whether the ddo will log entries at runtime.
Name
- string : Gets or sets name.
NotifyOnSelect
- bool : Gets or sets value that determines whether the ddo should generate a SELECT event at runtime upon user selection.
PopupDdoName
- string : Gets or sets a popup ddo.
RefreshRate
- int : Gets or sets refresh rate for poll based ddo.
RtdaEnabled
- bool : Gets or sets value that determines whether Runtime Data Annotations are available for the ddo.
RtdaFileName
- string : Gets or sets Runtime Data Annotations file name.
SecurityLevel
- int : Gets or sets a security level to the ddo.

Methods inherited from DisplayObj:

clone(self)
Returns a clone/copy of the current object.

Return type - DisplayObj : Returns display object instance.

connect(self, *args)
Allows a callback to be registered for the object specific event type.

Parameters:

evt_type - string: the object specific event type

callback - method instance: A method instance reference with event data as a parameter ie. obj_evt_callback(data).

erase(self)
Erases the object drawings on the format.
repaint(self)
Repaints the object drawings on the format.

Data descriptors inherited from DisplayObj:

DisplayObjType
- DisplayObjType : Gets a value that helps identify the specific object type.
DisplayObjTypeName
- string : Gets object type name.
Format
- Format : Gets the format instance in which the object belongs to.
Height
- int : Gets or sets object's height in terms of pixel values.
Id
- int : Gets object id.
IsDdo
- bool : Determines whether the object is a ddo.
Layer
- LayerObj : Gets the layer instance in which the object belongs to.
LayerNumber
- int : Gets the layer number at which the object belongs.
Parent
- DisplayObj : Gets the parent object (i.e. LayerObj or CompositeObj instance) that the object belongs to.
RuntimeVisibility
- bool : Gets or sets object's visibility value for runtime.
Visibility
- bool : Gets or sets the object visibility.
Width
- int : Gets or sets object's width in terms of pixel values.
X
- int : Gets or sets object's X location value relative to the format in terms of pixels.
Y
- int : Gets or sets object's Y location value relative to the format in terms of pixels.
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Functions

      
AdvancedListManager_swigregister(…)
AdvancedMenu_swigregister(…)
AdvancedSelectList_swigregister(…)
Alarm_swigregister(…)
AnnotatedText_swigregister(…)
Arc_swigregister(…)
BarChart_swigregister(…)
Bar_swigregister(…)
BitmapSymbol_swigregister(…)
ButtonGroup_swigregister(…)
Button_swigregister(…)
CompositeObj_swigregister(…)
CurveSetData_swigregister(…)
CurveSet_swigregister(…)
CustomTime_swigregister(…)
DataAccessType_swigregister(…)
DataColumn_swigregister(…)
DataRow_swigregister(…)
DataSet_swigregister(…)
DataTable_swigregister(…)
Ddo_swigregister(…)
DisplayObj_swigregister(…)
DisplayVectorSymbol_swigregister(…)
Dobj_swigregister(…)
DrawPort_swigregister(…)
Ellipse_swigregister(…)
Equation_swigregister(…)
Format_swigregister(…)
FormattedNumeric_swigregister(…)
Frame_swigregister(…)
FslMeter_swigregister(…)
Gauge_swigregister(…)
GraphicDataField_swigregister(…)
Image_swigregister(…)
InputDdo_swigregister(…)
Integer_swigregister(…)
LayerObj_swigregister(…)
LocalData_swigregister(…)
Menu_swigregister(…)
Meter_swigregister(…)
MslMeter_swigregister(…)
ObjIcon_swigregister(…)
OptionMenu_swigregister(…)
PanedWindow_swigregister(…)
PieChart_swigregister(…)
Plot_swigregister(…)
Point_swigregister(…)
PolyLine_swigregister(…)
Polygon_swigregister(…)
Real_swigregister(…)
Rectangle_swigregister(…)
Region_swigregister(…)
ScrollBar_swigregister(…)
SelectList_swigregister(…)
Shape_swigregister(…)
Slider_swigregister(…)
Spline_swigregister(…)
SwigPyIterator_swigregister(…)
Tabular_swigregister(…)
TextBox_swigregister(…)
TextBrowser_swigregister(…)
TextField_swigregister(…)
TextSymbol_swigregister(…)
Text_swigregister(…)
ToolBar_swigregister(…)
Trend_swigregister(…)
UniversalData_swigregister(…)
VText_swigregister(…)
VectorSymbol_swigregister(…)
createArc(*args)
Create an arc instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

cx - int : the center x location for arc.

cy - int : the center y location for the arc

xrad - int : the x-axis radius for arc.

yrad - int : the y-axis radius for arc.

start_angle - int : the start angle in degrees.

sweep_angle - int : the sweep angle in degrees.

Return type: Arc

createClosedSpline(*args)
Create a closed spline instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

pts - list of Point : the list of points with which to create polygon instance. At least 3 points must be provided.

Return type: Spline

createEllipse(*args)
Create an ellipse instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

cx - int : the center x location for ellipse.

cy - int : the center y location for the ellipse.

xrad - int : the x-axis radius for ellipse.

yrad - int : the y-axis radius for ellipse.

Return type : Ellipse

createFrame(*args)
Create a new frame instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

x - int : the x location at which the image will be placed in the format.

y - int : the y location in which the image will be placed in the format.

width - int : the width of the frame.

height - int : the height of the frame.

Return type : Frame

createImage(*args)
Creates a new image instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

file_name - string : the image file name.

file_type - int : the image file type. {IMAGE_TYPE_XBM=1, IMAGE_TYPE_GIF=2, IMAGE_TYPE_XWD=3, IMAGE_TYPE_XPM=4, IMAGE_TYPE_SYM=5}

x - int : the x location at which the image will be placed int the format.

y - int : the y location at which the image will be placed in the format.

width - int : the width of the image.

height - int : the height of the image.

Return type : Image

createLine(*args)
Create a line instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

x1 - int : the x location for the first point.

y1 - int : the y location for the first point.

x2 - int : the x location of the second point

y2 - int : the y location for the second point.

Return type: PolyLine

createOpenSpline(*args)
Create an open spline instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

pts - list of Point : the list of points with which to create polygon instance. At least 3 points must be provided.

Return type: Spline

createPolyLine(*args)
Create a polyline instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

pts - list of Point : the list of points with which to create polygon instance. At least 3 points must be provided.

Return type: PolyLine

createPolygon(*args)
Create a polygon instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

pts - list of Point : the list of points with which to create polygon instance. At least 3 points must be provided.

Return type: Polygon

createRectangle(*args)
Parameters:

fmt - Format : the format instance in which the object will be created.

x - int : the x location for the object.

y - int : the y location for the object.

w - int : the width of the rectangle.

h - int : the height of the rectangle.

Return type : Rectangle

createVectorText(*args)
Create a vector text instance in the given sammi format.

Parameters:

fmt - Format : the format instance in which the object will be created.

str - string : the text string to be displayed.

x - int : the x location at which the text to be displayed in the format.

y - int : the y location at which the text to be displayed in the format.

Return type: VText

get_color_index_from_name(*args)
Converts the color name/hex value to proper sammi color index.

Parameters:

color_name - string : the color name/hex value.

Return type: int

get_color_index_from_rgb(*args)
Converts the given RGB values into proper sammi color index.

Parameters:

r - int : the red color value between 0 - 255.

g - int : the green color value between 0 - 255.

b - int : the blue color value between 0 - 255.

Return type : int

get_color_name_from_index(*args)
Returns color name/hex value for a given color index.

Parameters:

color_index - int : the sammi color index value.

Return type : string

weakref_proxy = proxy(…)
proxy(object[, callback]) -- create a proxy object that weakly

references 'object'.  'callback', if given, is called with a

reference to the proxy when 'object' is about to be finalized.

Data

       ADVANCED_LIST_MANAGER_DDO = 5052

ADVANCED_MENU_DDO = 5049

ADVANCED_SELECT_LIST_DDO = 5048

ALARM_DDO = 5001

ANNOTATED_TEXT_DDO = 5044

ARC = 3006

BAR_CHART_DDO = 5036

BAR_DDO = 5011

BATCH_DDO = 5010

BITMAP_SYMBOL_DDO = 5012

BORDER_ETCHED_IN = 5

BORDER_ETCHED_OUT = 6

BORDER_IN = 7

BORDER_OUT = 8

BUTTON_DDO = 5025

BUTTON_GROUP_DDO = 5026

CMD_DST_FIELD = 0

CMD_DST_SERVER = 1

COMPOSITE = 1004

CURVE_SET_DATA_TYPE = 11

CURVE_SET_DDO = 5017

CUSTOM_TIME_DDO = 5023

DA_CURVE_SET = 4025

DA_LOCAL = 4002

DA_NONE = 4000

DA_PEER = 1

DA_POLL = 0

DA_TIME = 4001

DA_UNIVERSAL = 4024

DDO = 1002

DLONG_DATA_TYPE = 7

DOBJ_DDO = 5021

DOUBLE_DATA_TYPE = 4

DRAW_PORT_DDO = 5047

ELLIPSE = 3005

EQUATION_DDO = 5016

EVEN_ODD_FILL = 0

FIXSTR_DATA_TYPE = 5

FLOAT_DATA_TYPE = 3

FORMATTED_NUMERIC_DDO = 5033

FRAME = 3009

FSL_METER_DDO = 5031

FS_NO_FILL = 1

FS_OPAQUE_STIPPLED = 3

FS_SOLID = 0

FS_STIPPLED = 2

GAUGE_DDO = 5019

GRAPHIC_DATA_FIELD_DDO = 5034

IMAGE = 3008

IMAGE_TYPE_GIF = 2

IMAGE_TYPE_SYM = 5

IMAGE_TYPE_UNKNOWN = 0

IMAGE_TYPE_XBM = 1

IMAGE_TYPE_XPM = 4

IMAGE_TYPE_XWD = 3

INTEGER_DDO = 5004

LAYER = 1005

LC_BUTT = 1

LC_NONE = 0

LC_PROJECT = 3

LC_ROUND = 2

LJ_BEVEL = 2

LJ_MITER = 0

LJ_ROUND = 1

LONG32_DATA_TYPE = 12

LONG_DATA_TYPE = 2

LS_DASH = 1

LS_DOUBLEDASH = 2

LS_SOLID = 0

MENU_DDO = 5014

METER_DDO = 5018

MISC_DATA_TYPE = 8

MSL_METER_DDO = 5032

OBJ_ICON_DDO = 5030

OPTIONS_DDO = 5015

OPTION_MENU_DDO = 5043

PANED_WINDOW_DDO = 5042

PIE_CHART_DDO = 5035

PLOT_DATA_TYPE = 10

PLOT_DDO = 5008

POKE_DDO = 5002

POLYGON = 3002

POLYLINE = 3003

REAL_DDO = 5005

RECTANGLE = 3001

REGION_DDO = 5037

SCROLL_BAR_DDO = 5024

SCROLL_DDO = 5020

SELECT_LIST_DDO = 5027

SHORT_DATA_TYPE = 1

SLIDER_DDO = 5028

SPLINE = 3004

TABULAR_DDO = 5022

TEXT = 3007

TEXTBOX_DDO = 5003

TEXT_BROWSER_DDO = 5029

TEXT_FIELD_DDO = 5040

TEXT_SYMBOL_DDO = 5007

TIME_DDO = 5006

TOOLBAR_DDO = 5041

TREND_DATA_TYPE = 9

TREND_DDO = 5009

UNDEF_DATA_TYPE = 0

VARSTR_DATA_TYPE = 6

VECTOR_SYMBOL = 3012

VECTOR_SYMBOL_DDO = 5045

VTEXT = 3011

WINDING_FILL = 1

 

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>