xfopt

SDT-base Contents Functions

xfopt

_FunType, _DataType, _FieldType

Purpose

User interface for curve stack pointer objects. Stack, see section 2.1.2, are now preferred so this function is documented mostly for compatibility.

Syntax

 xfopt command
 XF(1).FieldName=FieldValue
 XF(1).command='value'
 XF.check
 r1=XF(1).GetData
 curve=XF(1).GetAsCurve
 XF.save='FileName'

Description

SDT considers data sets in curve, curve Response data or Shapes at IO pairs formats. Handling of datasets is described in the iiplot tutorial which illustrates the use of curve stacks (previously called database wrappers).

ufread and ufwrite also use curve stacks which can be stored as variables. In this case, FEM models can also be stored in the stack.

The use of a stack pointer (obtained with XF=iicom(ci,'curvexf');) has side advantages that further checks on user input are performed.

XF.check verifies the consistency of information contained in all data sets and makes corrections when needed. This is used to fill in information that may have been left blank by the user.

disp(XF) gives general information about the dataset. XF(i).info gives detailed and formatted information about the dataset in XF(i). XF(i) only returns the actual dataset contents.

Object saving is overloaded so that data is retrieved from a iiplot figure if appropriate before saving the data to a mat file.

Object field setting is also overloaded (consistency checks are performed before actually setting a field) This is illustrated by the following example

 [ci,XF]=iiplot
 XF(1)
 XF(1).x='time'; XF(1).x

where XF(1) is a Response data set (with abscissa in field .w, responses in field .xf, ...).

XF(1).x='time' sets the XF(1).x field which contains a structure describing its type. Notice how you only needed to give the 'time' argument to fill in all the information. The list of supported axis types is given using xfopt('_datatype')

XF(1).w=[1:10]' sets the XF(1).w field.

_FunType, _DataType, _FieldType

These commands are used internally by SDT. xfopt _FunType returns the current list of function types (given in the format specification for Universal File 58).
label=xfopt('_FunType',type) and type=xfopt('_FunType','label') are two other accepted calls.

xfopt _DataType returns the current list of data types (given in the format specification for Universal File 58). xfopt('_DataType',type) and
xfopt('_DataType','label') are two other accepted calls.

For example XF.x.label='Frequency' or XF.x=18.

Data types are used to characterize axes (abscissa (x), ordinate numerator (yn), ordinate denominator (yd) and z-axis data (z)). They are characterized by the fields

.type	four integers describing the axis function type fun (see list with xfopt('_datatype')), length, force and temperature unit exponents
.label	a string label for the axis
.unit	a string for the unit of the axis

xfopt _FieldType returns the current list of field types.