You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 11
Next »
CUROBJECT$ returns the name of an object in a Solution depending on the mode given.
Syntax
CUROBJECT$(Mode%)
Arguments
- Mode% can assume values of 0, 1, 2, 4 or 5.
- Mode% = 0: return the current object name;
- Mode% = 1: return the full object name (so including parent instance numbers etc.);
- Mode% = 2: return the full object name translated in logical text to be used as label;
- Mode% = 4: return the full object name but without instance numbers;
- Mode% = 5: return the object name of the one single object present inthe Solution object;
- See the examples below for a full explanation of the different modes
Examples
Assume the relation
OBJNAME$ = UROBJECT$(Mode%)
is executed in a Solution object
NOTE: The objects and will form one word with the pump instance number 2 if holds an @FUNCTION attribute. The object HeatBalance is not included in the result since the HeatBalance object holds an @NOTINNAME attribute.
- For Mode% = 4, the CUROBJECT$ function returns the full object name, so with all parents WITHOUT instance numbers, so: OBJNAM$ = "Dredge.Pump.Gearbox.LOcooler"NOTE: Again, the object HeatBalance is not included in the result since the HeatBalance object holds a @NOTINNAME attribute.
- For Mode% = 5, the CUROBJECT$ function returns the object name of the one single object present in a Solution object, e.g. if HeatBalance.Dredge.Pump.2.Gearbox only contains an object LOcooler, CUROBJECT$(5) will return here the result "LOcooler".
Quick links: Function overview | Attribute overview | Constants overview | Dimensions overview