home
 
 index of namespace default
 
 index of project core
 
 index of module core

Class core.Boolean


SynopsisA number object that wraps a boolean 1bit integer value.

  Base classes:
  Methods: See also:  


Method getString
Return a string representation of this number object.
Signature
getString():String
Returns
Stringa new String instance holding a string representation of this number object

 
 top of page
Method getValue
Return the current value.
Signature
getValue():boolean
Returns
booleanCurrent value
See also:  


 
 top of page
Method New
Create a new Boolean object and initialize it with the given value.
Signature
New(booleanv)
 :Boolean
Arguments
booleanvThe value to assign the new object
Returns
Booleannew Boolean object

 
 top of page
Method News
Create a new Boolean object and initialize it with the given String.
Signature
News(Strings)
 :Boolean
Arguments
Strings
Returns
Booleannew Boolean object
Description

The String will be converted to an integer number before assignment.
The strings "true","1" and "false","0" will map to 1 resp. 0.

 
 top of page
Method operator !=
Check whether the given value does not equal this value
Signature
operator !=(booleanv)
 :boolean
Arguments
booleanvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator &
Calculate reminder of this divided by the given value
Signature
operator &(booleanv)
 :Boolean
Arguments
booleanvDividend
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator &
Bitwise AND
Signature
operator &(booleanv)
 :Boolean
Arguments
booleanvRight-hand side operand
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator &&
Logical AND
Signature
operator &&(booleanv)
 :boolean
Arguments
booleanvRight-hand side operand
Returns
booleanResult value

 
 top of page
Method operator >
Check whether this value is greater than the given value
Signature
operator >(booleanv)
 :boolean
Arguments
booleanvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator >>
Logical shift right
Signature
operator >>(booleanv)
 :Boolean
Arguments
booleanvHow many bits to shift right
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator >=
Check whether this value is equal to or greater than the given value
Signature
operator >=(booleanv)
 :boolean
Arguments
booleanvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator <
Check whether this value is less than the given value
Signature
operator <(booleanv)
 :boolean
Arguments
booleanvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator <<
Logical shift left
Signature
operator <<(booleanv)
 :Boolean
Arguments
booleanvHow many bits to shift left
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator <=
Check whether this value is less than the given value
Signature
operator <=(booleanv)
 :boolean
Arguments
booleanvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator *
Multiply by the given value
Signature
operator *(booleanv)
 :Boolean
Arguments
booleanvFactor
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator +
Add the given value
Signature
operator +(booleanv)
 :Boolean
Arguments
booleanvAddend
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator -
Subtract the given value
Signature
operator -(booleanv)
 :Boolean
Arguments
booleanvMinuend
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator /
Divide by the given value
Signature
operator /(booleanv)
 :Boolean
Arguments
booleanvDividend
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator ==
Compare to the given value
Signature
operator ==(booleanv)
 :boolean
Arguments
booleanvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator unary!
Logical not
Signature
operator unary!():Boolean
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator unary~
Bitwise not
Signature
operator unary~():Boolean
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator ^
Bitwise EOR/XOR (exclusive or)
Signature
operator ^(booleanv)
 :Boolean
Arguments
booleanvRight-hand side operand
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator ^^
Logical EOR/XOR (exclusive OR)
Signature
operator ^^(booleanv)
 :boolean
Arguments
booleanvRight-hand side operand
Returns
booleanResult value

 
 top of page
Method operator |
Bitwise OR
Signature
operator |(booleanv)
 :Boolean
Arguments
booleanvRight-hand side operand
Returns
Booleannew Boolean object holding the result

 
 top of page
Method operator ||
Logical OR
Signature
operator ||(booleanv)
 :boolean
Arguments
booleanvRight-hand side operand
Returns
booleanResult value

 
 top of page
Method setValue
Set a new value.
Signature
setValue(booleanv)
Arguments
booleanvThe new value
See also:  


 
 top of page
 

Project Modules:core 
Project Classes:Boolean , Buffer , Byte , Class , ClassArray , Condition , Configuration , Double , DummyStream , Envelope , Event , Exception , File , Float , FloatArray , FloatArray128 , FloatArray16 , FloatArray32 , FloatArray64 , FloatArray8 , Function , HashTable , IntArray , IntArray128 , IntArray16 , IntArray32 , IntArray64 , IntArray8 , Integer , List , ListNode , Long , Mailbox , Mutex , Object , ObjectArray , PakFile , PointerArray , Pool , Script , SharedBuffer , Short , Stack , StdErrStream , StdInStream , StdOutStream , Stream , String , String128 , String16 , String32 , String64 , String8 , StringArray , StringIterator , Thread , Time , TKS , TreeNode , UnsignedByte , UnsignedInteger , UnsignedLong , UnsignedShort , Value , ValueArray , Variable 
Project Functions:ceil , exit , floor , GetCurrentThread , getenv , lcchar , mathAbsMaxf , mathAbsMinf , mathAbsMini , mathAbsMini , mathClampf , mathClampi , mathDistancePointPlane2d , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathPowerf , mathPoweri , mathSmoothStepf , mathWrapf , mathWrapi , milliSeconds , psystem , putenv , srand , system , ucchar 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 


auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54