Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Member Functions | List of all members
om::scripting::mir::lang::ReturnStatement Class Reference

A class that represents a statement that returns from a function. More...

#include <omScriptingMirStatements.h>

Inheritance diagram for om::scripting::mir::lang::ReturnStatement:
om::scripting::mir::lang::Statement om::scripting::mir::lang::ASTNode

Public Member Functions

 ReturnStatement (const Shared< Expression > &newValue)
 Create a new return statement with the specified return value expression. More...
 
const Shared< Expression > & getValue () const
 Return an optionally NULL pointer to the expression whose value is returned. More...
 
void setValue (const Shared< Expression > &newValue)
 Set an optionally NULL pointer to the expression whose value is returned. More...
 
- Public Member Functions inherited from om::scripting::mir::lang::Statement
 Statement (Type newType)
 Create a new statement with the specified statement type enum value. More...
 
Type getType () const
 Return the type of this statement. More...
 
- Public Member Functions inherited from om::scripting::mir::lang::ASTNode
 ASTNode ()
 Create a new AST node with no node position specified. More...
 
 ASTNode (const Position &newPosition)
 Create a new AST node which corresponds to a token starting at the specified source code position. More...
 
virtual ~ASTNode ()
 Destroy this AST node object. More...
 
const PositiongetPosition () const
 Return an object representing the position of this AST node in the source code. More...
 
void setPosition (const Position &newPosition)
 Set the position of this AST node in the source code. More...
 

Static Public Member Functions

static Shared< ReturnStatementconstruct (const Shared< Expression > &newValue)
 Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments. More...
 
- Static Public Member Functions inherited from om::scripting::mir::lang::Statement
static Shared< Statementconstruct (Type newType)
 Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments. More...
 

Additional Inherited Members

- Public Types inherited from om::scripting::mir::lang::Statement
enum  Type {
  BLOCK, IF, WHILE, FOR,
  SWITCH, EXPRESSION, RETURN, BREAK,
  CONTINUE, THROW, TRY_CATCH
}
 An enum that specifies the different types of statements. More...
 

Detailed Description

A class that represents a statement that returns from a function.

Constructor & Destructor Documentation

om::scripting::mir::lang::ReturnStatement::ReturnStatement ( const Shared< Expression > &  newValue)
inline

Create a new return statement with the specified return value expression.

Member Function Documentation

const Shared<Expression>& om::scripting::mir::lang::ReturnStatement::getValue ( ) const
inline

Return an optionally NULL pointer to the expression whose value is returned.

void om::scripting::mir::lang::ReturnStatement::setValue ( const Shared< Expression > &  newValue)
inline

Set an optionally NULL pointer to the expression whose value is returned.

static Shared<ReturnStatement> om::scripting::mir::lang::ReturnStatement::construct ( const Shared< Expression > &  newValue)
inlinestatic

Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments.


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