NXSConfigServer Tango Python Class












NXSConfigServer Properties :


There is no class properties


Device Properties
Name
Description
Type
Default Value
VersionLabel version label String "XCS"
ExtraLinkPath extra link path below NXentry, default: instrument:NXinstrument/collection:NXcollection String "instrument:NXinstrument/collection:NXcollection"







NXSConfigServer Class Commands
Name
Input type
Output type
Level
Description
State DEV_VOID DEV_STATE OPERATOR This command gets the device state (stored in its device_state data member) and returns it to the caller.
Status DEV_VOID CONST_DEV_STRING OPERATOR This command gets the device status (stored in its device_status data member) and returns it to the caller.
Open DEV_VOID DEV_VOID OPERATOR Opens connection to the database
Close DEV_VOID DEV_VOID OPERATOR Closes connection into the database
Components DEVVAR_STRINGARRAY DEVVAR_STRINGARRAY OPERATOR Returns a list of required components
Selections DEVVAR_STRINGARRAY DEVVAR_STRINGARRAY OPERATOR Returns a list of required selections
InstantiatedComponents DEVVAR_STRINGARRAY DEVVAR_STRINGARRAY OPERATOR Returns a list of required components
DataSources DEVVAR_STRINGARRAY DEVVAR_STRINGARRAY OPERATOR Returns a list of required DataSources
AvailableComponents DEV_VOID DEVVAR_STRINGARRAY OPERATOR Returns a list of available component names
AvailableSelections DEV_VOID DEVVAR_STRINGARRAY OPERATOR Returns a list of available selection names
AvailableDataSources DEV_VOID DEVVAR_STRINGARRAY OPERATOR Returns a list of available DataSource names
StoreSelection DEV_STRING DEV_VOID OPERATOR Stores the selection from XMLString
StoreComponent DEV_STRING DEV_VOID OPERATOR Stores the component from XMLString
StoreDataSource DEV_STRING DEV_VOID OPERATOR Stores the DataSource from XMLString
CreateConfiguration DEVVAR_STRINGARRAY DEV_VOID OPERATOR Creates the NDTS configuration script from the given components. The result is strored in XMLString
DeleteComponent DEV_STRING DEV_VOID OPERATOR Deletes the given component
DeleteSelection DEV_STRING DEV_VOID OPERATOR Deletes the given selection
DeleteDataSource DEV_STRING DEV_VOID OPERATOR Deletes the given datasource
SetComponentDataSources DEV_STRING DEV_VOID OPERATOR Sets component datasources according to given dictionary
SetMandatoryComponents DEVVAR_STRINGARRAY DEV_VOID OPERATOR Sets the mandatory components
MandatoryComponents DEV_VOID DEVVAR_STRINGARRAY OPERATOR Returns the mandatory components
UnsetMandatoryComponents DEVVAR_STRINGARRAY DEV_VOID OPERATOR Removes the given components from the mandatory components
ComponentDataSources DEV_STRING DEVVAR_STRINGARRAY OPERATOR Returns a list of datasource names for a given component
ComponentsDataSources DEVVAR_STRINGARRAY DEVVAR_STRINGARRAY OPERATOR Returns a list of datasource names for a given components
ComponentsVariables DEVVAR_STRINGARRAY DEVVAR_STRINGARRAY OPERATOR Returns a list of variable names for a given components
ComponentVariables DEV_STRING DEVVAR_STRINGARRAY OPERATOR Returns a list of variable names for a given component
Merge DEVVAR_STRINGARRAY DEV_STRING OPERATOR Merges give components
DependentComponents DEVVAR_STRINGARRAY DEVVAR_STRINGARRAY OPERATOR Returns a list of dependent component names for a given components
InstantiatedDataSources DEVVAR_STRINGARRAY DEVVAR_STRINGARRAY OPERATOR Returns a list of required datasources






Command State :


State Definition
Input Argument Tango::DEV_VOID none
Output Argument Tango::DEV_STATE Device state
DisplayLevel OPERATOR ..
Inherited true ..
Abstract false ..
Polling Period Not polled ..



Command allowed for All states ..






Command Status :


Status Definition
Input Argument Tango::DEV_VOID none
Output Argument Tango::CONST_DEV_STRING Device status
DisplayLevel OPERATOR ..
Inherited true ..
Abstract false ..
Polling Period Not polled ..



Command allowed for All states ..






Command Open :


Open Definition
Input Argument Tango::DEV_VOID
Output Argument Tango::DEV_VOID
DisplayLevel OPERATOR ..
Inherited false ..
Abstract false ..
Polling Period Not polled ..



Command NOT allowed for
  • RUNNING
  • ..






    Command Close :


    Close Definition
    Input Argument Tango::DEV_VOID
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command Components :


    Components Definition
    Input Argument Tango::DEVVAR_STRINGARRAY list of component names
    Output Argument Tango::DEVVAR_STRINGARRAY list of required components
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command Selections :


    Selections Definition
    Input Argument Tango::DEVVAR_STRINGARRAY list of selection names
    Output Argument Tango::DEVVAR_STRINGARRAY list of required selections
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command InstantiatedComponents :


    InstantiatedComponents Definition
    Input Argument Tango::DEVVAR_STRINGARRAY list of component names
    Output Argument Tango::DEVVAR_STRINGARRAY list of instantiated components
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command DataSources :


    DataSources Definition
    Input Argument Tango::DEVVAR_STRINGARRAY list of DataSource names
    Output Argument Tango::DEVVAR_STRINGARRAY list of required DataSources
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command AvailableComponents :


    AvailableComponents Definition
    Input Argument Tango::DEV_VOID
    Output Argument Tango::DEVVAR_STRINGARRAY list of available component names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command AvailableSelections :


    AvailableSelections Definition
    Input Argument Tango::DEV_VOID
    Output Argument Tango::DEVVAR_STRINGARRAY list of available selection names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command AvailableDataSources :


    AvailableDataSources Definition
    Input Argument Tango::DEV_VOID
    Output Argument Tango::DEVVAR_STRINGARRAY list of available DataSource names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command StoreSelection :


    StoreSelection Definition
    Input Argument Tango::DEV_STRING selection name
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command StoreComponent :


    StoreComponent Definition
    Input Argument Tango::DEV_STRING component name
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command StoreDataSource :


    StoreDataSource Definition
    Input Argument Tango::DEV_STRING datasource name
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command CreateConfiguration :


    CreateConfiguration Definition
    Input Argument Tango::DEVVAR_STRINGARRAY list of component names
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command DeleteComponent :


    DeleteComponent Definition
    Input Argument Tango::DEV_STRING component name
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command DeleteSelection :


    DeleteSelection Definition
    Input Argument Tango::DEV_STRING selection name
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command DeleteDataSource :


    DeleteDataSource Definition
    Input Argument Tango::DEV_STRING datasource name
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command SetComponentDataSources :


    SetComponentDataSources Definition
    Input Argument Tango::DEV_STRING JSON dict {comp1: {tds1: ds1, ...}, ...}
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command SetMandatoryComponents :


    SetMandatoryComponents Definition
    Input Argument Tango::DEVVAR_STRINGARRAY component names
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command MandatoryComponents :


    MandatoryComponents Definition
    Input Argument Tango::DEV_VOID
    Output Argument Tango::DEVVAR_STRINGARRAY component names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command UnsetMandatoryComponents :


    UnsetMandatoryComponents Definition
    Input Argument Tango::DEVVAR_STRINGARRAY list of component names
    Output Argument Tango::DEV_VOID
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command ComponentDataSources :


    ComponentDataSources Definition
    Input Argument Tango::DEV_STRING component name
    Output Argument Tango::DEVVAR_STRINGARRAY list of datasource names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command ComponentsDataSources :


    ComponentsDataSources Definition
    Input Argument Tango::DEVVAR_STRINGARRAY component names
    Output Argument Tango::DEVVAR_STRINGARRAY list of datasource names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command ComponentsVariables :


    ComponentsVariables Definition
    Input Argument Tango::DEVVAR_STRINGARRAY component names
    Output Argument Tango::DEVVAR_STRINGARRAY list of variable names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command ComponentVariables :


    ComponentVariables Definition
    Input Argument Tango::DEV_STRING component name
    Output Argument Tango::DEVVAR_STRINGARRAY list of variable names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command Merge :


    Merge Definition
    Input Argument Tango::DEVVAR_STRINGARRAY list of component names
    Output Argument Tango::DEV_STRING merged components
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command DependentComponents :


    DependentComponents Definition
    Input Argument Tango::DEVVAR_STRINGARRAY component names
    Output Argument Tango::DEVVAR_STRINGARRAY list of component names
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..






    Command InstantiatedDataSources :


    InstantiatedDataSources Definition
    Input Argument Tango::DEVVAR_STRINGARRAY list of datasources names
    Output Argument Tango::DEVVAR_STRINGARRAY list of instantiated datasources
    DisplayLevel OPERATOR ..
    Inherited false ..
    Abstract false ..
    Polling Period Not polled ..



    Command NOT allowed for
  • ON
  • RUNNING
  • ..







    NXSConfigServer Class Attributes
    Name
    Inherited
    Abstract
    Attr. type
    R/W type
    Data type
    Level
    Description
    XMLString false false Scalar READ_WRITE Tango::DEV_STRING EXPERT It allows to pass XML strings into database during performing StoreComponent and StoreDataSource
    Moreover, after performing CreateConfiguration it contains the resulting XML configuration.
    Selection false false Scalar READ_WRITE Tango::DEV_STRING EXPERT "It allows to pass JSON strings into database during performing StoreSelection.
    JSONSettings false false Scalar READ_WRITE Tango::DEV_STRING EXPERT "The JSON string with parameters of MySQLdb.connect(...).
    Version false false Scalar READ Tango::DEV_STRING OPERATOR Configuration version
    Variables false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR The JSON string with XML configuration variables
    STEPDataSources false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR JSON list of datasources to be switched into STEP mode during creating configuration process
    LinkDataSources false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR JSON list of datasources to which links will be added
    CanFailDataSources false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR JSON list of datasources to be switched into CanFail mode during creating configuration process
    ExtraLinkDataSources false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR JSON list of datasources to which links will be added





    There is no dynamic attribute defined.





    Attribute XMLString :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ_WRITE
    Data Type Tango::DEV_STRING
    Display Level EXPERT
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized Not set


    Read NOT allowed for
  • ON
  • RUNNING
  • Write NOT allowed for
  • ON
  • RUNNING
  • Attribute Properties
    label XML Configuration
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false






    Attribute Selection :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ_WRITE
    Data Type Tango::DEV_STRING
    Display Level EXPERT
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized Not set


    Read NOT allowed for
  • ON
  • RUNNING
  • Write NOT allowed for
  • ON
  • RUNNING
  • Attribute Properties
    label Selected Component
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false






    Attribute JSONSettings :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ_WRITE
    Data Type Tango::DEV_STRING
    Display Level EXPERT
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized true
    Write hardware at init. Not set


    Read allowed for All states
    Write allowed for All states
    Attribute Properties
    label Arguments of MySQLdb.connect(...)
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false






    Attribute Version :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ
    Data Type Tango::DEV_STRING
    Display Level OPERATOR
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized Not set


    Read allowed for All states
    Attribute Properties
    label Configuration Version
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false






    Attribute Variables :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ_WRITE
    Data Type Tango::DEV_STRING
    Display Level OPERATOR
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized Not set


    Read NOT allowed for
  • RUNNING
  • Write NOT allowed for
  • RUNNING
  • Attribute Properties
    label XML Configuration Variables
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false






    Attribute STEPDataSources :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ_WRITE
    Data Type Tango::DEV_STRING
    Display Level OPERATOR
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized Not set


    Read allowed for All states
    Write allowed for All states
    Attribute Properties
    label Datasources to be switched into STEP Mode
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false






    Attribute LinkDataSources :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ_WRITE
    Data Type Tango::DEV_STRING
    Display Level OPERATOR
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized Not set


    Read allowed for All states
    Write allowed for All states
    Attribute Properties
    label Datasources to which links will be added
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false






    Attribute CanFailDataSources :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ_WRITE
    Data Type Tango::DEV_STRING
    Display Level OPERATOR
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized Not set


    Read allowed for All states
    Write allowed for All states
    Attribute Properties
    label Datasources to be switched into CanFail mode
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false






    Attribute ExtraLinkDataSources :


    Attribute Definition
    Attribute Type Scalar
    R/W Type READ_WRITE
    Data Type Tango::DEV_STRING
    Display Level OPERATOR
    Inherited false
    Abstract false
    Polling Period Not polled
    Memorized Not set


    Read allowed for All states
    Write allowed for All states
    Attribute Properties
    label Datasources to which extra links will be added
    unit
    standard unit
    display unit
    format
    max_value
    min_value
    max_alarm
    min_alarm
    max_warning
    min_warning
    delta_time
    delta_val
    Attribute Event Criteria
    Periodic Not set
    Relative Change Not set
    Absolute Change Not set


    Archive Periodic Not set
    Archive Relative Change Not set
    Archive Absolute Change Not set


    Push Change event by user code false
    Push Archive event by user code false
    Push DataReady event by user code false










    NXSConfigServer Class States
    Name
    Description
    ON Server is ON
    OPEN Open connection to the database
    RUNNING Performing a query