Interface NXenvironment

All Superinterfaces:
GroupNode, Iterable<NodeLink>, Node, NXobject

public interface NXenvironment extends NXobject
Parameters for controlling external conditions
  • Field Details

  • Method Details

    • getName

      org.eclipse.january.dataset.Dataset getName()
      Apparatus identification code/model number; e.g. OC100 011
      Returns:
      the value.
    • setName

      DataNode setName(org.eclipse.january.dataset.IDataset nameDataset)
      Apparatus identification code/model number; e.g. OC100 011
      Parameters:
      nameDataset - the nameDataset
    • getNameScalar

      String getNameScalar()
      Apparatus identification code/model number; e.g. OC100 011
      Returns:
      the value.
    • setNameScalar

      DataNode setNameScalar(String nameValue)
      Apparatus identification code/model number; e.g. OC100 011
      Parameters:
      name - the name
    • getShort_name

      org.eclipse.january.dataset.Dataset getShort_name()
      Alternative short name, perhaps for dashboard display like a present Seblock name
      Returns:
      the value.
    • setShort_name

      DataNode setShort_name(org.eclipse.january.dataset.IDataset short_nameDataset)
      Alternative short name, perhaps for dashboard display like a present Seblock name
      Parameters:
      short_nameDataset - the short_nameDataset
    • getShort_nameScalar

      String getShort_nameScalar()
      Alternative short name, perhaps for dashboard display like a present Seblock name
      Returns:
      the value.
    • setShort_nameScalar

      DataNode setShort_nameScalar(String short_nameValue)
      Alternative short name, perhaps for dashboard display like a present Seblock name
      Parameters:
      short_name - the short_name
    • getType

      org.eclipse.january.dataset.Dataset getType()
      Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100
      Returns:
      the value.
    • setType

      DataNode setType(org.eclipse.january.dataset.IDataset typeDataset)
      Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100
      Parameters:
      typeDataset - the typeDataset
    • getTypeScalar

      String getTypeScalar()
      Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100
      Returns:
      the value.
    • setTypeScalar

      DataNode setTypeScalar(String typeValue)
      Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100
      Parameters:
      type - the type
    • getDescription

      org.eclipse.january.dataset.Dataset getDescription()
      Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump
      Returns:
      the value.
    • setDescription

      DataNode setDescription(org.eclipse.january.dataset.IDataset descriptionDataset)
      Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump
      Parameters:
      descriptionDataset - the descriptionDataset
    • getDescriptionScalar

      String getDescriptionScalar()
      Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump
      Returns:
      the value.
    • setDescriptionScalar

      DataNode setDescriptionScalar(String descriptionValue)
      Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump
      Parameters:
      description - the description
    • getProgram

      org.eclipse.january.dataset.Dataset getProgram()
      Program controlling the apparatus; e.g. LabView VI name
      Returns:
      the value.
    • setProgram

      DataNode setProgram(org.eclipse.january.dataset.IDataset programDataset)
      Program controlling the apparatus; e.g. LabView VI name
      Parameters:
      programDataset - the programDataset
    • getProgramScalar

      String getProgramScalar()
      Program controlling the apparatus; e.g. LabView VI name
      Returns:
      the value.
    • setProgramScalar

      DataNode setProgramScalar(String programValue)
      Program controlling the apparatus; e.g. LabView VI name
      Parameters:
      program - the program
    • getPosition

      NXgeometry getPosition()
      The position and orientation of the apparatus. Note, it is recommended to use NXtransformations instead.
      Returns:
      the value.
    • setPosition

      void setPosition(NXgeometry positionGroup)
      The position and orientation of the apparatus. Note, it is recommended to use NXtransformations instead.
      Parameters:
      positionGroup - the positionGroup
    • getValue

      org.eclipse.january.dataset.Dataset getValue()
      This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated. Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.

      Type: NX_FLOAT Units: NX_ANY

      Returns:
      the value.
    • setValue

      DataNode setValue(org.eclipse.january.dataset.IDataset valueDataset)
      This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated. Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.

      Type: NX_FLOAT Units: NX_ANY

      Parameters:
      valueDataset - the valueDataset
    • getValueScalar

      Double getValueScalar()
      This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated. Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.

      Type: NX_FLOAT Units: NX_ANY

      Returns:
      the value.
    • setValueScalar

      DataNode setValueScalar(Double valueValue)
      This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated. Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.

      Type: NX_FLOAT Units: NX_ANY

      Parameters:
      value - the value
    • getDepends_on

      org.eclipse.january.dataset.Dataset getDepends_on()
      NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere.

      Type: NX_CHAR

      Returns:
      the value.
    • setDepends_on

      DataNode setDepends_on(org.eclipse.january.dataset.IDataset depends_onDataset)
      NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere.

      Type: NX_CHAR

      Parameters:
      depends_onDataset - the depends_onDataset
    • getDepends_onScalar

      String getDepends_onScalar()
      NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere.

      Type: NX_CHAR

      Returns:
      the value.
    • setDepends_onScalar

      DataNode setDepends_onScalar(String depends_onValue)
      NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere.

      Type: NX_CHAR

      Parameters:
      depends_on - the depends_on
    • getTransformations

      NXtransformations getTransformations()
      This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
      Returns:
      the value.
    • setTransformations

      void setTransformations(NXtransformations transformationsGroup)
      This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
      Parameters:
      transformationsGroup - the transformationsGroup
    • getTransformations

      NXtransformations getTransformations(String name)
      Get a NXtransformations node by name:
      • This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXtransformations for that node.
    • setTransformations

      void setTransformations(String name, NXtransformations transformations)
      Set a NXtransformations node by name:
      • This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
      Parameters:
      name - the name of the node
      transformations - the value to set
    • getAllTransformations

      Map<String,NXtransformations> getAllTransformations()
      Get all NXtransformations nodes:
      • This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
      Returns:
      a map from node names to the NXtransformations for that node.
    • setAllTransformations

      void setAllTransformations(Map<String,NXtransformations> transformations)
      Set multiple child nodes of a particular type.
      • This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
      Parameters:
      transformations - the child nodes to add
    • getNote

      NXnote getNote()
      Additional information, LabView logs, digital photographs, etc
      Returns:
      the value.
    • setNote

      void setNote(NXnote noteGroup)
      Additional information, LabView logs, digital photographs, etc
      Parameters:
      noteGroup - the noteGroup
    • getNote

      NXnote getNote(String name)
      Get a NXnote node by name:
      • Additional information, LabView logs, digital photographs, etc
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXnote for that node.
    • setNote

      void setNote(String name, NXnote note)
      Set a NXnote node by name:
      • Additional information, LabView logs, digital photographs, etc
      Parameters:
      name - the name of the node
      note - the value to set
    • getAllNote

      Map<String,NXnote> getAllNote()
      Get all NXnote nodes:
      • Additional information, LabView logs, digital photographs, etc
      Returns:
      a map from node names to the NXnote for that node.
    • setAllNote

      void setAllNote(Map<String,NXnote> note)
      Set multiple child nodes of a particular type.
      • Additional information, LabView logs, digital photographs, etc
      Parameters:
      note - the child nodes to add
    • getActuator

      NXactuator getActuator()
      Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
      Returns:
      the value.
    • setActuator

      void setActuator(NXactuator actuatorGroup)
      Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
      Parameters:
      actuatorGroup - the actuatorGroup
    • getActuator

      NXactuator getActuator(String name)
      Get a NXactuator node by name:
      • Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXactuator for that node.
    • setActuator

      void setActuator(String name, NXactuator actuator)
      Set a NXactuator node by name:
      • Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
      Parameters:
      name - the name of the node
      actuator - the value to set
    • getAllActuator

      Map<String,NXactuator> getAllActuator()
      Get all NXactuator nodes:
      • Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
      Returns:
      a map from node names to the NXactuator for that node.
    • setAllActuator

      void setAllActuator(Map<String,NXactuator> actuator)
      Set multiple child nodes of a particular type.
      • Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
      Parameters:
      actuator - the child nodes to add
    • getSensor

      NXsensor getSensor()
      Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
      Returns:
      the value.
    • setSensor

      void setSensor(NXsensor sensorGroup)
      Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
      Parameters:
      sensorGroup - the sensorGroup
    • getSensor

      NXsensor getSensor(String name)
      Get a NXsensor node by name:
      • Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXsensor for that node.
    • setSensor

      void setSensor(String name, NXsensor sensor)
      Set a NXsensor node by name:
      • Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
      Parameters:
      name - the name of the node
      sensor - the value to set
    • getAllSensor

      Map<String,NXsensor> getAllSensor()
      Get all NXsensor nodes:
      • Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
      Returns:
      a map from node names to the NXsensor for that node.
    • setAllSensor

      void setAllSensor(Map<String,NXsensor> sensor)
      Set multiple child nodes of a particular type.
      • Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
      Parameters:
      sensor - the child nodes to add