ATMTools User Guide (.pdf)
ContentsIndexReferenceHome
PreviousUpNext
Lookup APIstruct in User's Guide
APIstruct
Collapse All
MATLAB
obj = APIstruct(xmlFile)
Description

Returns an APIstruct object for interacting with the API models. This function can read in xml files for ParamStruct, TargStruct, AtmStruct, and GeomStruct.

Parameters
Parameters 
Description 
xmlFile [char] 
Name of xml file to read in. Defaults to directory returned by ParamPath if path is not specified. 
Return Values
Return Values 
Description 
obj [APIstruct] 
APIstruct object 
structType [char] 
Type of structure from the xml file 
pointer [libpointer] 
Lib pointer object required by direct calls to API functions 
xmlFileName [char] 
Name of xml file loaded 
Examples

>> ptr = APIstruct('source_GBTL.xml') 

  • Loads the input xml file
>> ptr.getDbl('HEL.Wavelength') 

  • Return the value of the HEL wavelength
>> ptr.setDbl('Tx.TRK.BW',100) 

  • Change the track bandwidth to 100
>> PS = struct(ptr) 

  • Convert the APIstruct object to a structure
 

See Also

ParamPath

Group

API Support Functions

Made with Doc-O-Matic.
Copyright (c) 2009. All rights reserved.
Contents | Index | Reference | Home
What do you think about this topic? Send feedback!