Scopira 20080306

scopira::core::project_i Class Reference

#include <project.h>

Inheritance diagram for scopira::core::project_i:
scopira::core::model_i scopira::tool::object scopira::core::project_base

List of all members.

Public Types

typedef
scopira::core::model_iterator 
model_iterator
 the model iterator type

Public Member Functions

virtual bool is_project (void) const
 I AM a project!
virtual void add_model (model_i *parent, model_i *rec)=0
virtual void remove_model (model_i *parent, model_i *rec)=0
virtual bool contains_model (model_i *parent, model_i *rec)=0
virtual bool contains_model (model_i *rec)=0
virtual model_iget_parent (model_i *child)=0
virtual model_ifind_model (model_i *parent, const std::string &title) const =0
virtual model_iterator get_model_iterator (model_i *parent) const =0
 gets a listing of all the sub models
virtual bool is_project_empty (void) const =0
virtual void clear_project (void)=0
virtual void move_project (scopira::core::project_i *rhs)=0
virtual bool get_tagged_model_from_project (model_i *parent, const std::string &name, scopira::tool::count_ptr< scopira::core::model_i > &out)=0
 used by model_i

Protected Member Functions

 project_i (void)
 Default initing ctor.
 project_i (const std::string &title)
 title initing ctor

Detailed Description

The project interface.

a project houses a collection of one or more models, and other information.

Author:
Aleksander Demko

Member Function Documentation

virtual void scopira::core::project_i::add_model ( model_i parent,
model_i rec 
) [pure virtual]

Adds a model. null parent == root node

Author:
Aleksander Demko

Implemented in scopira::core::project_base.

virtual void scopira::core::project_i::clear_project ( void  ) [pure virtual]

Clears or resets the project to empty state.

Author:
Aleksander Demko

Implemented in scopira::core::project_base.

virtual bool scopira::core::project_i::contains_model ( model_i parent,
model_i rec 
) [pure virtual]

Does this group have the given model? null parent == root node

Author:
Aleksander Demko

Implemented in scopira::core::project_base.

virtual bool scopira::core::project_i::contains_model ( model_i rec) [pure virtual]

Does the group have this model anywhere, regarless of root.

Author:
Aleksander Demko

Implemented in scopira::core::project_base.

virtual model_i* scopira::core::project_i::find_model ( model_i parent,
const std::string &  title 
) const [pure virtual]

Finds a model by name. There may be many of them -- this finds the "first" one. Returns 0 if none was found.

Author:
Aleksander Demko

Implemented in scopira::core::project_base.

virtual model_i* scopira::core::project_i::get_parent ( model_i child) [pure virtual]

Gets the parent model of a given model. May be null (for root).

Author:
Aleksander Demko

Implemented in scopira::core::project_base.

virtual bool scopira::core::project_i::is_project_empty ( void  ) const [pure virtual]

Is the project "empty?"

Author:
Aleksander Demko

Implemented in scopira::core::project_base.

virtual void scopira::core::project_i::move_project ( scopira::core::project_i rhs) [pure virtual]

Move a project's contents into this one.

Author:
Aleksander Demko

Implemented in scopira::core::project_base.

virtual void scopira::core::project_i::remove_model ( model_i parent,
model_i rec 
) [pure virtual]

Removes the given model null parent == root node

Author:
Aleksander Demko

Implemented in scopira::core::project_base.


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