tcc.base.fieldWrapper Namespace Reference

Classes
class	BaseFieldWrapper
	A class that sets the values of a struct-like field. More...
class	ArrayWrapper
	Wrapper for a fixed-length array of values, all of the same type. More...
class	ChebyshevWrapper
	Wrapper for a Chebyshev Polynomial. More...
class	CoordSysWrapper
	Wrapper for coordConv::CoordSys. More...
class	DocWrapper
	Wrapper that only prints documentation. More...
class	EnumArrayWrapper
	Wrapper for a fixed-length array of enums that receives and prints strings. More...
class	EnumWrapper
	Wrapper for enums that receives and prints strings. More...
class	GuideProbeVectorWrapper
	Wrapper for inst.gProbe vector. More...
class	InstPositionWrapper
	Wrapper for InstPosition. More...
class	ObsCoordSysWrapper
	Wrapper for coordConv::ObsCoordSys (user cannot change the system) More...
class	PVAJTArrayWrapper
	Wrapper for a fixed-length array of PVAJT. More...
class	PVTArrayWrapper
	Wrapper for a fixed-length array of coordConv.PVT. More...
class	PVTCoordWrapper
	Wrapper for coordConv.PVTCoord. More...
class	PxPMRadVelWrapper
class	FixedPVTCoordWrapper
	Wrapper for coordConv.PVTCoord with no proper motion or radial velocity. More...
class	PVTWrapper
	Wrapper for a single coordConv.PVT. More...
class	ScalarWrapper
	Wrap a single value. More...
class	WrapperList
	An ordered collection of field wrappers. More...

Functions
def	intFromStr
	Convert string to int: 0xN is hex, N is decimal, where N is a string of 1 or more digits. More...
def	getNInts
	Return numVals integers. More...
def	getNFloats
	Return numVals floats. More...
def	tokenize
	Break a line of whitespace-separated data into individual tokens. More...

Variables
list	__all__
	boolFromStr = RO.CnvUtil.asBool

Function Documentation

def tcc.base.fieldWrapper.getNFloats	(		numVals,
			strDataList
	)

Return numVals floats.

Parameters

[in]	numVals	the number of values required
[in]	strDataList	list of string values to be converted

Returns

a tuple of numVals ints

Exceptions

RuntimeError

if the wrong number of values are provided or if they are the wrong type

Definition at line 867 of file fieldWrapper.py.

def tcc.base.fieldWrapper.getNInts	(		numVals,
			strDataList
	)

Return numVals integers.

Parameters

[in]	numVals	the number of values required
[in]	strDataList	list of string values to be converted

Returns

a tuple of numVals ints

Exceptions

RuntimeError

if the wrong number of values are provided or if they are the wrong type

Definition at line 851 of file fieldWrapper.py.

def tcc.base.fieldWrapper.intFromStr

(

strVal

)

Convert string to int: 0xN is hex, N is decimal, where N is a string of 1 or more digits.

Intended for fields that are likely to contain hex data (e.g. bit masks)

Definition at line 20 of file fieldWrapper.py.

def tcc.base.fieldWrapper.tokenize

(

line

)

Break a line of whitespace-separated data into individual tokens.

Strings are one token: strings are delimited with " or ', but a string can contain its delimiter char if followed by \ Comments are stripped: all text following # or ! (except within a string) Escaped chars are not treated as delimiters: text followed by \ is retained Values are separated by one or more spaces, tabs or commas (yes, even multiple commas)

Definition at line 883 of file fieldWrapper.py.

Variable Documentation

list tcc.base.fieldWrapper.__all__

Initial value:

= ["boolFromStr", "intFromStr", "ArrayWrapper", "ChebyshevWrapper", "CoordSysWrapper", "DocWrapper",
    "EnumArrayWrapper", "EnumWrapper",
    "GuideProbeVectorWrapper", "ObsCoordSysWrapper", "InstPositionWrapper",
    "PVAJTArrayWrapper", "PVTArrayWrapper",
    "PVTCoordWrapper", "PxPMRadVelWrapper", "FixedPVTCoordWrapper", "PVTWrapper", "ScalarWrapper", "WrapperList"]

Definition at line 11 of file fieldWrapper.py.

tcc.base.fieldWrapper.boolFromStr = RO.CnvUtil.asBool

Definition at line 17 of file fieldWrapper.py.