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::BooleanLiteral Class Reference

A class that represents a boolean literal within the source code. More...

#include <omScriptingMirLiterals.h>

Inheritance diagram for om::scripting::mir::lang::BooleanLiteral:
om::scripting::mir::lang::Literal om::scripting::mir::lang::ASTNode

Public Member Functions

 BooleanLiteral (Bool newValue)
 Create a new boolean literal object with the specified value. More...
 
Bool operator== (const BooleanLiteral &other) const
 Return whether or not the value of this boolean literal exactly matches that of another. More...
 
Bool operator!= (const BooleanLiteral &other) const
 Return whether or not the value of this boolean literal doesn't match that of another. More...
 
 operator Bool () const
 Convert this boolean literal to a boolean value representing whether it was 'true' or 'false'. More...
 
Bool getValue () const
 Convert this boolean literal to a boolean value representing whether it was 'true' or 'false'. More...
 
- Public Member Functions inherited from om::scripting::mir::lang::Literal
Type getType () const
 Convert this visibility type to an enum value. 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< BooleanLiteralconstruct (Bool newValue)
 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::Literal
enum  Type {
  INTEGER_LITERAL, FLOAT_LITERAL, STRING_LITERAL, BOOLEAN_LITERAL,
  NULL_LITERAL
}
 An enum that specifies the different kinds of visiblity for member declarations. More...
 
- Protected Member Functions inherited from om::scripting::mir::lang::Literal
 Literal (Type newType)
 Create a new literal with the specified literal type enum value. More...
 

Detailed Description

A class that represents a boolean literal within the source code.

Constructor & Destructor Documentation

om::scripting::mir::lang::BooleanLiteral::BooleanLiteral ( Bool  newValue)
inline

Create a new boolean literal object with the specified value.

Member Function Documentation

Bool om::scripting::mir::lang::BooleanLiteral::operator== ( const BooleanLiteral other) const
inline

Return whether or not the value of this boolean literal exactly matches that of another.

Bool om::scripting::mir::lang::BooleanLiteral::operator!= ( const BooleanLiteral other) const
inline

Return whether or not the value of this boolean literal doesn't match that of another.

om::scripting::mir::lang::BooleanLiteral::operator Bool ( ) const
inline

Convert this boolean literal to a boolean value representing whether it was 'true' or 'false'.

Bool om::scripting::mir::lang::BooleanLiteral::getValue ( ) const
inline

Convert this boolean literal to a boolean value representing whether it was 'true' or 'false'.

static Shared<BooleanLiteral> om::scripting::mir::lang::BooleanLiteral::construct ( Bool  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: