ContRap-Core
Public Types | Public Member Functions | Protected Attributes

crp::Statement Class Reference

Class Statement represents system commands, which should not be overloaded by the user. More...

#include <command.h>

Inheritance diagram for crp::Statement:
crp::ArgCommand crp::Command crp::Object

Public Types

enum  StatementType {
  ERROR, ABORT, BREAK, RETURN,
  INCLUDE, EXTENDS, TYPE, QUIT,
  UNLOAD, CLEAR, HELP
}
 

Enumerates system commands.

More...

Public Member Functions

 Statement (StatementType type, const DPtr &argument=DPtr::bottom)
 Class constructor.
virtual ~Statement ()
 Virtual destructor.
virtual StatementType get_statement_type () const
 Returns the enumerated type of the statement.
virtual CommandType get_command_type () const
 Returns the enumerated type of the command.
virtual std::string to_string () const
 Converts the object to a non-formatted string.

Protected Attributes

StatementType type
 Statement type.

Detailed Description

Class Statement represents system commands, which should not be overloaded by the user.


Member Enumeration Documentation

Enumerates system commands.

Enumerator:
ERROR 
ABORT 
BREAK 
RETURN 
INCLUDE 
EXTENDS 
TYPE 
QUIT 
UNLOAD 
CLEAR 
HELP 

Constructor & Destructor Documentation

crp::Statement::Statement ( StatementType  type,
const DPtr argument = DPtr::bottom 
)

Class constructor.

Parameters:
typeType of the statement
firstFirst argument of the statement
virtual crp::Statement::~Statement ( ) [inline, virtual]

Virtual destructor.


Member Function Documentation

virtual CommandType crp::Statement::get_command_type ( ) const [inline, virtual]

Returns the enumerated type of the command.

Returns:
Type of the object

Implements crp::Command.

virtual StatementType crp::Statement::get_statement_type ( ) const [inline, virtual]

Returns the enumerated type of the statement.

Returns:
Type of the object
virtual std::string crp::Statement::to_string ( ) const [virtual]

Converts the object to a non-formatted string.

This method is thought to be used for debugging purposes only.

Returns:
String representation of the object

Reimplemented from crp::Command.


Field Documentation

Statement type.


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