Mezzanine::Scripting::ScriptArgumentGeneric< Integer > Class Template Reference

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

#include <scriptargument.h>

Inheritance diagram for Mezzanine::Scripting::ScriptArgumentGeneric< Integer >:

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

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

Public Member Functions
	ScriptArgumentGeneric (Integer InitialValue)
	Create an initialized Argument. More...
virtual	~ScriptArgumentGeneric ()
	Overloadable Deconstructor.
virtual Boolean	GetBool () const
	Get the Integer as a Bool. More...
virtual Integer	GetInteger () const
	Get the Integer as a Integer. More...
virtual ScriptArgumentGeneric < Integer > *	GetMostDerived ()
	Get a pointer to the most Derived type of this class. More...
virtual Real	GetReal () const
	Get the Integer as a Real. More...
virtual String	GetString () const
	Get the Integer as a String. More...
virtual Integer	GetTypeData () const
	Get data about this being and Integer. More...
virtual Integer	GetValue () const
	Get the raw primitive to value. More...
virtual Whole	GetWhole () const
	Get the Integer as a Whole. More...
virtual Boolean	IsNull () const
	Is this value representing a Null/Nil value. More...
virtual void	SetValue (Integer 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
Integer	Datum
	The Integer actual data.

Detailed Description

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

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

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

Definition at line 212 of file scriptargument.h.

Constructor & Destructor Documentation

Mezzanine::Scripting::ScriptArgumentGeneric< Integer >::ScriptArgumentGeneric ( Integer  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 225 of file scriptargument.h.

Member Function Documentation

virtual Boolean Mezzanine::Scripting::ScriptArgumentGeneric< Integer >::GetBool ( ) const

inlinevirtual

Get the Integer as a Bool.

Returns

The argument value lexographically converted as an Bool

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 255 of file scriptargument.h.

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

inlinevirtual

Get the Integer as a Integer.

Returns

The Integer value lexographically converted as an Integer

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 245 of file scriptargument.h.

virtual ScriptArgumentGeneric<Integer>* Mezzanine::Scripting::ScriptArgumentGeneric< Integer >::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 280 of file scriptargument.h.

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

inlinevirtual

Get the Integer as a Real.

Returns

The Integer value lexographically converted as an Real

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 250 of file scriptargument.h.

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

inlinevirtual

Get the Integer as a String.

Returns

The Integer value lexographically converted as a String

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 235 of file scriptargument.h.

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

inlinevirtual

Get data about this being and Integer.

Returns

This will return an Integer containing GenericInteger.

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 275 of file scriptargument.h.

virtual Integer Mezzanine::Scripting::ScriptArgumentGeneric< Integer >::GetValue ( ) const

inlinevirtual

Get the raw primitive to value.

Returns

The internal value that meaningful operations can be performed on.

Definition at line 270 of file scriptargument.h.

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

inlinevirtual

Get the Integer as a Whole.

Returns

The Integer value lexographically converted as a Whole

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 240 of file scriptargument.h.

virtual Boolean Mezzanine::Scripting::ScriptArgumentGeneric< Integer >::IsNull ( ) const

inlinevirtual

Is this value representing a Null/Nil value.

Returns

In most languages 0 is a valid value for Integers, 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 260 of file scriptargument.h.

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

inlinevirtual

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

Parameters

NewValue

The new value for this.

Definition at line 265 of file scriptargument.h.

---

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

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