Aegis  4.25.D505
Public Member Functions | Private Member Functions | Private Attributes
project_identifier_subset_plain Class Reference

#include <plain.h>

Inheritance diagram for project_identifier_subset_plain:
project_identifier_subset

Public Member Functions

virtual ~project_identifier_subset_plain ()
 project_identifier_subset_plain ()
void command_line_parse (usage_t)
void command_line_check (usage_t)
projectget_pp ()
user_ty::pointer get_up ()
void set_user_by_name (nstring &login)
void parse_change_with_branch (long &change_number, usage_t usage)
void parse_change_with_branch (long &change_number, const char *&branch_arg, usage_t usage)
bool set () const

Private Member Functions

 project_identifier_subset_plain (const project_identifier_subset_plain &)
project_identifier_subset_plainoperator= (const project_identifier_subset_plain &)

Private Attributes

string_typroject_name
projectpp
user_ty::pointer up

Detailed Description

The project_identifier_subset_plain class is used to represent the project identified by the --project line option, or one of the defaulting mechanisms.

Definition at line 30 of file plain.h.


Constructor & Destructor Documentation

The destructor.

The default constructor.

The copy constructor. Do not use.


Member Function Documentation

The command_line_check method is used to verify that sensable command line options have been specified, once the parse has completed.

Implements project_identifier_subset.

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

Implements project_identifier_subset.

The get_pp method is used to get the project pointer for the change identified.

Implements project_identifier_subset.

The get_up method is used to get the user pointer for the change identified.

Implements project_identifier_subset.

project_identifier_subset_plain& project_identifier_subset_plain::operator= ( const project_identifier_subset_plain ) [private]

The assignment operator. Do not use.

void project_identifier_subset_plain::parse_change_with_branch ( long &  change_number,
usage_t  usage 
) [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.

Implements project_identifier_subset.

void project_identifier_subset_plain::parse_change_with_branch ( long &  change_number,
const char *&  branch_arg,
usage_t  usage 
) [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.

Implements project_identifier_subset.

bool project_identifier_subset_plain::set ( ) const [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.

Implements project_identifier_subset.

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:
loginThe login name of the user.

Implements project_identifier_subset.


Field Documentation

The pp instance variable is used to remember which project we are bound to.

Definition at line 80 of file plain.h.

The project_name instance variable is used to remember any --project option specified.

Definition at line 74 of file plain.h.

The up instance variable is used to remember which user we are working in behalf of.

Definition at line 86 of file plain.h.


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