MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
Mezzanine::Scripting::ScriptArgumentGeneric< String > Class Template Reference

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

#include <scriptargument.h>

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

Public Types

typedef String Type
 To make working with this easier.
 

Public Member Functions

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

String Datum
 The String data.
 

Detailed Description

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

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

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

Definition at line 364 of file scriptargument.h.

Constructor & Destructor Documentation

Create an initialized Argument.

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

Definition at line 377 of file scriptargument.h.

Member Function Documentation

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

Get the String as a Bool.

Returns
The argument value lexographically converted as an Bool

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 407 of file scriptargument.h.

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

Get the String as a Integer.

Returns
The String value lexographically converted as an Integer

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 397 of file scriptargument.h.

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

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

Get the String as a Real.

Returns
The String value lexographically converted as an Real

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 402 of file scriptargument.h.

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

Get the String.

Returns
The String

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 387 of file scriptargument.h.

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

Get data about this being a String.

Returns
This will return an Integer containing GenericString.

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 427 of file scriptargument.h.

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

Get the raw primitive to value.

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

Definition at line 422 of file scriptargument.h.

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

Get the String as a Whole.

Returns
The String value lexographically converted as a Whole

Implements Mezzanine::Scripting::iScriptArgument.

Definition at line 392 of file scriptargument.h.

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

Is this value representing a Null/Nil value.

Returns
In most languages "" is a valid value for Strings, 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 412 of file scriptargument.h.

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

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

Parameters
NewValueThe new value for this.

Definition at line 417 of file scriptargument.h.


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