quanta.form.xxx - Function

Format a quantity using globaly set formats

Synopsis
form.xxx(v, showform)

Arguments

v	in	value to be converted
		Allowed:	quantity
showform	in	show square brackets and separating , (not for all)
		Allowed:	bool
		Default:	F

Returns
string
If a multi-dimensional value is given for the value v in the case of dtime, long or lat, the returned value is a string vector of a length equal to last dimension. Each string has a number of fields equal to the number of elements in all earlier dimensions. If the showform is T, each vector element is surrounded by a pair of square brackets if there is more than one entry, and fields are separated by a ','.

Description
form.xxx (xxx can be lat, long, len, vel, freq, dtime, unit) will format the input into a string using the global format information set by setformat().

Example

- dq.setformat('freq','cm')
T 
- dq.form.freq(dq.quantity('5GHz'))
5.99584916 cm

Next: quanta.convertfreq - Function Up: quanta - Tool Previous: quanta.getformat - Function Contents Index

	Package	general
	Module	quanta
	Tool	quanta