Interface_Graph Class Reference

Gives basic data structure for operating and storing
graph results (usage is normally internal)
Entities are Mapped according their Number in the Model

Each Entity from the Model can be known as "Present" or
not; if it is, it is Mapped with a Status : an Integer
which can be used according to needs of each algorithm
In addition, the Graph brings a BitMap which can be used
by any caller

Also, it is bound with two lists : a list of Shared
Entities (in fact, their Numbers in the Model) which is
filled by a ShareTool, and a list of Sharing Entities,
computed by deduction from the Shared Lists

Moreover, it is possible to redefine the list of Entities
Shared by an Entity (instead of standard answer by general
service Shareds) : this new list can be empty; it can
be changed or reset (i.e. to come back to standard answer)

#include <Interface_Graph.hxx>

Public Member Functions
void *	operator new (size_t, void *anAddress)
void *	operator new (size_t size)
void	operator delete (void *anAddress)
	Interface_Graph (const Handle< Interface_InterfaceModel > &amodel, const Interface_GeneralLib &lib)
	Creates an empty graph, ready to receive Entities from amodel Note that this way of Creation allows <me> to verify that Entities to work with are contained in <amodel> Basic Shared and Sharing lists are obtained from a General Services Library, given directly as an argument
	Interface_Graph (const Handle< Interface_InterfaceModel > &amodel, const Handle< Interface_Protocol > &protocol)
	Same as above, but the Library is defined through a Protocol
	Interface_Graph (const Handle< Interface_InterfaceModel > &amodel, const Handle< Interface_GTool > &gtool)
	Same as above, but the Library is defined through a Protocol
	Interface_Graph (const Handle< Interface_InterfaceModel > &amodel)
	Same a above but works with the Protocol recorded in the Model
	Interface_Graph (const Interface_Graph &agraph, const Standard_Boolean copied=Standard_False)
	Creates a Graph from another one, getting all its data Remark that status are copied from <agraph>, but the other lists (sharing/shared) are copied only if <copied> = True
void	EvalSharings ()
	Reevaluates the Sharing Lists of the Graph, starting from the Shared Lists (priority to the redefined ones)
void	Reset ()
	Erases data, making graph ready to rebegin from void (also resets Shared lists redefinitions)
void	ResetStatus ()
	Erases Status (Values and Flags of Presence), making graph ready to rebegin from void. Does not concerns Shared lists
Standard_Integer	Size () const
	Returns size (max nb of entities, i.e. Model's nb of entities)
Standard_Integer	EntityNumber (const Handle< Standard_Transient > &ent) const
	Returns the Number of the entity in the Map, computed at creation time (Entities loaded from the Model) Returns 0 if <ent> not contained by Model used to create <me> (that is, <ent> is unknown from <me>)
Standard_Boolean	IsPresent (const Standard_Integer num) const
	Returns True if an Entity is noted as present in the graph (See methods Get... which determine this status) Returns False if <num> is out of range too
Standard_Boolean	IsPresent (const Handle< Standard_Transient > &ent) const
	Same as above but directly on an Entity <ent> : if it is not contained in the Model, returns False. Else calls IsPresent(num) with <num> given by EntityNumber
const Handle_Standard_Transient &	Entity (const Standard_Integer num) const
	Returns mapped Entity given its no (if it is present)
Standard_Integer	Status (const Standard_Integer num) const
	Returns Status associated to a numero (only to read it)
Standard_Integer &	CStatus (const Standard_Integer num)
	Returns Status associated to a numero, to be read or changed
void	SetStatus (const Standard_Integer num, const Standard_Integer stat)
	Modifies Status associated to a numero
void	RemoveItem (const Standard_Integer num)
	Clears Entity and sets Status to 0, for a numero
void	ChangeStatus (const Standard_Integer oldstat, const Standard_Integer newstat)
	Changes all status which value is oldstat to new value newstat
void	RemoveStatus (const Standard_Integer stat)
	Removes all items of which status has a given value stat
const Interface_BitMap &	BitMap () const
	Returns the Bit Map in order to read or edit flag values
Interface_BitMap &	CBitMap ()
	Returns the Bit Map in order to edit it (add new flags)
const Handle_Interface_InterfaceModel &	Model () const
	Returns the Model with which this Graph was created
void	GetFromModel ()
	Loads Graph with all Entities contained in the Model
void	GetFromEntity (const Handle< Standard_Transient > &ent, const Standard_Boolean shared, const Standard_Integer newstat=0)
	Gets an Entity, plus its shared ones (at every level) if "shared" is True. New items are set to status "newstat" Items already present in graph remain unchanged Of course, redefinitions of Shared lists are taken into account if there are some
void	GetFromEntity (const Handle< Standard_Transient > &ent, const Standard_Boolean shared, const Standard_Integer newstat, const Standard_Integer overlapstat, const Standard_Boolean cumul)
	Gets an Entity, plus its shared ones (at every level) if "shared" is True. New items are set to status "newstat". Items already present in graph are processed as follows :
void	GetFromIter (const Interface_EntityIterator &iter, const Standard_Integer newstat)
	Gets Entities given by an EntityIterator. Entities which were not yet present in the graph are mapped with status "newstat" Entities already present remain unchanged
void	GetFromIter (const Interface_EntityIterator &iter, const Standard_Integer newstat, const Standard_Integer overlapstat, const Standard_Boolean cumul)
	Gets Entities given by an EntityIterator and distinguishes those already present in the Graph :
void	GetFromGraph (const Interface_Graph &agraph)
	Gets all present items from another graph
void	GetFromGraph (const Interface_Graph &agraph, const Standard_Integer stat)
	Gets items from another graph which have a specific Status
Standard_Boolean	HasShareErrors (const Handle< Standard_Transient > &ent) const
	Returns True if <ent> or the list of entities shared by <ent> (not redefined) contains items unknown from this Graph Remark : apart from the status HasShareError, these items are ignored
Standard_Boolean	HasRedefinedShareds (const Handle< Standard_Transient > &ent) const
	Returns True if Shared list of <ent> has been redefined (Thus, Shareds from Graph gives a result different from general service Shareds)
Interface_EntityIterator	Shareds (const Handle< Standard_Transient > &ent) const
	Returns the list of Entities Shared by an Entity, as recorded by the Graph. That is, by default Basic Shared List, else it can be redefined by methods SetShare, SetNoShare ... see below
Interface_IntList	SharedNums (const Standard_Integer num) const
	Same as Shareds, but under the form of a list of Integers, each one beeing the Number of a Shared Entity in the Graph Especially intended for fast internal uses Returns a Null Handle if <num> is not contained by <themodel>
Interface_EntityIterator	Sharings (const Handle< Standard_Transient > &ent) const
	Returns the list of Entities which Share an Entity, computed from the Basic or Redefined Shared Lists
Interface_IntList	SharingNums (const Standard_Integer num) const
	Same as Sharings, but under the form of a list of Integers each one beeing the Number of a Sharing Entity in the Graph
Interface_EntityIterator	TypedSharings (const Handle< Standard_Transient > &ent, const Handle< Standard_Type > &type) const
	Returns the list of sharings entities, AT ANY LEVEL, which are kind of a given type. A sharing entity kind of this type ends the exploration of its branch
Interface_EntityIterator	RootEntities () const
	Returns the Entities which are not Shared (their Sharing List is empty) in the Model
void	SetShare (const Handle< Standard_Transient > &ent)
	Sets explicit the shared list of an Entity <ent>, that is, available for a further edit (Add/Remove). All SetShare and SetNoShare methods allow further edit operations. Effect cancelled by ResetShare Remark that all Redefinition methods work on Shared Lists, but also manage (update) the Sharing Lists
void	SetShare (const Handle< Standard_Transient > &ent, const Interface_EntityIterator &list)
	Sets as Shared list of an Entity <ent> considered by <me>, the list given as an EntityIterator <iter>. It can be empty. This list will now be considered by method Shareds above Does nothing if <ent> is not contained by <themodel>
void	SetShare (const Handle< Standard_Transient > &ent, const Interface_IntList &list)
	Same as above, but the list is given as the list of Numbers of the Entities shared by <ent>
void	SetNoShare (const Handle< Standard_Transient > &ent)
	Sets the Shared list of an Entity considered in <me> as beeing Empty (if <ent> is contained by <themodel>)
void	SetNoShare (const Interface_EntityIterator &list)
	Sets the Shared lists of a list of Entities to be Empty
void	AddShared (const Handle< Standard_Transient > &ent, const Handle< Standard_Transient > &shared)
	Adds a shared Entity to a redefined Shared List (formerly defined by SetShare or SetNoShare). Does nothing if already in
void	RemoveShared (const Handle< Standard_Transient > &ent, const Handle< Standard_Transient > &shared)
	Removes a shared Entity from a redefined Shared List (formerly defined ...). Does nothing if <shared> no in the list
void	ResetShare (const Handle< Standard_Transient > &ent)
	Comes back to the standard Shared list for <ent> : Cancels all the former redefinitions for it
void	ResetAllShare ()
	Clears all effects of former redefinition of Shared lists
Handle_TCollection_HAsciiString	Name (const Handle< Standard_Transient > &ent) const
	Determines the name attached to an entity, by using the general service Name in GeneralModule Returns a null handle if no name could be computed or if the entity is not in the model

---

Constructor & Destructor Documentation

Interface_Graph::Interface_Graph	(	const Handle< Interface_InterfaceModel > &	amodel,
		const Interface_GeneralLib &	lib
	)

Interface_Graph::Interface_Graph	(	const Handle< Interface_InterfaceModel > &	amodel,
		const Handle< Interface_Protocol > &	protocol
	)

Interface_Graph::Interface_Graph	(	const Handle< Interface_InterfaceModel > &	amodel,
		const Handle< Interface_GTool > &	gtool
	)

Interface_Graph::Interface_Graph

(

const Handle< Interface_InterfaceModel > &

amodel

)

Interface_Graph::Interface_Graph	(	const Interface_Graph &	agraph,
		const Standard_Boolean	copied = Standard_False
	)

---

Member Function Documentation

void Interface_Graph::AddShared	(	const Handle< Standard_Transient > &	ent,
		const Handle< Standard_Transient > &	shared
	)

const Interface_BitMap& Interface_Graph::BitMap

(

)

const

Interface_BitMap& Interface_Graph::CBitMap

(

)

void Interface_Graph::ChangeStatus	(	const Standard_Integer	oldstat,
		const Standard_Integer	newstat
	)

Standard_Integer& Interface_Graph::CStatus

(

const Standard_Integer

num

)

const Handle_Standard_Transient& Interface_Graph::Entity

(

const Standard_Integer

num

)

const

Standard_Integer Interface_Graph::EntityNumber

(

const Handle< Standard_Transient > &

ent

)

const

void Interface_Graph::EvalSharings

(

)

void Interface_Graph::GetFromEntity	(	const Handle< Standard_Transient > &	ent,
		const Standard_Boolean	shared,
		const Standard_Integer	newstat = 0
	)

void Interface_Graph::GetFromEntity	(	const Handle< Standard_Transient > &	ent,
		const Standard_Boolean	shared,
		const Standard_Integer	newstat,
		const Standard_Integer	overlapstat,
		const Standard_Boolean	cumul
	)

• if they already have status "newstat", they remain unchanged
  
• if they have another status, this one is modified :
  if cumul is True, to former status + overlapstat (cumul)
  if cumul is False, to overlapstat (enforce)
  

void Interface_Graph::GetFromGraph

(

const Interface_Graph &

agraph

)

void Interface_Graph::GetFromGraph	(	const Interface_Graph &	agraph,
		const Standard_Integer	stat
	)

void Interface_Graph::GetFromIter	(	const Interface_EntityIterator &	iter,
		const Standard_Integer	newstat,
		const Standard_Integer	overlapstat,
		const Standard_Boolean	cumul
	)

• new entities added to the Graph with status "newstst"
  
• entities already present with status = "newstat" remain
  unchanged
  
• entities already present with status different form
  "newstat" have their status modified :
  if cumul is True, to former status + overlapstat (cumul)
  if cumul is False, to overlapstat (enforce)
  (Note : works as GetEntity, shared = False, for each entity)
  

void Interface_Graph::GetFromIter	(	const Interface_EntityIterator &	iter,
		const Standard_Integer	newstat
	)

void Interface_Graph::GetFromModel

(

)

Standard_Boolean Interface_Graph::HasRedefinedShareds

(

const Handle< Standard_Transient > &

ent

)

const

Standard_Boolean Interface_Graph::HasShareErrors

(

const Handle< Standard_Transient > &

ent

)

const

Standard_Boolean Interface_Graph::IsPresent

(

const Standard_Integer

num

)

const

Standard_Boolean Interface_Graph::IsPresent

(

const Handle< Standard_Transient > &

ent

)

const

const Handle_Interface_InterfaceModel& Interface_Graph::Model

(

)

const

Handle_TCollection_HAsciiString Interface_Graph::Name

(

const Handle< Standard_Transient > &

ent

)

const

void Interface_Graph::operator delete

(

void *

anAddress

)

[inline]

void* Interface_Graph::operator new

(

size_t

size

)

[inline]

void* Interface_Graph::operator new	(	size_t	,
		void *	anAddress
	)		[inline]

void Interface_Graph::RemoveItem

(

const Standard_Integer

num

)

void Interface_Graph::RemoveShared	(	const Handle< Standard_Transient > &	ent,
		const Handle< Standard_Transient > &	shared
	)

void Interface_Graph::RemoveStatus

(

const Standard_Integer

stat

)

void Interface_Graph::Reset

(

)

void Interface_Graph::ResetAllShare

(

)

void Interface_Graph::ResetShare

(

const Handle< Standard_Transient > &

ent

)

void Interface_Graph::ResetStatus

(

)

Interface_EntityIterator Interface_Graph::RootEntities

(

)

const

void Interface_Graph::SetNoShare

(

const Handle< Standard_Transient > &

ent

)

void Interface_Graph::SetNoShare

(

const Interface_EntityIterator &

list

)

void Interface_Graph::SetShare	(	const Handle< Standard_Transient > &	ent,
		const Interface_IntList &	list
	)

void Interface_Graph::SetShare	(	const Handle< Standard_Transient > &	ent,
		const Interface_EntityIterator &	list
	)

void Interface_Graph::SetShare

(

const Handle< Standard_Transient > &

ent

)

void Interface_Graph::SetStatus	(	const Standard_Integer	num,
		const Standard_Integer	stat
	)

Interface_IntList Interface_Graph::SharedNums

(

const Standard_Integer

num

)

const

Interface_EntityIterator Interface_Graph::Shareds

(

const Handle< Standard_Transient > &

ent

)

const

Interface_IntList Interface_Graph::SharingNums

(

const Standard_Integer

num

)

const

Interface_EntityIterator Interface_Graph::Sharings

(

const Handle< Standard_Transient > &

ent

)

const

Standard_Integer Interface_Graph::Size

(

)

const

Standard_Integer Interface_Graph::Status

(

const Standard_Integer

num

)

const

Interface_EntityIterator Interface_Graph::TypedSharings	(	const Handle< Standard_Transient > &	ent,
		const Handle< Standard_Type > &	type
	)		const

---

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

• Interface_Graph.hxx