dataDef Class Reference
[Data management]

Defines a single data field within a dataFrame. More...

#include <dataFrame.h>

List of all members.

Public Member Functions
	dataDef (const std::string &vn, const std::string &typ, const int n=1)
void	set_typeName (const std::string &s)
void	set_varName (const std::string &vn)
void	set_nElem (const int nel)
const std::string	get_typeName (void)
const std::string	get_varName (void)
const types_t	get_typeID (void)
const int	get_nElem (void)
const int	get_typeSize (void)
Protected Attributes
std::string	typeName
	the name of data type as a string
types_t	typeID
	the type associated with the data field
int	typeSize
	the number of bytes associated with the type
std::string	varName
	the name of the variable
int	nElem
Friends
std::ostream &	operator<< (std::ostream &os, dataDef &dd)

---

Detailed Description

Defines a single data field within a dataFrame.

Examples:

hmi04_utilities.cpp, and hmi04_utilities.h.

---

Constructor & Destructor Documentation

dataDef::dataDef	(	const std::string &	vn,
		const std::string &	typ,
		const int	n = 1
	)			[inline]

constructor for dataDef objects

---

Member Function Documentation

const int dataDef::get_nElem

(

void

)

[inline]

accessor function. Returns nElem

const types_t dataDef::get_typeID

(

void

)

[inline]

accessor function. Returns typeID

const std::string dataDef::get_typeName

(

void

)

[inline]

accessor function. Returns typeName

const int dataDef::get_typeSize

(

void

)

[inline]

accessor function. Returns typeSize

const std::string dataDef::get_varName

(

void

)

[inline]

accessor function. Returns varName

void dataDef::set_nElem

(

const int

nel

)

[inline]

accessor function. Sets nElem = nel

void dataDef::set_typeName

(

const std::string &

s

)

[inline]

accessor function. Sets typeName=s

void dataDef::set_varName

(

const std::string &

vn

)

[inline]

accessor function. Sets varName=vn

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		dataDef &	dd
	)			[friend]

output operator to write a dataDef object to an output stream. Useful for debugging

---

Member Data Documentation

int dataDef::nElem [protected]

number of elements

The number of consecutive data items of type typeID that are to be considered part of this data definition. Fields that will be referenced as timeSeries objects have nElem=1 by definition. Fileds that will be referenced as timeSeriesArray objects have nElem>1