Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

plist::Primitive< unsigned char > Class Template Reference

#include <plistPrimitives.h>

Inheritance diagram for plist::Primitive< unsigned char >:

List of all members.


Detailed Description

template<>
class plist::Primitive< unsigned char >

provides an unsigned char specialization of plist::Primitive<T>, adds a unique numeric property to the usual template implementation

A char can be treated as either a string or an integer, you can use the setNumeric(bool) function to indicate which style to use when saving

Definition at line 273 of file plistPrimitives.h.


Public Member Functions

 Primitive ()
 constructor
 Primitive (const unsigned char &v, bool isNum=false)
 casting constructor
Primitiveoperator= (unsigned char v)
 assignment
virtual Primitiveoperator= (const PrimitiveBase &pb)
 assignment (don't assign listeners); doesn't trigger fireValueChanged, subclass should do that from its own operator=() following assignment
Primitiveoperator= (const Primitive &p)
 assignment from primitive of the same type (just assign value)
Primitiveoperator+= (unsigned char v)
 add-assign
Primitiveoperator-= (unsigned char v)
 subtract-assign
Primitiveoperator *= (unsigned char v)
 multiple-assign
Primitiveoperator/= (unsigned char v)
 divide-assign
const unsigned char & operator * () const
 dereference will return data storage
const unsigned char * operator-> () const
 can use -> to access members of data storage
 operator unsigned char () const
 casting operator
void setNumeric (bool isNum)
 sets numeric
bool getNumeric () const
 returns numeric
void loadXML (xmlNode *node)
 interprets node as a unsigned char
void saveXML (xmlNode *node) const
 subclasses are expected to provide a working implementation
void set (const std::string &str)
 saves val into node
std::string get () const
 return current value as a string
virtual long toLong () const
 return current value as an (long) integer (throws std::runtime_error exception if incompatable, e.g. dictionary or array to value type)
virtual double toDouble () const
 return current value as a double (throws std::runtime_error exception if incompatable, e.g. dictionary or array to value type)
virtual Primitive< unsigned
char > * 
clone () const __attribute__((warn_unused_result))
 clone definition for Primitive<unsigned char>
const unsigned char & getPreviousValue () const
 returns the previously assigned value

Protected Attributes

unsigned char val
 data storage
unsigned char prevVal
 following each assignment, this is the "old" value -- very handy for PrimitiveListeners
bool numeric
 if true, requests that saves store the numeric value instead of corresponding character

Classes

struct  conversion_policy

Constructor & Destructor Documentation

plist::Primitive< unsigned char >::Primitive (  )  [inline]

constructor

Definition at line 276 of file plistPrimitives.h.

plist::Primitive< unsigned char >::Primitive ( const unsigned char &  v,
bool  isNum = false 
) [inline]

casting constructor

Definition at line 277 of file plistPrimitives.h.


Member Function Documentation

Primitive& plist::Primitive< unsigned char >::operator= ( unsigned char  v  )  [inline]

assignment

Definition at line 278 of file plistPrimitives.h.

virtual Primitive& plist::Primitive< unsigned char >::operator= ( const PrimitiveBase pb  )  [inline, virtual]

assignment (don't assign listeners); doesn't trigger fireValueChanged, subclass should do that from its own operator=() following assignment

Reimplemented from plist::PrimitiveBase.

Definition at line 279 of file plistPrimitives.h.

Primitive& plist::Primitive< unsigned char >::operator= ( const Primitive< unsigned char > &  p  )  [inline]

assignment from primitive of the same type (just assign value)

Definition at line 281 of file plistPrimitives.h.

Primitive& plist::Primitive< unsigned char >::operator+= ( unsigned char  v  )  [inline]

add-assign

Definition at line 282 of file plistPrimitives.h.

Primitive& plist::Primitive< unsigned char >::operator-= ( unsigned char  v  )  [inline]

subtract-assign

Definition at line 283 of file plistPrimitives.h.

Primitive& plist::Primitive< unsigned char >::operator *= ( unsigned char  v  )  [inline]

multiple-assign

Definition at line 284 of file plistPrimitives.h.

Primitive& plist::Primitive< unsigned char >::operator/= ( unsigned char  v  )  [inline]

divide-assign

Definition at line 285 of file plistPrimitives.h.

const unsigned char& plist::Primitive< unsigned char >::operator * (  )  const [inline]

dereference will return data storage

Definition at line 287 of file plistPrimitives.h.

const unsigned char* plist::Primitive< unsigned char >::operator-> (  )  const [inline]

can use -> to access members of data storage

Definition at line 289 of file plistPrimitives.h.

plist::Primitive< unsigned char >::operator unsigned char (  )  const [inline]

casting operator

Definition at line 290 of file plistPrimitives.h.

void plist::Primitive< unsigned char >::setNumeric ( bool  isNum  )  [inline]

sets numeric

Definition at line 292 of file plistPrimitives.h.

bool plist::Primitive< unsigned char >::getNumeric (  )  const [inline]

returns numeric

Definition at line 293 of file plistPrimitives.h.

void plist::Primitive< unsigned char >::loadXML ( xmlNode node  )  [virtual]

interprets node as a unsigned char

Reimplemented from plist::ObjectBase.

Definition at line 135 of file plistPrimitives.cc.

void plist::Primitive< unsigned char >::saveXML ( xmlNode node  )  const [virtual]

subclasses are expected to provide a working implementation

Implements plist::ObjectBase.

Definition at line 170 of file plistPrimitives.cc.

void plist::Primitive< unsigned char >::set ( const std::string &  str  )  [virtual]

saves val into node

Implements plist::PrimitiveBase.

Definition at line 184 of file plistPrimitives.cc.

std::string plist::Primitive< unsigned char >::get (  )  const [inline, virtual]

return current value as a string

Implements plist::PrimitiveBase.

Definition at line 299 of file plistPrimitives.h.

virtual long plist::Primitive< unsigned char >::toLong (  )  const [inline, virtual]

return current value as an (long) integer (throws std::runtime_error exception if incompatable, e.g. dictionary or array to value type)

Implements plist::ObjectBase.

Definition at line 307 of file plistPrimitives.h.

virtual double plist::Primitive< unsigned char >::toDouble (  )  const [inline, virtual]

return current value as a double (throws std::runtime_error exception if incompatable, e.g. dictionary or array to value type)

Implements plist::ObjectBase.

Definition at line 308 of file plistPrimitives.h.

Primitive< unsigned char > * plist::Primitive< unsigned char >::clone (  )  const [virtual]

clone definition for Primitive<unsigned char>

implements the clone function for Primitive<unsigned char>

Implements plist::ObjectBase.

Definition at line 204 of file plistPrimitives.cc.

const unsigned char& plist::Primitive< unsigned char >::getPreviousValue (  )  const [inline]

returns the previously assigned value

Definition at line 313 of file plistPrimitives.h.


Member Data Documentation

unsigned char plist::Primitive< unsigned char >::val [protected]

data storage

Definition at line 316 of file plistPrimitives.h.

unsigned char plist::Primitive< unsigned char >::prevVal [protected]

following each assignment, this is the "old" value -- very handy for PrimitiveListeners

Definition at line 317 of file plistPrimitives.h.

bool plist::Primitive< unsigned char >::numeric [protected]

if true, requests that saves store the numeric value instead of corresponding character

Definition at line 318 of file plistPrimitives.h.


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:57 2007 by Doxygen 1.5.4