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

A class that represents the declaration of a class or namespace-level data field. More...

#include <omScriptingMirFields.h>

Inheritance diagram for om::scripting::mir::lang::FieldDeclaration:
om::scripting::mir::lang::Declaration om::scripting::mir::lang::ASTNode

Public Member Functions

 FieldDeclaration (Visibility newVisibility, Bool newIsStatic, const Shared< lang::Type > &newType, const Shared< Identifier > &newName)
 Create a new field declaration object with the specified visibility, type, and name. More...
 
const Shared< lang::Type > & getType () const
 Return a pointer to the type of the field that is declared. More...
 
const Shared< Identifier > & getName () const
 Return a pointer to an identifier representing the name of this field. More...
 
Visibility getVisibility () const
 Return an object representing the visibility type of this field declaration. More...
 
void setVisibility (Visibility newVisibility)
 Set the visibility of this field declaration to the specified type. More...
 
Bool getIsStatic () const
 Return whether or not this field is a static member of its enclosing class. More...
 
- Public Member Functions inherited from om::scripting::mir::lang::Declaration
DeclarationType getDeclarationType () const
 Return the type of this 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< FieldDeclarationconstruct (Visibility newVisibility, Bool newIsStatic, const Shared< lang::Type > &newType, const Shared< Identifier > &newName)
 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::Declaration
enum  DeclarationType {
  NAMESPACE, TYPE, ALIAS, CLASS,
  INTERFACE, FIELD, METHOD, OPERATOR,
  CONSTRUCTOR, DESTRUCTOR, VARIABLE
}
 An enum that specifies the different types of type declarations. More...
 
- Protected Member Functions inherited from om::scripting::mir::lang::Declaration
 Declaration (DeclarationType newType)
 Create a new declaration with the specified declaration type enum value. More...
 

Detailed Description

A class that represents the declaration of a class or namespace-level data field.

Constructor & Destructor Documentation

om::scripting::mir::lang::FieldDeclaration::FieldDeclaration ( Visibility  newVisibility,
Bool  newIsStatic,
const Shared< lang::Type > &  newType,
const Shared< Identifier > &  newName 
)
inline

Create a new field declaration object with the specified visibility, type, and name.

Member Function Documentation

const Shared<lang::Type>& om::scripting::mir::lang::FieldDeclaration::getType ( ) const
inline

Return a pointer to the type of the field that is declared.

const Shared<Identifier>& om::scripting::mir::lang::FieldDeclaration::getName ( ) const
inline

Return a pointer to an identifier representing the name of this field.

Visibility om::scripting::mir::lang::FieldDeclaration::getVisibility ( ) const
inline

Return an object representing the visibility type of this field declaration.

void om::scripting::mir::lang::FieldDeclaration::setVisibility ( Visibility  newVisibility)
inline

Set the visibility of this field declaration to the specified type.

Bool om::scripting::mir::lang::FieldDeclaration::getIsStatic ( ) const
inline

Return whether or not this field is a static member of its enclosing class.

static Shared<FieldDeclaration> om::scripting::mir::lang::FieldDeclaration::construct ( Visibility  newVisibility,
Bool  newIsStatic,
const Shared< lang::Type > &  newType,
const Shared< Identifier > &  newName 
)
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: