Home > Objects > @iData > getalias.m

iFit/getalias

PURPOSE ^

[link, label,names] = getalias(s, 'AliasName') : get iData alias

SYNOPSIS ^

function [link, label, names] = getalias(this,alias)

DESCRIPTION ^

 [link, label,names] = getalias(s, 'AliasName') : get iData alias

   @iData/getalias function to get iData alias definition.
   [link, label]          = getalias(s, alias) returns the alias link and its label/description.
   [names, links, labels] = getalias(s)        returns all defined aliases.
   The Signal, Error and Monitor aliases are always defined.
   The value of the alias is obtained with the syntax: 's.alias'.
   To search for aliases/fields in the object you may use findfield.

 input:  s: object or array (iData)
         alias: alias name to inquire in object, or '' (char).
 output: link: alias link/definition (char/cellstr)
         label: alias description (char/cellstr)
         names: all defined alias names (cellstr)
 ex:     getalias(iData) or getalias(iData,'Signal')

 Version: Nov. 26, 2018
 See also iData, iData/set, iData/get, iData/setalias, iData/rmalias

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Mon 26-Nov-2018 15:08:42 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1