change Class Reference

#include <change.h>

Public Types
typedef change *	pointer
Public Member Functions
nstring	attributes_get (const nstring &name)
bool	attributes_get_boolean (const nstring &name)
cstate_ty *	cstate_get ()
fstate_src_ty *	file_new (string_ty *fn)
fstate_src_ty *	file_new (fstate_src_ty *meta)
int	gid_get () const
bool	is_awaiting_development ()
bool	is_being_developed ()
bool	is_being_integrated ()
bool	is_completed ()
nstring	pconf_attributes_find (const nstring &name)
nstring	pconf_copyright_owner_get ()
void	project_specific_setenv_performed_set ()
bool	project_specific_setenv_performed_get () const
bool	run_project_file_command_needed ()
void	run_project_file_command (const user_ty::pointer &up)
void	run_project_file_command_done ()
void	run_new_file_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_new_file_undo_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_new_test_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_new_test_undo_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_copy_file_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_copy_file_undo_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_remove_file_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_remove_file_undo_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_make_transparent_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_make_transparent_undo_command (string_list_ty *slp, const user_ty::pointer &up)
void	run_forced_develop_begin_notify_command (const user_ty::pointer &up)
void	run_develop_end_notify_command ()
void	run_develop_end_undo_notify_command ()
void	run_review_begin_notify_command ()
void	run_review_begin_undo_notify_command ()
void	run_review_pass_notify_command ()
void	run_review_pass_undo_notify_command ()
void	run_review_fail_notify_command ()
void	run_integrate_pass_notify_command ()
void	run_integrate_fail_notify_command ()
time_t	time_limit_get ()
nstring	uuid_get ()
void	uuid_get_list (nstring_list &uuids)
user_ty::pointer	developer_user_get ()
Data Fields
long	reference_count
project_ty *	pp
long	number
cstate_ty *	cstate_data
string_ty *	cstate_filename
int	cstate_is_a_new_file
fstate_ty *	fstate_data
symtab_ty *	fstate_stp
symtab_ty *	fstate_uuid_stp
string_ty *	fstate_filename
fstate_ty *	pfstate_data
symtab_ty *	pfstate_stp
symtab_ty *	pfstate_uuid_stp
string_ty *	pfstate_filename
int	fstate_is_a_new_file
string_ty *	top_path_unresolved
string_ty *	top_path_resolved
string_ty *	development_directory_unresolved
string_ty *	development_directory_resolved
string_ty *	integration_directory_unresolved
string_ty *	integration_directory_resolved
string_ty *	logfile
pconf_ty *	pconf_data
long	lock_magic
int	bogus
string_ty *	architecture_name
string_list_ty *	file_list [view_path_MAX]
bool	project_specific_setenv_performed

---

Detailed Description

Definition at line 54 of file change.h.

---

Member Typedef Documentation

typedef change* change::pointer

The pointer typedef is provided so that clients of this interface may use change::pointer everywhere they need to point at a change instance, and only this typedef needs to be edited to use a variety of smart pointer instead.

Definition at line 63 of file change.h.

---

Member Function Documentation

nstring change::attributes_get

(

const nstring &

name

)

The attributes_get method is used to obtain the value of an attribute of this change set.

Parameters:

name

The name of the attribute. Attribute names are not case sensitive.

Returns:

the string value of the attribute, or the empty string if not found.

bool change::attributes_get_boolean

(

const nstring &

name

)

The attributes_get_boolean method is used to obtain the value of an attribute of this change set, as a true/false attribute.

Parameters:

name

The name of the attribute. Attribute names are not case sensitive.

Returns:

the boolean value of the attribute, or false if the attribute is not found or is not interpretable as a boolean.

cstate_ty* change::cstate_get

(

)

The cstate_get method may be used to obtain the cstate meta-data of this change.

fstate_src_ty* change::file_new

(

string_ty *

fn

)

The file_new method is used to add a new file to a change set's file manifest. No checking is poerformed, it is up to the caller to ensure that the name is unique.

Parameters:

file_name

The name of the file to be created.

Returns:

A newly allocated file, with the name set, and everything else blank.

fstate_src_ty* change::file_new

(

fstate_src_ty *

meta

)

The file_new method is used to add a new file to a change set's file manifest. No checking is poerformed, it is up to the caller to ensure that the file name and UUID are unique. Typically this is used when adding a project file to a change set for modification or removal.

Parameters:

meta

The meta-data of the file to be created.

Returns:

A newly allocated file, with the name set, and everything else blank.

int change::gid_get

(

)

const

The gid_get method is used to obtain the Unix group id of the change owner.

bool change::is_awaiting_development

(

)

The is_awaiting_development method returns true if the given change is in the awaiting development state, and false if it is not.

bool change::is_being_developed

(

)

The is_being_developed method returns true if the given change is in the being developed state, and false if it is not.

bool change::is_being_integrated

(

)

The is_being_integrated method is used to determine whether or not this is in the being integrated state.

Returns:

bool; true if this is in the being integrated state, and false if it is not.

bool change::is_completed

(

)

The change_is_completed function returns true (non-zero) if this change is in the completed state, and false (zero) if it is not.

nstring change::pconf_attributes_find

(

const nstring &

name

)

The pconf_attributes_get method is used to obtain the value of an attribute of the project, from the project configuration file. It could be in this change, or it could be in a baseline or an ancestor baseline.

Parameters:

name

The name of the attribute. Attribute names are not case sensitive.

Returns:

the string value of the attribute, or the empty string if not found.

nstring change::pconf_copyright_owner_get

(

)

The pconf_copyright_owner_get method is used to obtain the name of the copyright holder of a project.

void change::project_specific_setenv_performed_set

(

)

The project_specific_setenv_performed_set method is used to remember if the environment variable(s), specified as project_specific attributes, has been already exported.

Returns:

Void.

bool change::project_specific_setenv_performed_get

(

)

const

The project_specific_setenv_performed_get method is used to know if the environment variable(s), specified as project_specific attributes, has been already exported.

Returns:

True if the variables has been already exported, false otherwise.

bool change::run_project_file_command_needed

(

)

The run_project_file_command_needed method may be used to determine whether or not the project_file_command needstosed in recent integration history.

Returns:

true if need to run it (see next method), false if not.

void change::run_project_file_command

(

const user_ty::pointer &

up

)

The run_project_file_command method is used to run the command configured in the aegis.conf file's project_file_command field.

Parameters:

up

The user to run the command as.

Note:

this method MUST be called outside the change set lock

void change::run_project_file_command_done

(

)

The run_project_file_command_done method is used to remember that the project_file comman has been (is about to be) called recently.

Note:

this method MUST be called INSIDE the change set lock

void change::run_new_file_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_new_file_command method is used to run the new_file_command field of the aegis.conf file.

Parameters:

	slp	The list of new file names
	up	Th euser to run the command as.

void change::run_new_file_undo_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_new_file_undo_command method is used to run the command in the new_file_undo_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_new_test_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_new_test_command method is used to run the command in the new_test_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_new_test_undo_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_new_test_undo_command method is used to run the command in the new_test_undo_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_copy_file_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_copy_file_command method is used to run the command in the copy_file_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_copy_file_undo_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_copy_file_undo_command method is used to run the command in the copy_file_undo_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_remove_file_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_remove_file_command method is used to run the command in the remove_file_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_remove_file_undo_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_remove_file_undo_command method is used to run the command in the remove_file_undo_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_make_transparent_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_make_transparent_command method is used to run the command in the make_transparent_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_make_transparent_undo_command	(	string_list_ty *	slp,
		const user_ty::pointer &	up
	)

The run_make_transparent_undo_comman method is used to run the command in the make_transparent_undo_command field of the aegis.conf file.

Parameters:

	slp	The list of filenames affected.
	up	the user to run the program as

void change::run_forced_develop_begin_notify_command

(

const user_ty::pointer &

up

)

The run_forced_develop_begin_notify_command method is used to run the command in the forced_develop_begin_notify_command field of the aegis.conf file.

Parameters:

up

the user to run the program as

void change::run_develop_end_notify_command

(

)

The run_develop_end_notify_command method is used to run the command in the develop_end_notify_command field of the aegis.conf file.

void change::run_develop_end_undo_notify_command

(

)

The run_develop_end_undo_notify_command method is used to run the command in the develop_end_undo_notify_command field of the aegis.conf file.

void change::run_review_begin_notify_command

(

)

The run_review_begin_notify_command method is used to run the command in the review_begin_notify_command field of the aegis.conf file.

void change::run_review_begin_undo_notify_command

(

)

The run_review_begin_undo_notify_command method is used to run the command in the review_begin_undo_notify_command field of the aegis.conf file.

void change::run_review_pass_notify_command

(

)

The run_review_pass_notify_command method is used to run the command in the review_pass_notify_command field of the aegis.conf file.

void change::run_review_pass_undo_notify_command

(

)

The run_review_pass_undo_notify_command method is used to run the command in the review_pass_undo_notify_command field of the aegis.conf file.

void change::run_review_fail_notify_command

(

)

The run_review_fail_notify_command method is used to run the command in the review_fail_notify_command field of the aegis.conf file.

void change::run_integrate_pass_notify_command

(

)

The run_integrate_pass_notify_command method is used to run the command in the integrate_pass_notify_command field of the aegis.conf file.

void change::run_integrate_fail_notify_command

(

)

The run_integrate_fail_notify_command method is used to run the command in the integrate_fail_notify_command field of the aegis.conf file.

time_t change::time_limit_get

(

)

nstring change::uuid_get

(

)

The uuid_get method is used to obtain the UUID of this change set.

Returns:

The uuid of the change set, or the empty string of this change set doesn't have a UUID.

void change::uuid_get_list

(

nstring_list &

uuids

)

The uuid_get_list method is used to obtain all of the UUIDs associated with this change set. This includes the change set's UUID, if it has one, and all of the aoriginal-uuid attributes.

Parameters:

uuids

Where to put all of the UUIDs associated with this change set.

user_ty::pointer change::developer_user_get

(

)

The developer_user_get method is used to obtain a user_ty instance representing the (most recent) developer of this change set.

---

Field Documentation

long change::reference_count

Definition at line 65 of file change.h.

project_ty* change::pp

Definition at line 66 of file change.h.

long change::number

Definition at line 67 of file change.h.

cstate_ty* change::cstate_data

Definition at line 68 of file change.h.

string_ty* change::cstate_filename

Definition at line 69 of file change.h.

int change::cstate_is_a_new_file

Definition at line 70 of file change.h.

fstate_ty* change::fstate_data

Definition at line 71 of file change.h.

symtab_ty* change::fstate_stp

Definition at line 72 of file change.h.

symtab_ty* change::fstate_uuid_stp

Definition at line 73 of file change.h.

string_ty* change::fstate_filename

Definition at line 74 of file change.h.

fstate_ty* change::pfstate_data

Definition at line 75 of file change.h.

symtab_ty* change::pfstate_stp

Definition at line 76 of file change.h.

symtab_ty* change::pfstate_uuid_stp

Definition at line 77 of file change.h.

string_ty* change::pfstate_filename

Definition at line 78 of file change.h.

int change::fstate_is_a_new_file

Definition at line 79 of file change.h.

string_ty* change::top_path_unresolved

Definition at line 80 of file change.h.

string_ty* change::top_path_resolved

Definition at line 81 of file change.h.

string_ty* change::development_directory_unresolved

Definition at line 82 of file change.h.

string_ty* change::development_directory_resolved

Definition at line 83 of file change.h.

string_ty* change::integration_directory_unresolved

Definition at line 84 of file change.h.

string_ty* change::integration_directory_resolved

Definition at line 85 of file change.h.

string_ty* change::logfile

Definition at line 86 of file change.h.

pconf_ty* change::pconf_data

Definition at line 87 of file change.h.

long change::lock_magic

Definition at line 88 of file change.h.

int change::bogus

Definition at line 89 of file change.h.

string_ty* change::architecture_name

Definition at line 90 of file change.h.

string_list_ty* change::file_list[view_path_MAX]

Definition at line 91 of file change.h.

bool change::project_specific_setenv_performed

Definition at line 92 of file change.h.

---

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

• libaegis/change.h