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

A class that represents a string of reference qualifiers which name an object, value, or function. More...

#include <omScriptingMirReference.h>

Inheritance diagram for om::scripting::mir::lang::Reference:
om::scripting::mir::lang::ASTNode

Public Member Functions

 Reference ()
 Create a new reference object that is not specified relative to the 'this' pointer. More...
 
 Reference (Bool newIsThisRelative)
 Create a new reference object with the specified this-relative type. More...
 
Size getQualifierCount () const
 Return the number of qualifiers that the reference has. More...
 
ReferenceQualifiergetQualifier (Index qualifierIndex)
 Return a pointer to the reference qualifier at the specified index in this reference's qualifier list. More...
 
const ReferenceQualifiergetQualifier (Index qualifierIndex) const
 Return a pointer to the reference qualifier at the specified index in this reference's qualifier list. More...
 
Bool addQualifier (const Shared< Identifier > &newName, const Shared< TemplateInstantiation > &newTemplate)
 Add a new qualifier to the end of this reference's qualifier list. More...
 
Bool addQualifier (const Shared< Identifier > &newName)
 Add a new qualifier to the end of this reference's qualifier list. More...
 
Bool addQualifier (const ReferenceQualifier &newQualifier)
 Add a new qualifier to the end of this reference's qualifier list. More...
 
Bool getIsThisRelative () const
 Return whether or not this reference starts with a 'this' qualifier. More...
 
const Shared< Declaration > & getDeclaration () const
 Return a pointer to this reference's declaration, or NULL if there is no declaration. More...
 
Bool hasDeclaration () const
 Return whether or not this reference has an associated declaration. 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< Referenceconstruct ()
 Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments. More...
 
static Shared< Referenceconstruct (Bool newIsThisRelative)
 Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments. More...
 

Detailed Description

A class that represents a string of reference qualifiers which name an object, value, or function.

Constructor & Destructor Documentation

om::scripting::mir::lang::Reference::Reference ( )
inline

Create a new reference object that is not specified relative to the 'this' pointer.

om::scripting::mir::lang::Reference::Reference ( Bool  newIsThisRelative)
inline

Create a new reference object with the specified this-relative type.

Member Function Documentation

Size om::scripting::mir::lang::Reference::getQualifierCount ( ) const
inline

Return the number of qualifiers that the reference has.

ReferenceQualifier& om::scripting::mir::lang::Reference::getQualifier ( Index  qualifierIndex)
inline

Return a pointer to the reference qualifier at the specified index in this reference's qualifier list.

const ReferenceQualifier& om::scripting::mir::lang::Reference::getQualifier ( Index  qualifierIndex) const
inline

Return a pointer to the reference qualifier at the specified index in this reference's qualifier list.

Bool om::scripting::mir::lang::Reference::addQualifier ( const Shared< Identifier > &  newName,
const Shared< TemplateInstantiation > &  newTemplate 
)
inline

Add a new qualifier to the end of this reference's qualifier list.

Bool om::scripting::mir::lang::Reference::addQualifier ( const Shared< Identifier > &  newName)
inline

Add a new qualifier to the end of this reference's qualifier list.

Bool om::scripting::mir::lang::Reference::addQualifier ( const ReferenceQualifier newQualifier)
inline

Add a new qualifier to the end of this reference's qualifier list.

Bool om::scripting::mir::lang::Reference::getIsThisRelative ( ) const
inline

Return whether or not this reference starts with a 'this' qualifier.

const Shared<Declaration>& om::scripting::mir::lang::Reference::getDeclaration ( ) const
inline

Return a pointer to this reference's declaration, or NULL if there is no declaration.

Bool om::scripting::mir::lang::Reference::hasDeclaration ( ) const
inline

Return whether or not this reference has an associated declaration.

static Shared<Reference> om::scripting::mir::lang::Reference::construct ( )
inlinestatic

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

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