SCL  1.0
Standard Control Library : Control, dynamics, physics, and simulation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Macros Groups Pages
Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | List of all members
scl::SObject Class Reference

#include <SObject.hpp>

Inheritance diagram for scl::SObject:
Inheritance graph
Collaboration diagram for scl::SObject:
Collaboration graph

Public Member Functions

 SObject (const std::string &arg_type)
 SObject (const char *arg_type)
virtual ~SObject ()
virtual const std::string & getType () const
virtual const std::string & getName () const
virtual bool hasBeenInit () const

Public Attributes

std::string name_
sBool has_been_init_

Protected Attributes

std::string type_

Private Member Functions

 SObject ()

Detailed Description

A generic object in the world. All database objects should inherit from this.

Constructor & Destructor Documentation

scl::SObject::SObject ( const std::string &  arg_type)

Constructor sets the type of the object. All subclasses should call this and set their type.

virtual scl::SObject::~SObject ( )

Default destructor. Does nothing.

scl::SObject::SObject ( )

Disabled default constructors

Member Function Documentation

virtual const std::string& scl::SObject::getName ( ) const

Get the object's type

virtual const std::string& scl::SObject::getType ( ) const

Get the object's type

virtual bool scl::SObject::hasBeenInit ( ) const

Get the object's type

Member Data Documentation

sBool scl::SObject::has_been_init_

Whether the object is ready for use

std::string scl::SObject::name_

The object's name

std::string scl::SObject::type_

The object's type. Should only be set by the constructor

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