Module interface:regioner - Regioner interface

Index

• Channel type CT.REGIONER - Regioner channel-type
  
  • Variable in? - Requests to regioner
  • Variable out! - Responses from regioner
  • Variable return? - Used to close the connection to the regioner
• Protocol P.REGIONER.IN - Regioner input protocol
  
  • Tag del.region - Delete a region, responds with (ok |~| error)
  • Tag hide.region - Mark a region (by ID) as hidden
  • Tag in.region - Determines which region a particular point is in
  • Tag in.regions - Determins which region(s) a particular point is in
  • Tag mod.region - Modify a region, responds with (ok |~| error)
  • Tag new.region - Create a new region, responds with (new.region |~| error)
  • Tag unhide.region - Mark a region (by ID) as not-hidden
• Protocol P.REGIONER.OUT - Regioner output protocol
  
  • Tag error - Generic error
  • Tag in.region - In specified region (-1 indicates no region)
  • Tag in.regions - In specified regions (empty array indicates no regions)
  • Tag new.region - New region successfully created (id returned)
  • Tag ok - Generic success
• Record REGIONATTR - Public attributes for a particular region
  
  • Variable end - Ending positions
  • Variable hidden - Whether this is currently hidden or not
  • Variable id - Region ID
  • Variable ndim - Number of dimensions
  • Variable start - Starting positions

Declarations