BasicCombination.setTreeParent


setTreeParent(loadset)

setTreeParent(name, [resFile], [eigen], [harm])

setTreeParent(ID, [resFile], [eigen], [harm])

Choose another loadset to act in the treeview as the logical parent of this loadset. In other words, move this loadset within the given loadset in the treeview. This is particularly useful for nesting combinations or envelopes, where only the 'outer' loadset is useful in its own right, but the ones 'within' are needed for calculation purposes. The loadset can be specified in several ways, by name, by ID or by type and name/ID. In each case, additionally specifying the results file name/ID, eigenvalue ID and harmonic ID will clarify to LUSAS which loadset is required. Alternatively, an object may be passed in, which requires no further clarification. This same principle applies to all functions that input single loadsets, and the examples below reflect this. Each input form is legal in each circumstance

Note

An ambiguity arises when passing in only two strings, e.g. db.getLoadset(lcData, "A", "B") which could mean a loadcase called A in file B or a loadcase of type A called B. Generally the result will be obvious from the input strings, but to be on the safe side, LUSAS will try both in that order. The only combination of inputs that can not be accepted is to combine the type with eigen or harmonic ID, e.g. db.getLoadset("results", "LC1", 2, -1). However, this is redundant anyway, as all eigen or harmonic loadsets are by definition results loadsets - therefore simply omit the type in this circumstance

Examples

 db.getLoadset(1, 2, 3, -1)                          ' ID=1 resfile=2     eigen=3  harm=-1
 db.getLoadset("Loadcase 1", "C:\temp\model.mys")    '                    eigen=-1 harm=-1
 db.deleteLoadset(1)                                 ' ID=1 resfile=model eigen=-1 harm=-1
 set lc = db.getLoadset(4, 1))                       ' ID=4 resfile=1     eigen=-1 harm=-1
 envelope.addEntry(lc)                               ' previously returned object added to envelope

loadsetLoadsetThe loadset as an object
namestringName of the loadset
IDlongID of the loadset
resFilestring or longFilename or ID of the results file in which the loadcase resides (default = model)
eigenlongEigenvalue ID of the loadset
harmlongHarmonic ID of the loadset
Return valueIFLoadset

Example

 ' show comb 1 inside comb 2 in the tree
 call getLoadset("comb 2").setTreeParent("comb 1")
 

See also setTreeLocation

Back to BasicCombination

Back to Overview