All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SPAga Class ATTRIB_GEN_NAME

SPAbase.ACIS_OBJECT
  |
  +---SPAkern.ENTITY
    |
    +---SPAkern.ATTRIB
      |
      +---SPAga.ATTRIB_GENERIC
        |
        +---ATTRIB_GEN_NAME

Usage: you can derive this class.

public class ATTRIB_GEN_NAME

Defines a named attribute for the Generic Attributes Component.

Constructor and Destructor Index

o ATTRIB_GEN_NAME(): C++ allocation constructor requests memory for this object but does not populate it.
o ATTRIB_GEN_NAME(ENTITY*,char const*,split_action,merge_action,trans_action,copy_action): C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.

Method Index

o copy_owner(ENTITY*): Specifies the copy's owner.
o copyable(): Returns TRUE when the attribute will be copied with the copy scan mechanism.
o do_transform(SPAtransf const&,ENTITY_LIST&): Transforms the entity owned by this attribute in response to the trans_owner method.
o id(): Returns the attribute class identification.
o isa(int): Determines if the attribute class is the specified type.
o merge_owner(ENTITY*,logical): Notifies the ATTRIB_GEN_NAME that its owning ENTITY is about to be merged with given entity.
o name(): Gets the attribute name.
o pattern_compatible(): Returns TRUE if this is pattern compatible.
o set_name(char const*): Changes the name assigned to this attribute.
o split_owner(ENTITY*): Notifies the ATTRIB_GEN_NAME that its owner is about to be split into two parts.
o trans_owner_list(SPAtransf const&,ENTITY_LIST&): Notifies the ATTRIB_GEN_NAME that its owner is about to be transformed.

o Name: Name assigned to this attribute.

Constructor and Destructor

o ATTRIB_GEN_NAME

public ATTRIB_GEN_NAME(

)

C++ allocation constructor requests memory for this object but does not populate it.

Role: The allocation constructor is used primarily by restore.

o ATTRIB_GEN_NAME

public ATTRIB_GEN_NAME(	ENTITY*	`owner`,
	char const*	`name`,
	split_action	`spl_act`	`= SplitKeep`,
	merge_action	`mer_act`	`= MergeKeepKept`,
	trans_action	`tran_act`	`= TransIgnore`,
	copy_action	`cop_act`	`= CopyCopy` )

C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.

Parameters:

owner: owning entity.
name: name.
spl_act: split action.
mer_act: merge action.
tran_act: transformation action.
cop_act: copy action.

Methods

o copy_owner

public virtual void copy_owner( ENTITY* ent)

Specifies the copy's owner.

Parameters:

ent: owning entity.

o copyable

public virtual logical copyable(

)const

Returns TRUE when the attribute will be copied with the copy scan mechanism.

Role: This method returns TRUE when the copy action is CopyCopy, and FALSE in all other circumstances. There is no way to get CopyLose or CopyCustom behavior with the copy scan mechanism, so in these cases copyable() returns FALSE and sets a warning to notify the application of possibly undesired behavior.

o do_transform

protected virtual void do_transform(	SPAtransf const&	,
	ENTITY_LIST&	)

Transforms the entity owned by this attribute in response to the trans_owner method.

o id

public static int id(

)

Returns the attribute class identification.

o isa

public virtual logical isa( int t) const

Determines if the attribute class is the specified type.

Parameters:

t: type to check.

o merge_owner

public virtual void merge_owner(	ENTITY*	`ent`,
	logical	`owner`)

Notifies the ATTRIB_GEN_NAME that its owning ENTITY is about to be merged with given entity.

Role: The application has the chance to delete or otherwise modify the attribute. After the merge, this owner will be deleted if the logical deleting owner is TRUE, otherwise it will be retained and other entity will be deleted. The default action is to do nothing. This function is supplied by the application whenever it defines a new attribute, and is called when a merge occurs.

Parameters:

ent: given entity.
owner: deleting owner.

o name

public char const * name(

)

Gets the attribute name.

o pattern_compatible

public virtual logical pattern_compatible(

)const

Returns TRUE if this is pattern compatible.

o set_name

public void set_name( char const* name)

Changes the name assigned to this attribute.

Parameters:

name: name.

o split_owner

public virtual void split_owner( ENTITY* ent)

Notifies the ATTRIB_GEN_NAME that its owner is about to be split into two parts.

Role: The application has the chance to duplicate or otherwise modify the attribute. The default action is to do nothing. This function is supplied by the application whenever it defines a new attribute, and is called when a split occurs.

Parameters:

ent: new entity.

o trans_owner_list

public virtual void trans_owner_list(	SPAtransf const&	`trans`,
	ENTITY_LIST&	`ent_list`)

Notifies the ATTRIB_GEN_NAME that its owner is about to be transformed.

Role: The application has the chance to transform the attribute. The default action is to do nothing. This function is supplied by the application whenever it defines a new attribute, and is called when a transformation occurs.

Parameters:

trans: transformation.
ent_list: entity list.

Data Members

o Name

  protected char *Name

Name assigned to this attribute.

This object is included in the file: at_name.hxx

SPAga Class ATTRIB_GEN_NAME

Constructor and Destructor Index

Method Index

Data Member Index

Constructor and Destructor

Methods

Data Members