Mezzanine::Scripting::ScriptArgumentGeneric< Boolean > 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< Boolean >:

Collaboration diagram for Mezzanine::Scripting::ScriptArgumentGeneric< Boolean >:

Public Types
typedef Boolean	Type
	To make working with this easier.

Public Member Functions
	ScriptArgumentGeneric (Boolean InitialValue)
	Create an initialized Argument. More...
virtual	~ScriptArgumentGeneric ()
	Overloadable Deconstructor.
virtual Boolean	GetBool () const
	Get the Bool. More...
virtual Integer	GetInteger () const
	Get the Bool as a Integer. More...
virtual ScriptArgumentGeneric < Boolean > *	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 Boolean	GetValue () const
	Get the raw primitive to value. More...
virtual Whole	GetWhole () const
	Get the Bool as a Whole. More...
virtual Boolean	IsNull () const
	Is this value representing a Null/Nil value. More...
virtual void	SetValue (Boolean 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...
IntrusiveRefCount *	GetReferenceCountTargetAsPointer ()
	Gets the actual pointer to the target. More...
Whole	IncrementReferenceCount ()
	Increase the reference count by one and return the updated count. More...

Protected Attributes
Boolean	Datum
	The Bool actual data.

Detailed Description

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

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

Mezzanine::Scripting::ScriptArgumentGeneric< Boolean >::ScriptArgumentGeneric ( Boolean  InitialValue)

inline

Create an initialized Argument.

Parameters

InitialValue

The 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 Boolean Mezzanine::Scripting::ScriptArgumentGeneric< Boolean >::GetBool ( ) 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< Boolean >::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<Boolean>* Mezzanine::Scripting::ScriptArgumentGeneric< Boolean >::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.

Definition at line 584 of file scriptargument.h.

virtual Real Mezzanine::Scripting::ScriptArgumentGeneric< Boolean >::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< Boolean >::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< Boolean >::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 Boolean Mezzanine::Scripting::ScriptArgumentGeneric< Boolean >::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< Boolean >::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 Boolean Mezzanine::Scripting::ScriptArgumentGeneric< Boolean >::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< Boolean >::SetValue ( Boolean  NewValue)

inlinevirtual

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

Parameters

NewValue

The new value for this.

Definition at line 569 of file scriptargument.h.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/Scripting/scriptargument.h