Spinning Topp Logo BlackTopp Studios
inc
Public Types | Public Member Functions | Protected Attributes | List of all members
Mezzanine::Scripting::ScriptArgumentGeneric< Boole > Class Template Reference

A Bool implementation of a ScriptArgument that is suitable for primitive types in most situations. More...

#include <scriptargument.h>

+ Inheritance diagram for Mezzanine::Scripting::ScriptArgumentGeneric< Boole >:
+ Collaboration diagram for Mezzanine::Scripting::ScriptArgumentGeneric< Boole >:

Public Types

typedef Boole Type
 To make working with this easier.
 

Public Member Functions

 ScriptArgumentGeneric (Boole InitialValue)
 Create an initialized Argument. More...
 
virtual ~ScriptArgumentGeneric ()
 Overloadable Deconstructor.
 
virtual Boole GetBoole () const
 Get the Bool. More...
 
virtual Integer GetInteger () const
 Get the Bool as a Integer. More...
 
virtual ScriptArgumentGeneric< Boole > * GetMostDerived ()
 Get a pointer to the most Derived type of this class. More...
 
virtual Real GetReal () const
 Get the Bool as a Integer. More...
 
virtual String GetString () const
 Get the Bool as a String. More...
 
virtual Integer GetTypeData () const
 Get data about this being a Bool. More...
 
virtual Boole GetValue () const
 Get the raw primitive to value. More...
 
virtual Whole GetWhole () const
 Get the Bool as a Whole. More...
 
virtual Boole IsNull () const
 Is this value representing a Null/Nil value. More...
 
virtual void SetValue (Boole NewValue)
 Provide an overload point to change assignment that operators will use. More...
 
- Public Member Functions inherited from Mezzanine::Scripting::iScriptArgument
virtual ~iScriptArgument ()
 Overidable Deconstructor.
 
- Public Member Functions inherited from Mezzanine::IntrusiveRefCount
 IntrusiveRefCount ()
 Constructor for instatiating the Reference Count.
 
virtual ~IntrusiveRefCount ()
 Virtual Deconstructor to prevent issues with deletion with incomplete type information.
 
Whole DecrementReferenceCount ()
 Decrease the reference count by one and return the updated count. More...
 
Whole GetReferenceCount () const
 Get the current amount of references. More...
 
IntrusiveRefCountGetReferenceCountTargetAsPointer ()
 Gets the actual pointer to the target. More...
 
Whole IncrementReferenceCount ()
 Increase the reference count by one and return the updated count. More...
 

Protected Attributes

Boole Datum
 The Bool actual data.
 

Detailed Description

template<>
class Mezzanine::Scripting::ScriptArgumentGeneric< Boole >

A Bool implementation of a ScriptArgument that is suitable for primitive types in most situations.

Scripting Languages that require algorithms specific to boolean values should add required functionality to a type derived from this.

Definition at line 516 of file scriptargument.h.

Constructor & Destructor Documentation

Create an initialized Argument.

Parameters
InitialValueThe value to initialize the Argument Integer value with.
Note
Intentionally not explicit, this allow for passing convertable types directly to functions.

Definition at line 529 of file scriptargument.h.

Member Function Documentation

virtual Boole Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::GetBoole ( ) const
inlinevirtual

Get the Bool.

Returns
The Bool.

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 559 of file scriptargument.h.

virtual Integer Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::GetInteger ( ) const
inlinevirtual

Get the Bool as a Integer.

Returns
The Bool value lexographically converted as an Integer

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 549 of file scriptargument.h.

virtual ScriptArgumentGeneric<Boole>* Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::GetMostDerived ( )
inlinevirtual

Get a pointer to the most Derived type of this class.

Returns
A pointer of the most derived pointing to this.

Reimplemented from Mezzanine::Scripting::iScriptArgument.

Reimplemented in Mezzanine::Scripting::Lua::Lua51BoolArgument.

Definition at line 584 of file scriptargument.h.

virtual Real Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::GetReal ( ) const
inlinevirtual

Get the Bool as a Integer.

Returns
The Bool value lexographically converted as an Integer

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 554 of file scriptargument.h.

virtual String Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::GetString ( ) const
inlinevirtual

Get the Bool as a String.

Returns
The Bool value lexographically converted as a String

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 539 of file scriptargument.h.

virtual Integer Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::GetTypeData ( ) const
inlinevirtual

Get data about this being a Bool.

Returns
This will return an Integer containing GenericBool.

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 579 of file scriptargument.h.

virtual Boole Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::GetValue ( ) const
inlinevirtual

Get the raw primitive to value.

Returns
The internal value that meaningful operations can be performed on.

Definition at line 574 of file scriptargument.h.

virtual Whole Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::GetWhole ( ) const
inlinevirtual

Get the Bool as a Whole.

Returns
The Bool value lexographically converted as a Whole

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 544 of file scriptargument.h.

virtual Boole Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::IsNull ( ) const
inlinevirtual

Is this value representing a Null/Nil value.

Returns
In most languages false is a valid value for Bools, so any value in this is assumed to not be NULL. This should be overridden if different behavior is required.

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 564 of file scriptargument.h.

virtual void Mezzanine::Scripting::ScriptArgumentGeneric< Boole >::SetValue ( Boole  NewValue)
inlinevirtual

Provide an overload point to change assignment that operators will use.

Parameters
NewValueThe new value for this.

Definition at line 569 of file scriptargument.h.


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