project_identifier_subset Class Reference
#include <identifi_sub.h>
Public Types | |
| typedef void(* | usage_t )(void) |
Public Member Functions | |
| virtual | ~project_identifier_subset () |
| project_identifier_subset () | |
| virtual void | command_line_parse (usage_t)=0 |
| virtual void | command_line_check (usage_t)=0 |
| virtual project_ty * | get_pp ()=0 |
| virtual user_ty::pointer | get_up ()=0 |
| virtual void | set_user_by_name (nstring &login)=0 |
| virtual void | parse_change_with_branch (long &change_number, usage_t usage)=0 |
| virtual void | parse_change_with_branch (long &change_number, const char *&branch_arg, usage_t usage)=0 |
| virtual bool | set () const =0 |
Private Member Functions | |
| project_identifier_subset (const project_identifier_subset &) | |
| project_identifier_subset & | operator= (const project_identifier_subset &) |
Detailed Description
The project_identifier_subset class is used to represent the project identified by command line options.Definition at line 32 of file identifi_sub.h.
Member Typedef Documentation
| typedef void(* project_identifier_subset::usage_t)(void) |
Constructor & Destructor Documentation
| virtual project_identifier_subset::~project_identifier_subset | ( | ) | [virtual] |
The destructor.
| project_identifier_subset::project_identifier_subset | ( | ) |
The default constructor.
| project_identifier_subset::project_identifier_subset | ( | const project_identifier_subset & | ) | [private] |
The copy constructor. Do not use.
Member Function Documentation
| virtual void project_identifier_subset::command_line_parse | ( | usage_t | ) | [pure virtual] |
The command_line_parse method is used to parse command line options (via the arglex() fucntion) to set the change ID. The current token is expected to be meaningful for identifying a change. The position will be advanced past all relevant tokens.
It understands all of the following command line options: [ -Project ] string
| virtual void project_identifier_subset::command_line_check | ( | usage_t | ) | [pure virtual] |
The command_line_check method is used to verify that sensable command line options have been specified, once the parse has completed.
| virtual project_ty* project_identifier_subset::get_pp | ( | ) | [pure virtual] |
The get_pp method is used to get the project pointer for the change identified.
Implemented in project_identifier_subset_branch, and project_identifier_subset_plain.
| virtual user_ty::pointer project_identifier_subset::get_up | ( | ) | [pure virtual] |
The get_up method is used to get the user pointer for the change identified.
Implemented in project_identifier_subset_branch, and project_identifier_subset_plain.
| virtual void project_identifier_subset::set_user_by_name | ( | nstring & | login | ) | [pure virtual] |
The set_user_by_name method is used to set the user name by name. This is useful for the small set of command which accept a user name on the command line.
- Parameters:
-
login The login name of the user.
Implemented in project_identifier_subset_branch, and project_identifier_subset_plain.
| virtual void project_identifier_subset::parse_change_with_branch | ( | long & | change_number, | |
| usage_t | usage | |||
| ) | [pure virtual] |
The parse_change_with_branch method is used to parse the --change command line option, which may be in a number of forms.
This method should only be called from the change_identifier_subset::command_line_parse method.
| virtual void project_identifier_subset::parse_change_with_branch | ( | long & | change_number, | |
| const char *& | branch_arg, | |||
| usage_t | usage | |||
| ) | [pure virtual] |
The parse_change_with_branch method is used to parse the --change command line option, when it could be given a 1.2.C345 style number.
This method should only be called from the change_identifier_subset::command_line_parse method.
| virtual bool project_identifier_subset::set | ( | ) | const [pure virtual] |
The set method may be used to determine whether or not the project name has been set yet (either indirectly or directly). If you test this early enough, you will know if the project name was specified on the command line.
Implemented in project_identifier_subset_branch, and project_identifier_subset_plain.
| project_identifier_subset& project_identifier_subset::operator= | ( | const project_identifier_subset & | ) | [private] |
The assignment operator. Do not use.
The documentation for this class was generated from the following file:
- libaegis/project/identifi_sub.h
