sptk::CField Class Reference
[Utility Classes]

Data field for CDataSource. More...

#include <CField.h>

Inheritance diagram for sptk::CField:

List of all members.

Public Member Functions
	CField (const char *name)
	Constructor.
const std::string &	fieldName () const
	Returns field name.
virtual CField &	operator= (const CVariant &C)
	Assignment operation.
virtual CField &	operator= (int64_t value)
	Assignment operation.
virtual CField &	operator= (uint64_t value)
	Assignment operation.
virtual CField &	operator= (int32_t value)
	Assignment operation.
virtual CField &	operator= (uint32_t value)
	Assignment operation.
virtual CField &	operator= (int16_t value)
	Assignment operation.
virtual CField &	operator= (uint16_t value)
	Assignment operation.
virtual CField &	operator= (float value)
	Assignment operation.
virtual CField &	operator= (double value)
	Assignment operation.
virtual CField &	operator= (const char *value)
	Assignment operation.
virtual CField &	operator= (const std::string &value)
	Assignment operation.
virtual CField &	operator= (CDateTime value)
	Assignment operation.
virtual CField &	operator= (const void *value)
	Assignment operation.
virtual CField &	operator= (const CBuffer &value)
	Assignment operator.
virtual std::string	asString () const throw (CException)
	Better (than in base class) conversion method.
void	toXML (CXmlNode &node, bool compactXmlMode) const
	Exports the field data into XML node.
Public Attributes
std::string	displayName
	Optional display field name.
int32_t	width
	Field width.
int32_t	precision
	Field precision.
int32_t	flags
	Field flags like alignment, etc.
bool	visible
	Is field visible?
Protected Attributes
std::string	m_name
	Field name.
Friends
class	CFieldList

---

Detailed Description

Data field for CDataSource.

Contains field name, field type, field data and field format information.

---

Constructor & Destructor Documentation

sptk::CField::CField

(

const char *

name

)

Constructor.

Parameters:

name

const char *, field name

---

Member Function Documentation

void sptk::CField::toXML	(	CXmlNode &	node,
		bool	compactXmlMode
	)			const

Exports the field data into XML node.

If the compactXmlMode flag is true, the field is exported as an attribute. Otherwise, the field is exported as subnodes. For the fields of the VAR_TEXT type, the subnode is created containing CDATA section.

Parameters:

	node	CXmlNode&, a node to export field data into
	compactXmlMode	bool, compact XML mode flag

---

The documentation for this class was generated from the following file:

• CField.h