Advanced Software Engineering
Advanced_Software_Engineering.Verbs.Flow.MethodChunk Class Reference

The method chunk class More...

Inheritance diagram for Advanced_Software_Engineering.Verbs.Flow.MethodChunk:
Advanced_Software_Engineering.Verbs.Flow.VerbChunk Advanced_Software_Engineering.IVerb Advanced_Software_Engineering.Verbs.Value.IValue Advanced_Software_Engineering.Verbs.Flow.IVerbChunk Advanced_Software_Engineering.IVerb Advanced_Software_Engineering.IVerb

Public Member Functions

 MethodChunk (ValueStorage valueStorage, DeclareVariable[] variables)
 The method chunk More...
 
List< string > GetVariableNames ()
 Gets all of the variable names More...
 
void SetVariableValues (UpdateVariable[] updateVariables)
 MUST BE CALLED. This method is really important for setting the updated values into the method's stack. More...
 
MethodChunk DuplicateForExecution ()
 This method allows the method chunk to replicate itself before being ran. Essential for recursion. More...
 
new void ExecuteVerb ()
 Executes the method chunk. More...
 
IValue GetResult ()
 Gets a result from the method. (Experimental) More...
 
IValue Clone ()
 Clones the result of the method (Experimental) More...
 
string GetOriginalType ()
 Gets the original type of the result of the method (Experimental) More...
 
bool IsInitialised ()
 Checks if the result is initilised (Experimental) More...
 
bool ToBool ()
 Converts the result to boolean (Experimental) More...
 
Color ToColor ()
 Converts the result to color (Experimental) More...
 
double ToDouble ()
 Converts the result to double (Experimental) More...
 
int ToInt ()
 Converts the result to integer (Experimental) More...
 
- Public Member Functions inherited from Advanced_Software_Engineering.Verbs.Flow.VerbChunk
 VerbChunk (List< IVerb > verbs)
 Create a new VerbChunk with verbs in it. More...
 
 VerbChunk ()
 Create an empty VerbChunk More...
 
void AddVerb (IVerb verb)
 Adds a verb to the verb list More...
 
void ExecuteVerb ()
 Executes all of the verbs in order More...
 
IVerb[] GetVerbs ()
 Returns all of the verbs stored More...
 
string GetDescription ()
 Gets a description of every verb More...
 
- Public Member Functions inherited from Advanced_Software_Engineering.Verbs.Value.IValue
string GetDescription ()
 The description of the value More...
 

Detailed Description

The method chunk class

Constructor & Destructor Documentation

◆ MethodChunk()

Advanced_Software_Engineering.Verbs.Flow.MethodChunk.MethodChunk ( ValueStorage  valueStorage,
DeclareVariable[]  variables 
)

The method chunk

Parameters
valueStorageThe ValueStorage for increasing and decreasing the stack
variablesThe variables to pass into the method

Member Function Documentation

◆ Clone()

IValue Advanced_Software_Engineering.Verbs.Flow.MethodChunk.Clone ( )

Clones the result of the method (Experimental)

Returns

Implements Advanced_Software_Engineering.Verbs.Value.IValue.

◆ DuplicateForExecution()

MethodChunk Advanced_Software_Engineering.Verbs.Flow.MethodChunk.DuplicateForExecution ( )

This method allows the method chunk to replicate itself before being ran. Essential for recursion.

Returns
A method chunk with the exact same values and verbs

◆ ExecuteVerb()

new void Advanced_Software_Engineering.Verbs.Flow.MethodChunk.ExecuteVerb ( )

Executes the method chunk.

Implements Advanced_Software_Engineering.IVerb.

◆ GetOriginalType()

string Advanced_Software_Engineering.Verbs.Flow.MethodChunk.GetOriginalType ( )

Gets the original type of the result of the method (Experimental)

Returns

Implements Advanced_Software_Engineering.Verbs.Value.IValue.

◆ GetResult()

IValue Advanced_Software_Engineering.Verbs.Flow.MethodChunk.GetResult ( )

Gets a result from the method. (Experimental)

Returns
the result

◆ GetVariableNames()

List<string> Advanced_Software_Engineering.Verbs.Flow.MethodChunk.GetVariableNames ( )

Gets all of the variable names

Returns
The names of all the variables

◆ IsInitialised()

bool Advanced_Software_Engineering.Verbs.Flow.MethodChunk.IsInitialised ( )

Checks if the result is initilised (Experimental)

Returns

Implements Advanced_Software_Engineering.Verbs.Value.IValue.

◆ SetVariableValues()

void Advanced_Software_Engineering.Verbs.Flow.MethodChunk.SetVariableValues ( UpdateVariable[]  updateVariables)

MUST BE CALLED. This method is really important for setting the updated values into the method's stack.

Parameters
updateVariablesThe new values of the method

◆ ToBool()

bool Advanced_Software_Engineering.Verbs.Flow.MethodChunk.ToBool ( )

Converts the result to boolean (Experimental)

Returns
boolean representation of the result

Implements Advanced_Software_Engineering.Verbs.Value.IValue.

◆ ToColor()

Color Advanced_Software_Engineering.Verbs.Flow.MethodChunk.ToColor ( )

Converts the result to color (Experimental)

Returns
color representation of the result

Implements Advanced_Software_Engineering.Verbs.Value.IValue.

◆ ToDouble()

double Advanced_Software_Engineering.Verbs.Flow.MethodChunk.ToDouble ( )

Converts the result to double (Experimental)

Returns
double representation of the result

Implements Advanced_Software_Engineering.Verbs.Value.IValue.

◆ ToInt()

int Advanced_Software_Engineering.Verbs.Flow.MethodChunk.ToInt ( )

Converts the result to integer (Experimental)

Returns
integer representation of the result

Implements Advanced_Software_Engineering.Verbs.Value.IValue.


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