QoreBoolNode Class Reference

base class for Qore's 2 boolean classes: QoreBoolTrueNode and QoreBoolFalseNode More...

#include <QoreBoolNode.h>

Inheritance diagram for QoreBoolNode:
UniqueValueQoreNode SimpleValueQoreNode SimpleQoreNode AbstractQoreNode QoreReferenceCounter QoreBoolFalseNode QoreBoolTrueNode

List of all members.

Public Member Functions

virtual DLLEXPORT QoreStringgetStringRepresentation (bool &del) const
 returns the value of the type converted to a string, default implementation: returns the empty string
virtual DLLEXPORT void getStringRepresentation (QoreString &str) const
 concatentates the value of the type to an existing QoreString reference, default implementation does nothing
virtual DLLEXPORT DateTimegetDateTimeRepresentation (bool &del) const
 returns the DateTime representation of this type (default implementation: returns ZeroDate, del = false)
virtual DLLEXPORT void getDateTimeRepresentation (DateTime &dt) const
 assigns the date representation of a value to the DateTime reference passed, default implementation does nothing
virtual DLLEXPORT int getAsString (QoreString &str, int foff, class ExceptionSink *xsink) const
 concatenate the verbose string representation of the value (including all contained values for container types) to an existing QoreString
virtual DLLEXPORT QoreStringgetAsString (bool &del, int foff, class ExceptionSink *xsink) const
 returns a QoreString giving the verbose string representation of the value (including all contained values for container types)
virtual DLLEXPORT const char * getTypeName () const
 returns the type name as a c string
virtual DLLLOCAL AbstractQoreNodeparseInit (LocalVar *oflag, int pflag, int &lvids, const QoreTypeInfo *&typeInfo)
 returns the type information

Protected Member Functions

DLLLOCAL QoreBoolNode (bool n_b)
 the constructor can only be called by a subclass

Protected Attributes

bool b
 boolean value for the object

Detailed Description

base class for Qore's 2 boolean classes: QoreBoolTrueNode and QoreBoolFalseNode

Note:
this class cannot be instantiated; use get_bool_node() to get a pointer to an object of a subclass

Member Function Documentation

virtual DLLEXPORT QoreString* QoreBoolNode::getAsString ( bool &  del,
int  foff,
class ExceptionSink xsink 
) const [virtual]

returns a QoreString giving the verbose string representation of the value (including all contained values for container types)

Used for n and N printf formatting. Do not call this function directly; use the QoreNodeAsStringHelper class (defined in QoreStringNode.h) instead

Parameters:
del if this is true when the function returns, then the returned QoreString pointer should be deleted, if false, then it must not be
foff for multi-line formatting offset, -1 = no line breaks
xsink if an error occurs, the Qore-language exception information will be added here
See also:
QoreNodeAsStringHelper

Implements AbstractQoreNode.

virtual DLLEXPORT int QoreBoolNode::getAsString ( QoreString str,
int  foff,
class ExceptionSink xsink 
) const [virtual]

concatenate the verbose string representation of the value (including all contained values for container types) to an existing QoreString

used for n and N printf formatting

Parameters:
str the string representation of the type will be concatenated to this QoreString reference
foff for multi-line formatting offset, -1 = no line breaks
xsink if an error occurs, the Qore-language exception information will be added here
Returns:
-1 for exception raised, 0 = OK

Implements AbstractQoreNode.

virtual DLLEXPORT void QoreBoolNode::getDateTimeRepresentation ( DateTime dt  )  const [virtual]

assigns the date representation of a value to the DateTime reference passed, default implementation does nothing

Parameters:
dt the DateTime reference to be assigned

Reimplemented from AbstractQoreNode.

virtual DLLEXPORT DateTime* QoreBoolNode::getDateTimeRepresentation ( bool &  del  )  const [virtual]

returns the DateTime representation of this type (default implementation: returns ZeroDate, del = false)

NOTE: Use the DateTimeValueHelper class instead of using this function directly

Parameters:
del output parameter: if del is true, then the returned DateTime pointer belongs to the caller (and must be deleted manually), if false, then it must not be
See also:
DateTimeValueHelper

Reimplemented from AbstractQoreNode.

virtual DLLEXPORT void QoreBoolNode::getStringRepresentation ( QoreString str  )  const [virtual]

concatentates the value of the type to an existing QoreString reference, default implementation does nothing

Parameters:
str a reference to a QoreString where the value of the type will be concatenated

Reimplemented from AbstractQoreNode.

virtual DLLEXPORT QoreString* QoreBoolNode::getStringRepresentation ( bool &  del  )  const [virtual]

returns the value of the type converted to a string, default implementation: returns the empty string

NOTE: do not use this function directly, use QoreStringValueHelper instead

Parameters:
del output parameter: if del is true, then the resulting QoreString pointer belongs to the caller (and must be deleted manually), if false it must not be
Returns:
a QoreString pointer, use the del output parameter to determine ownership of the pointer
See also:
QoreStringValueHelper

Reimplemented from AbstractQoreNode.

virtual DLLEXPORT const char* QoreBoolNode::getTypeName (  )  const [virtual]

returns the type name as a c string

Returns:
the type name as a c string

Implements AbstractQoreNode.


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

Generated on 14 Jun 2010 for Qore Programming Language by  doxygen 1.6.1