code::FieldInfo Struct Reference

List of all members.

---

Detailed Description

Information about a field in a PointSetData.

Author:

Thomas E. Vaughan

Version:

Date

2009/06/02 20:17:37

Author

lakshman

See also:

PointSetData

Public Member Functions
bool	isNumeric () const
	FieldInfo ()
	Default constructor for STL containers.
	FieldInfo (const std::string &, size_t)
	Build from a list of member values.
Static Public Member Functions
static FieldInfo	createTextFieldInfo (size_t)
	Construct a FieldInfo object corresponding to text.
Public Attributes
std::string	units
	If this field is numeric, then the units member gives physical meaning to the field's value.
size_t	offset
	Field offset, index of this field in a PointRecord vector of strings.

---

Constructor & Destructor Documentation

code::FieldInfo::FieldInfo

(

)

Default constructor for STL containers.

code::FieldInfo::FieldInfo	(	const std::string &	,
		size_t
	)

Build from a list of member values.

Parameters:

	const_string&	unit specifier
	size_t	offset of field in PointRecord

---

Member Function Documentation

static FieldInfo code::FieldInfo::createTextFieldInfo

(

size_t

)

[static]

Construct a FieldInfo object corresponding to text.

bool code::FieldInfo::isNumeric

(

)

const

Returns:

false if the unit corresponds to textual data, true if the units are valid (or unitless)

---

Member Data Documentation

size_t code::FieldInfo::offset

Field offset, index of this field in a PointRecord vector of strings.

std::string code::FieldInfo::units

If this field is numeric, then the units member gives physical meaning to the field's value.

If this field corresponds to purely textual data, then the units member is equal to the null string "". If this field corresponds to unitless numeric data, then the units member is equal to the string "unitless".

---