OCC.Core.Interface module

Interface module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_interface.html

class Interface_Array1OfFileParameter(*args)

Bases: object

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

First()

Init()

IsAllocated()

IsDeletable()

IsEmpty()

Last()

Length()

Lower()

Move()

Resize()

Set()

SetValue()

Size()

Upper()

Value()

begin()

cbegin()

cend()

end()

next()

property thisown

The membership flag

class Interface_Array1OfHAsciiString(*args)

Bases: object

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

First()

Init()

IsAllocated()

IsDeletable()

IsEmpty()

Last()

Length()

Lower()

Move()

Resize()

Set()

SetValue()

Size()

Upper()

Value()

begin()

cbegin()

cend()

end()

next()

property thisown

The membership flag

class Interface_BitMap(*args)

Bases: object

• Creates a empty BitMap

  rtype

  None* Creates a BitMap for <nbitems> items One flag is defined, n0 0 <resflags> prepares allocation for <resflags> more flags Flags values start at false

  param nbitems

  type nbitems

  int

  param resflags

  default value is 0

  type resflags

  int

  rtype

  None* Creates a BitMap from another one if <copied> is True, copies data else, data are not copied, only the header object is

  param other

  type other

  Interface_BitMap

  param copied

  default value is Standard_False

  type copied

  bool

  rtype

  None

AddFlag()

• Adds a flag, a name can be attached to it Returns its flag number Makes required reservation

  param name

  default value is

  type name

  char *

  rtype

  int

AddSomeFlags()

• Adds several flags (<more>) with no name Returns the number of last added flag

  param more

  type more

  int

  rtype

  int

CFalse()

• Returns the former value for a flag and sets it to False (beforevalue returned; afterFalse)

  param item

  type item

  int

  param flag

  default value is 0

  type flag

  int

  rtype

  bool

CTrue()

• Returns the former value for a flag and sets it to True (beforevalue returned; afterTrue)

  param item

  type item

  int

  param flag

  default value is 0

  type flag

  int

  rtype

  bool

Clear()

• Clear all field of bit map

  rtype

  None

FlagName()

• Returns the name recorded for a flag, or an empty string

  param num

  type num

  int

  rtype

  char *

FlagNumber()

• Returns the number or a flag given its name, or zero

  param name

  type name

  char *

  rtype

  int

Init()

• Initialises all the values of Flag Number <flag> to a given value <val>

  param val

  type val

  bool

  param flag

  default value is 0

  type flag

  int

  rtype

  None

Initialize()

• Initialize empty bit by <nbitems> items One flag is defined, n0 0 <resflags> prepares allocation for <resflags> more flags Flags values start at false

  param nbitems

  type nbitems

  int

  param resflags

  default value is 0

  type resflags

  int

  rtype

  None* Initialize a BitMap from another one

  param other

  type other

  Interface_BitMap

  param copied

  default value is Standard_False

  type copied

  bool

  rtype

  None

Internals()

• Returns internal values, used for copying Flags values start at false

  param nbitems

  type nbitems

  int

  param nbwords

  type nbwords

  int

  param nbflags

  type nbflags

  int

  param flags

  type flags

  TColStd_HArray1OfInteger

  param names

  type names

  TColStd_HSequenceOfAsciiString

  rtype

  None

Length()

• Returns the count of items (i.e. the length of the bitmap)

  rtype

  int

NbFlags()

• Returns the count of flags (flag 0 not included)

  rtype

  int

RemoveFlag()

• Removes a flag given its number. Returns True if done, false if num is out of range

  param num

  type num

  int

  rtype

  bool

Reservate()

• Reservates for a count of more flags

  param moreflags

  type moreflags

  int

  rtype

  None

SetFalse()

• Sets a flag to False

  param item

  type item

  int

  param flag

  default value is 0

  type flag

  int

  rtype

  None

SetFlagName()

• Sets a name for a flag, given its number name can be empty (to erase the name of a flag) Returns True if done, false ifnum is out of range, or name non-empty already set to another flag

  param num

  type num

  int

  param name

  type name

  char *

  rtype

  bool

SetLength()

• Sets for a new count of items, which can be either less or greater than the former one For new items, their flags start at false

  param nbitems

  type nbitems

  int

  rtype

  None

SetTrue()

• Sets a flag to True

  param item

  type item

  int

  param flag

  default value is 0

  type flag

  int

  rtype

  None

SetValue()

• Sets a new value for a flag

  param item

  type item

  int

  param val

  type val

  bool

  param flag

  default value is 0

  type flag

  int

  rtype

  None

Value()

• Returns the value (true/false) of a flag, from- the number of the item - the flag number, by default 0

  param item

  type item

  int

  param flag

  default value is 0

  type flag

  int

  rtype

  bool

property thisown

The membership flag

class Interface_Category(*args)

Bases: object

• Creates a Category, with no protocol yet

  rtype

  None* Creates a Category with a given protocol

  param theProtocol

  type theProtocol

  Interface_Protocol

  rtype

  None* Creates a Category with a given GTool

  param theGTool

  type theGTool

  Interface_GTool

  rtype

  None

static AddCategory()

• Records a new Category defined by its names, produces a number New if not yet recorded

  param theName

  type theName

  char *

  rtype

  int

CatNum()

• Determines the Category Number for an entity in its context, by using general service CategoryNumber

  param theEnt

  type theEnt

  Standard_Transient

  param theShares

  type theShares

  Interface_ShareTool

  rtype

  int

ClearNums()

• Clears the recorded list of category numbers for a Model

  rtype

  None

Compute()

• Computes the Category Number for each entity and records it, in an array (ent.number -> category number) Hence, it can be queried by the method Num. The Model itself is not recorded, this method is intended to be used in a wider context (which detains also a Graph, etc)

  param theModel

  type theModel

  Interface_InterfaceModel

  param theShares

  type theShares

  Interface_ShareTool

  rtype

  None

static Init()

• Default initialisation (protected against several callspasses only once)

  rtype

  void

static Name()

• Returns the name of a category, according to its number

  param theNum

  type theNum

  int

  rtype

  char *

static NbCategories()

• Returns the count of recorded categories

  rtype

  int

Num()

• Returns the category number recorded for an entity number Returns 0 if out of range

  param theNumEnt

  type theNumEnt

  int

  rtype

  int

static Number()

• Returns the number of a category, according to its name

  param theName

  type theName

  char *

  rtype

  int

SetProtocol()

• Sets/Changes Protocol

  param theProtocol

  type theProtocol

  Interface_Protocol

  rtype

  None

property thisown

The membership flag

class Interface_Check(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Allows definition of a Sequence. Used also for Global Check of an InterfaceModel (which stores global messages for file)

  rtype

  None* Defines a Check on an Entity

  param anentity

  type anentity

  Standard_Transient

  rtype

  None

AddFail()

• Records a new Fail message

  param amess

  type amess

  TCollection_HAsciiString

  rtype

  None* Records a new Fail message under two forms : final,original

  param amess

  type amess

  TCollection_HAsciiString

  param orig

  type orig

  TCollection_HAsciiString

  rtype

  None* Records a new Fail message given as ‘error text’ directly If <orig> is given, a distinct original form is recorded else (D), the original form equates <amess>

  param amess

  type amess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None* Records a new Fail from the definition of a Msg (Original+Value)

  param amsg

  type amsg

  Message_Msg

  rtype

  None

AddWarning()

• Records a new Warning message

  param amess

  type amess

  TCollection_HAsciiString

  rtype

  None* Records a new Warning message under two forms : final,original

  param amess

  type amess

  TCollection_HAsciiString

  param orig

  type orig

  TCollection_HAsciiString

  rtype

  None* Records a Warning message given as ‘warning message’ directly If <orig> is given, a distinct original form is recorded else (D), the original form equates <amess>

  param amess

  type amess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None* Records a new Warning from the definition of a Msg (Original+Value)

  param amsg

  type amsg

  Message_Msg

  rtype

  None

CFail()

• Same as above, but returns a CString (to be printed …) Final form by default, Original form if <final> is False

  param num

  type num

  int

  param final

  default value is Standard_True

  type final

  bool

  rtype

  char *

CInfoMsg()

• Same as above, but returns a CString (to be printed …) Final form by default, Original form if <final> is False

  param num

  type num

  int

  param final

  default value is Standard_True

  type final

  bool

  rtype

  char *

CWarning()

• Same as above, but returns a CString (to be printed …) Final form by default, Original form if <final> is False

  param num

  type num

  int

  param final

  default value is Standard_True

  type final

  bool

  rtype

  char *

Clear()

• Clears a check, in order to receive informations from transfer (Messages and Entity)

  rtype

  None

ClearFails()

• Clears the Fail Messages (for instance to keep only Warnings)

  rtype

  None

ClearInfoMsgs()

• Clears the Info Messages

  rtype

  None

ClearWarnings()

• Clears the Warning Messages (for instance to keep only Fails)

  rtype

  None

Complies()

• Tells if Check Status complies with a given one (i.e. also status for query)

  param status

  type status

  Interface_CheckStatus

  rtype

  bool* Tells if a message is brought by a Check, as follows : <incl> = 0 : <mess> exactly matches one of the messages <incl> < 0 : <mess> is contained by one of the messages <incl> > 0 : <mess> contains one of the messages For <status> : for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (answer will be false)

  param mess

  type mess

  TCollection_HAsciiString

  param incl

  type incl

  int

  param status

  type status

  Interface_CheckStatus

  rtype

  bool

static DownCast(t)

Entity()

• Returns the entity on which the Check has been defined

  rtype

  opencascade::handle<Standard_Transient>

Fail()

• Returns Fail Message as a String Final form by default, Original form if <final> is False

  param num

  type num

  int

  param final

  default value is Standard_True

  type final

  bool

  rtype

  opencascade::handle<TCollection_HAsciiString>

Fails()

• Returns the list of Fails, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty

  param final

  default value is Standard_True

  type final

  bool

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

GetAsWarning()

• Copies messages converted into Warning messages If failsonly is true, only Fails are taken, and converted else, Warnings are taken too. Does not regard Entity Used to keep Fail messages as Warning, after a recovery

  param other

  type other

  Interface_Check

  param failsonly

  type failsonly

  bool

  rtype

  None

GetEntity()

• same as SetEntity (old form kept for compatibility) WarningDoes nothing if Entity field is not yet clear

  param anentity

  type anentity

  Standard_Transient

  rtype

  None

GetMessages()

• Copies messages stored in another Check, cumulating Does not regard other’s Entity. Used to cumulate messages

  param other

  type other

  Interface_Check

  rtype

  None

HasEntity()

• Returns True if a Check is devoted to an entity; else, it is global (for InterfaceModel’s storing of global error messages)

  rtype

  bool

HasFailed()

• Returns True if Check brings at least one Fail Message

  rtype

  bool

HasWarnings()

• Returns True if Check brings at least one Warning Message

  rtype

  bool

InfoMsg()

• Returns information message as a String

  param num

  type num

  int

  param final

  default value is Standard_True

  type final

  bool

  rtype

  opencascade::handle<TCollection_HAsciiString>

InfoMsgs()

• Returns the list of Info Msg, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty

  param final

  default value is Standard_True

  type final

  bool

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

Mend()

• Mends messages, according <pref> and <num> According to <num>, works on the whole list of Fails if = 0(D) or only one Fail message, given its rank If <pref> is empty, converts Fail(s) to Warning(s) Else, does the conversion but prefixes the new Warning(s) but <pref> followed by a semi-column Some reserved values of <pref> are‘FM’standard prefix ‘Mended’ (can be translated) ‘CF’clears Fail(s) ‘CW’clears Warning(s)here, <num> refers to Warning list ‘CA’clears all messageshere, <num> is ignored

  param pref

  type pref

  char *

  param num

  default value is 0

  type num

  int

  rtype

  bool

NbFails()

• Returns count of recorded Fails

  rtype

  int

NbInfoMsgs()

• Returns the count of recorded information messages

  rtype

  int

NbWarnings()

• Returns count of recorded Warning messages

  rtype

  int

Print()

• Prints the messages of the check to an Messenger <level> = 1only fails <level> = 2fails and warnings <level> = 3all (fails, warnings, info msg) <final>if positive (D) prints final values of messages if negative, prints originals if null, prints both forms

  param S

  type S

  Message_Messenger

  param level

  type level

  int

  param final

  default value is 1

  type final

  int

  rtype

  None

Remove()

• Removes the messages which comply with <mess>, as follows<incl> = 0<mess> exactly matches one of the messages <incl> < 0<mess> is contained by one of the messages <incl> > 0<mess> contains one of the messages For <status>for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (nothing is done) Returns True if at least one message has been removed, False else

  param mess

  type mess

  TCollection_HAsciiString

  param incl

  type incl

  int

  param status

  type status

  Interface_CheckStatus

  rtype

  bool

SendFail()

• New name for AddFail (Msg)

  param amsg

  type amsg

  Message_Msg

  rtype

  None

SendMsg()

• Records an information message This does not change the status of the Check

  param amsg

  type amsg

  Message_Msg

  rtype

  None

SendWarning()

• New name for AddWarning

  param amsg

  type amsg

  Message_Msg

  rtype

  None

SetEntity()

• Receives an entity result of a Transfer

  param anentity

  type anentity

  Standard_Transient

  rtype

  None

Status()

• Returns the Check StatusOK, Warning or Fail

  rtype

  Interface_CheckStatus

Trace()

• Prints the messages of the check to the default trace file By default, according to the default standard level Else, according level (see method Print)

  param level

  default value is -1

  type level

  int

  param final

  default value is 1

  type final

  int

  rtype

  None

Warning()

• Returns Warning message as a String Final form by default, Original form if <final> is False

  param num

  type num

  int

  param final

  default value is Standard_True

  type final

  bool

  rtype

  opencascade::handle<TCollection_HAsciiString>

Warnings()

• Returns the list of Warnings, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty

  param final

  default value is Standard_True

  type final

  bool

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

property thisown

The membership flag

class Interface_CheckIterator(*args)

Bases: object

• Creates an empty CheckIterator

  rtype

  None* Creates a CheckIterator with a name (displayed by Print as a title)

  param name

  type name

  char *

  rtype

  None

Add()

• Adds a Check to the list to be iterated This Check is Accompanied by Entity Number in the Model (0 for Global Check or Entity unknown in the Model), if 0 and Model is recorded in <self>, it is computed

  param ach

  type ach

  Interface_Check

  param num

  default value is 0

  type num

  int

  rtype

  None

CCheck()

• Returns the Check bound to an Entity Number (0Global) in order to be consulted or completed on the spot I.e. returns the Check if is already exists, or adds it then returns the new empty Check

  param num

  type num

  int

  rtype

  opencascade::handle<Interface_Check>* Returns the Check bound to an Entity, in order to be consulted or completed on the spot I.e. returns the Check if is already exists, or adds it then returns the new empty Check

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<Interface_Check>

Check()

• Returns the Check which was attached to an Entity given its Number in the Model. <num>=0 is for the Global Check. If no Check was recorded for this Number, returns an empty Check. RemarkWorks apart from the iteration methods (no interference)

  param num

  type num

  int

  rtype

  opencascade::handle<Interface_Check>* Returns the Check attached to an Entity If no Check was recorded for this Entity, returns an empty Check. Remark : Works apart from the iteration methods (no interference)

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<Interface_Check>

Checkeds()

• Returns the list of entities concerned by a Check Only fails if <failsonly> is True, else all non-empty checks If <global> is true, adds the model for a global check Else, global check is ignored

  param failsonly

  type failsonly

  bool

  param global

  type global

  bool

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

Clear()

• Clears the list of checks

  rtype

  None

Complies()

• Tells if this check list complies with a given statusOK (i.e. empty), Warning (at least one Warning, but no Fail), Fail (at least one), Message (not OK), NoFail, Any

  param status

  type status

  Interface_CheckStatus

  rtype

  bool

Destroy()

• Clears data of iteration

  rtype

  None

Extract()

• Returns a CheckIterator which contains the checks which comply with a given status Each check is added completely (no split Warning/Fail)

  param status

  type status

  Interface_CheckStatus

  rtype

  Interface_CheckIterator* Returns a CheckIterator which contains the check which comply with a message, plus some conditions as follows : <incl> = 0 : <mess> exactly matches one of the messages <incl> < 0 : <mess> is contained by one of the messages <incl> > 0 : <mess> contains one of the messages For <status> : for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (answer will be false) Each Check which complies is entirely taken

  param mess

  type mess

  char *

  param incl

  type incl

  int

  param status

  type status

  Interface_CheckStatus

  rtype

  Interface_CheckIterator

IsEmpty()

• Returns True ifno Fail has been recorded if <failsonly> is True, no Check at all if <failsonly> is False

  param failsonly

  type failsonly

  bool

  rtype

  bool

Merge()

• Merges another CheckIterator into <self>, i.e. adds each of its Checks. Content of <other> remains unchanged. Takes also the Model but not the Name

  param other

  type other

  Interface_CheckIterator

  rtype

  None

Model()

• Returns the stored model (can be a null handle)

  rtype

  opencascade::handle<Interface_InterfaceModel>

More()

• Returns True if there are more Checks to get

  rtype

  bool

Name()

• Returns the recorded name (can be empty)

  rtype

  char *

Next()

• Sets Iteration to next Item

  rtype

  None

Number()

• Returns Number of Entity for the Check currently iterated or 0 for GlobalCheck

  rtype

  int

Print()

• Prints the list of Checks with their attached Numbers If <failsonly> is True, prints only Fail messages If <failsonly> is False, prints all messages If <final> = 0 (D), prints also original messages if different If <final> < 0, prints only original messages If <final> > 0, prints only final messages It uses the recorded Model if it is defined RemarkWorks apart from the iteration methods (no interference)

  param S

  type S

  Message_Messenger

  param failsonly

  type failsonly

  bool

  param final

  default value is 0

  type final

  int

  rtype

  None* Works as Print without a model, but for entities which have no attached number (Number not positive), tries to compute this Number from <model> and displays ‘original’ or ‘computed’

  param S

  type S

  Message_Messenger

  param model

  type model

  Interface_InterfaceModel

  param failsonly

  type failsonly

  bool

  param final

  default value is 0

  type final

  int

  rtype

  None

Remove()

• Removes the messages of all Checks, under these conditions<incl> = 0<mess> exactly matches one of the messages <incl> < 0<mess> is contained by one of the messages <incl> > 0<mess> contains one of the messages For <status>for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (nothing is done) Returns True if at least one message has been removed, False else

  param mess

  type mess

  char *

  param incl

  type incl

  int

  param status

  type status

  Interface_CheckStatus

  rtype

  bool

SetModel()

• Defines a Model, used to locate entities (not required, if it is absent, entities are simply less documented)

  param model

  type model

  Interface_InterfaceModel

  rtype

  None

SetName()

• Sets / Changes the name

  param name

  type name

  char *

  rtype

  None

Start()

• Starts Iteration. Thus, it is possible to restart it Remarkan iteration may be done with a const Iterator While its content is modified (through a pointer), this allows to give it as a const argument to a function

  rtype

  None

Status()

• Returns worst status amongOK, Warning, Fail

  rtype

  Interface_CheckStatus

Value()

• Returns Check currently Iterated It brings all other informations (status, messages, …) The Number of the Entity in the Model is given by Number below

  rtype

  opencascade::handle<Interface_Check>

property thisown

The membership flag

class Interface_CheckTool(*args)

Bases: object

• Creates a CheckTool, by calling the General Service Library and Modules, selected through a Protocol, to work on a Model Moreover, Protocol recognizes Unknown Entities

  param model

  type model

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None* Creates a CheckTool, by calling the General Service Library and Modules, selected through a Protocol, to work on a Model Protocol and so on are taken from the Model (its GTool)

  param model

  type model

  Interface_InterfaceModel

  rtype

  None* Creates a CheckTool from a Graph. The Graph contains a Model which designates a Protocol: they are used to create ShareTool

  param graph

  type graph

  Interface_Graph

  rtype

  None:param hgraph:

  type hgraph

  Interface_HGraph

  rtype

  None

AnalyseCheckList()

• Returns list of errors dectected at Analyse time (syntactic) (note that GlobalCheck is not in this list)

  rtype

  Interface_CheckIterator

Check()

• Returns the Check associated to an Entity identified by its Number in a Model.

  param num

  type num

  int

  rtype

  opencascade::handle<Interface_Check>

CheckList()

• Returns list of all Errors detected Note that presence of Unknown Entities is not an error CumulatesGlobalCheck if error + AnalyseCheckList + VerifyCheckList

  rtype

  Interface_CheckIterator

CheckSuccess()

• Checks if any Error has been detected (CheckList not empty) Returns normally if none, raises exception if some exists. It reuses the last computations from other checking methods, unless the argument <resest> is given True

  param reset

  default value is Standard_False

  type reset

  bool

  rtype

  None

CompleteCheckList()

• Returns list of all ‘remarkable’ informations, which include- GlobalCheck, if not empty - Error Checks, for all Errors (Verify + Analyse) - also Corrected Entities - and Unknown Entitiesfor those, each Unknown Entity is associated to an empty Check (it is neither an Error nor a Correction, but a remarkable information)

  rtype

  Interface_CheckIterator

FillCheck()

• Fills as required a Check with the Error and Warning messages produced by Checking a given Entity. For an Erroneous or Corrected EntityCheck build at Analyse time; else, Check computed for Entity (Verify integrity), can use a Graph as required to control context

  param ent

  type ent

  Standard_Transient

  param sh

  type sh

  Interface_ShareTool

  param ach

  type ach

  Interface_Check

  rtype

  None

Print()

• Utility method which Prints the content of a Check

  param ach

  type ach

  Interface_Check

  param S

  type S

  Message_Messenger

  rtype

  None* Simply Lists all the Checks and the Content (messages) and the Entity, if there is, of each Check (if all Checks are OK, nothing is Printed)

  param list

  type list

  Interface_CheckIterator

  param S

  type S

  Message_Messenger

  rtype

  None

UnknownEntities()

• Returns list of Unknown Entities Note that Error and Erroneous Entities are not considered as Unknown

  rtype

  Interface_EntityIterator

VerifyCheckList()

• Returns list of integrity constraints errors (semantic) (note that GlobalCheck is not in this list)

  rtype

  Interface_CheckIterator

WarningCheckList()

• Returns list of Corrections (includes GlobalCheck if corrected)

  rtype

  Interface_CheckIterator

property thisown

The membership flag

class Interface_CopyControl(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Bind()

• Bind a Result to a Starting Entity identified by its Number

  param ent

  type ent

  Standard_Transient

  param res

  type res

  Standard_Transient

  rtype

  void

Clear()

• Clears List of Copy Results. Gets Ready to begin another Copy Process.

  rtype

  void

static DownCast(t)

Search()

• Searches for the Result bound to a Startingf Entity identified by its Number. If Found, returns True and fills <res> Else, returns False and nullifies <res>

  param ent

  type ent

  Standard_Transient

  param res

  type res

  Standard_Transient

  rtype

  bool

property thisown

The membership flag

class Interface_CopyMap(*args)

Bases: OCC.Core.Interface.Interface_CopyControl

• Creates a CopyMap adapted to work from a Model

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None

static DownCast(t)

Model()

• Returns the InterfaceModel used at Creation time

  rtype

  opencascade::handle<Interface_InterfaceModel>

property thisown

The membership flag

class Interface_CopyTool(*args)

Bases: object

• Creates a CopyTool adapted to work from a Model. Works with a General Service Library, given as an argument

  param amodel

  type amodel

  Interface_InterfaceModel

  param lib

  type lib

  Interface_GeneralLib

  rtype

  None* Same as above, but Library is defined through a Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None* Same as above, but works with the Active Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None

Bind()

• Defines a Result for the Transfer of a Starting object. Used by method Transferred (which performs a normal Copy), but can also be called to enforce a resultin the latter case, the enforced result must be compatible with the other Transfers which are performed

  param ent

  type ent

  Standard_Transient

  param res

  type res

  Standard_Transient

  rtype

  None

Clear()

• Clears Transfer List. Gets Ready to begin another Transfer

  rtype

  void

ClearLastFlags()

• Clears LastFlags only. This allows to know what Entities are copied after its call (see method LastCopiedAfter). It can be used when copies are done by increments, which must be distinghished. ClearLastFlags is also called by Clear.

  rtype

  None

CompleteResult()

• Returns the complete list of copied Entities If <withreports> is given True, the entities which were reported in the Starting Model are replaced in the list by the copied ReportEntities

  param withreports

  default value is Standard_False

  type withreports

  bool

  rtype

  Interface_EntityIterator

Control()

• Returns the object used for Control

  rtype

  opencascade::handle<Interface_CopyControl>

Copy()

• Creates the CounterPart of an Entity (by ShallowCopy), Binds it, then Copies the content of the former Entity to the other one (same Type), by call to the General Service Library It may command the Copy of Referenced Entities Then, its returns True. //! If <mapped> is True, the Map is used to store the Result Else, the Result is simply producedit can be used to Copy internal sub-parts of Entities, which are not intended to be shared (Strings, Arrays, etc…) If <errstat> is True, this means that the Entity is recorded in the Model as Erroneousin this case, the General Service for Deep Copy is not called (this could be dangerous)hence the Counter-Part is produced but empty, it can be referenced. //! This method does nothing and returns False if the Protocol does not recognize <ent>. It basically makes a Deep Copy without changing the Types. It can be redefined for special uses.

  param entfrom

  type entfrom

  Standard_Transient

  param entto

  type entto

  Standard_Transient

  param mapped

  type mapped

  bool

  param errstat

  type errstat

  bool

  rtype

  bool

FillModel()

• Fills a Model with the result of the transfer (TransferList) Commands copy of Header too, and calls RenewImpliedRefs

  param bmodel

  type bmodel

  Interface_InterfaceModel

  rtype

  None

LastCopiedAfter()

• Returns an copied Entity and its Result which were operated after last call to ClearLastFlags. It returns the first ‘Last Copied Entity’ which Number follows <numfrom>, Zero if none. It is used in a loop as followInteger num = 0; while ( (num = CopyTool.LastCopiedAfter(num,ent,res)) ) { .. Process Starting <ent> and its Result <res> }

  param numfrom

  type numfrom

  int

  param ent

  type ent

  Standard_Transient

  param res

  type res

  Standard_Transient

  rtype

  int

Model()

• Returns the Model on which the CopyTool works

  rtype

  opencascade::handle<Interface_InterfaceModel>

RenewImpliedRefs()

• Renews the Implied References. These References do not involve Copying of referenced Entities. For such a Reference, if the Entity which defines it AND the referenced Entity are both copied, then this Reference is renewed. Else it is deleted in the copied Entities. Remarkthis concerns only some specific references, such as ‘back pointers’.

  rtype

  None

RootResult()

• Returns the list of Root copied Entities (those which were asked for copy by the user of CopyTool, not by copying another Entity)

  param withreports

  default value is Standard_False

  type withreports

  bool

  rtype

  Interface_EntityIterator

Search()

• Search for the result of a Starting Object (i.e. an Entity) Returns True if a Result is Bound (and fills ‘result’) Returns False if no result is Bound

  param ent

  type ent

  Standard_Transient

  param res

  type res

  Standard_Transient

  rtype

  bool

SetControl()

• Changes the Map of Result for another one. This allows to work with a more sophisticated Mapping Control than the Standard one which is CopyMap (e.g. TransferProcess from Transfer)

  param othermap

  type othermap

  Interface_CopyControl

  rtype

  None

TransferEntity()

• Transfers one Entity and records result into the Transfer List Calls method Transferred

  param ent

  type ent

  Standard_Transient

  rtype

  None

Transferred()

• Transfers one Entity, if not yet bound to a result RemarkFor an Entity which is reported in the Starting Model, the ReportEntity will also be copied with its Content if it has one (at least ShallowCopy; Complete Copy if the Protocol recognizes the Contentsee method Copy)

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Interface_DataMapOfTransientInteger(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class Interface_EntityCluster(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty, non-chained, EntityCluster

  rtype

  None* Creates a non-chained EntityCluster, filled with one Entity

  param ent

  type ent

  Standard_Transient

  rtype

  None* Creates an empty EntityCluster, chained with another one (that is, put BEFORE this other one in the list)

  param ec

  type ec

  Interface_EntityCluster

  rtype

  None* Creates an EntityCluster, filled with a first Entity, and chained to another EntityCluster (BEFORE it, as above)

  param ant

  type ant

  Standard_Transient

  param ec

  type ec

  Interface_EntityCluster

  rtype

  None

Append()

• Appends an Entity to the Cluster. If it is not full, adds the entity directly inside itself. Else, transmits to its Next and Creates it if it does not yet exist

  param ent

  type ent

  Standard_Transient

  rtype

  None

static DownCast(t)

FillIterator()

• Fills an Iterator with designated Entities (includes Next)

  param iter

  type iter

  Interface_EntityIterator

  rtype

  None

NbEntities()

• Returns total count of Entities (including Next)

  rtype

  int

Remove()

• Removes an Entity from the Cluster. If it is not found, calls its Next one to do so. Returns True if it becomes itself empty, False else (thus, a Cluster which becomes empty is deleted from the list)

  param ent

  type ent

  Standard_Transient

  rtype

  bool* Removes an Entity from the Cluster, given its rank. If <num> is greater than NbLocal, calls its Next with (num - NbLocal), Returns True if it becomes itself empty, False else

  param num

  type num

  int

  rtype

  bool

SetValue()

• Changes an Entity given its rank.

  param num

  type num

  int

  param ent

  type ent

  Standard_Transient

  rtype

  None

Value()

• Returns the Entity identified by its rank in the list (including Next)

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Interface_EntityIterator(*args)

Bases: object

• Defines an empty iterator (see AddList & AddItem)

  rtype

  None* Defines an iterator on a list, directly i.e. without copying it

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  None

AddItem()

• Adds to the iteration list a defined entity

  param anentity

  type anentity

  Standard_Transient

  rtype

  None

AddList()

• Gets a list of entities and adds its to the iteration list

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  None

Content()

• Returns the content of the Iterator, accessed through a Handle to be used by a frontal-engine logic Returns an empty Sequence if the Iterator is empty Calls Start if not yet done

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

Destroy()

• Clears data of iteration

  rtype

  None

GetOneItem()

• same as AddItem (kept for compatibility)

  param anentity

  type anentity

  Standard_Transient

  rtype

  None

More()

• Says if there are other entities (vertices) to iterate the first time, calls Start

  rtype

  bool

NbEntities()

• Returns count of entities which will be iterated on Calls Start if not yet done

  rtype

  int

NbTyped()

• Returns count of entities of a given type (kind of)

  param type

  type type

  Standard_Type

  rtype

  int

Next()

• Sets iteration to the next entity (vertex) to give

  rtype

  None

SelectType()

• Selects entities with are Kind of a given type, keep only them (is keep is True) or reject only them (if keep is False)

  param atype

  type atype

  Standard_Type

  param keep

  type keep

  bool

  rtype

  None

Start()

• Allows re-iteration (useless for the first iteration)

  rtype

  void

Typed()

• Returns the list of entities of a given type (kind of)

  param type

  type type

  Standard_Type

  rtype

  Interface_EntityIterator

Value()

• Returns the current Entity iterated, to be used by Interface tools

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Interface_EntityList(*args)

Bases: object

• Creates a List as beeing empty

  rtype

  None

Add()

• Adds an Entity to the list, that is, with NO REGARD about the order (faster than Append if count becomes greater than 10)

  param ent

  type ent

  Standard_Transient

  rtype

  None

Append()

• Appends an Entity, that is to the END of the list (keeps order, but works slowerly than Add, see below)

  param ent

  type ent

  Standard_Transient

  rtype

  None

Clear()

• Clears the List

  rtype

  None

FillIterator()

• fills an Iterator with the content of the list (normal way to consult a list which has been filled with Add)

  param iter

  type iter

  Interface_EntityIterator

  rtype

  None

IsEmpty()

• Returns True if the list is empty

  rtype

  bool

NbEntities()

• Returns count of recorded Entities

  rtype

  int

NbTypedEntities()

• Returns count of Entities of a given Type (0none)

  param atype

  type atype

  Standard_Type

  rtype

  int

Remove()

• Removes an Entity from the list, if it is there

  param ent

  type ent

  Standard_Transient

  rtype

  None* Removes an Entity from the list, given its rank

  param num

  type num

  int

  rtype

  None

SetValue()

• Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append)

  param num

  type num

  int

  param ent

  type ent

  Standard_Transient

  rtype

  None

TypedEntity()

• Returns the Entity which is of a given type. If num = 0 (D), there must be ONE AND ONLY ONE If num > 0, returns the num-th entity of this type

  param atype

  type atype

  Standard_Type

  param num

  default value is 0

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

Value()

• Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append)

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Interface_FileParameter(*args)

Bases: object

Return type

None

CValue()

• Same as above, but as a CString (for immediate exploitation) was C++return const

  rtype

  char *

Clear()

• Clears stored datafrees memory taken for the String Value

  rtype

  None

Destroy()

• Destructor. Does nothing because Memory is managed by ParamSet

  rtype

  None

EntityNumber()

• Returns value set by SetEntityNumber

  rtype

  int

Init()

• Fills fields (with Entity Number set to zero)

  param val

  type val

  TCollection_AsciiString

  param typ

  type typ

  Interface_ParamType

  rtype

  None* Same as above, but builds the Value from a CString

  param val

  type val

  char *

  param typ

  type typ

  Interface_ParamType

  rtype

  None

ParamType()

• Returns the type of the parameter

  rtype

  Interface_ParamType

SetEntityNumber()

• Allows to set a reference to an Entity in a numbered list

  param num

  type num

  int

  rtype

  None

property thisown

The membership flag

class Interface_FileReaderData(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

AddParam()

• Adds a parameter to record no ‘num’ and fills its fields (EntityNumber is optional) Warning<aval> is assumed to be memory-managed elsewhereit is NOT copied. This gives a best speedstrings remain stored in pages of characters

  param num

  type num

  int

  param aval

  type aval

  char *

  param atype

  type atype

  Interface_ParamType

  param nument

  default value is 0

  type nument

  int

  rtype

  None* Same as above, but gets a AsciiString from TCollection Remark that the content of the AsciiString is locally copied (because its content is most often lost after using)

  param num

  type num

  int

  param aval

  type aval

  TCollection_AsciiString

  param atype

  type atype

  Interface_ParamType

  param nument

  default value is 0

  type nument

  int

  rtype

  None* Same as above, but gets a complete FileParameter Warning : Content of <FP> is NOT copied : its original address and space in memory are assumed to be managed elsewhere (see ParamSet)

  param num

  type num

  int

  param FP

  type FP

  Interface_FileParameter

  rtype

  None

BindEntity()

• Binds an entity to a record

  param num

  type num

  int

  param ent

  type ent

  Standard_Transient

  rtype

  None

BoundEntity()

• Returns the entity bound to a record, set by SetEntities

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

ChangeParam()

• Same as above, but in order to be modified on place

  param num

  type num

  int

  param nump

  type nump

  int

  rtype

  Interface_FileParameter

Destroy()

• Destructor (waiting for memory management)

  rtype

  None

static DownCast(t)

static Fastof()

• Same spec.s as standard <atof> but 5 times faster

  param str

  type str

  char *

  rtype

  float

FindNextRecord()

• Determines the record number defining an Entity following a given record number. Specific to each sub-class of FileReaderData. Returning zero means no record found

  param num

  type num

  int

  rtype

  int

InitParams()

• attaches an empty ParamList to a Record

  param num

  type num

  int

  rtype

  None

IsErrorLoad()

• Returns True if the status ‘Error Load’ has been set (to True or False)

  rtype

  bool

IsParamDefined()

• Returns True if parameter ‘nump’ of record ‘num’ is defined (it is not if its type is ParamVoid)

  param num

  type num

  int

  param nump

  type nump

  int

  rtype

  bool

NbEntities()

• Returns the count of entities. Depending of each norm, records can be Entities or SubParts (SubList in STEP, SubGroup in SET …). NbEntities counts only Entities, not Subs Used for memory reservation in InterfaceModel Default implementation uses FindNextRecord Can be redefined into a more performant way

  rtype

  int

NbParams()

• Returns count of parameters attached to record ‘num’ If <num> = 0, returns the total recorded count of parameters

  param num

  type num

  int

  rtype

  int

NbRecords()

• Returns the count of registered records That is, value given for Initialization (can be redefined)

  rtype

  int

Param()

• Returns parameter ‘nump’ of record ‘num’, as a complete FileParameter

  param num

  type num

  int

  param nump

  type nump

  int

  rtype

  Interface_FileParameter

ParamCValue()

• Same as above, but as a CString was C++return const

  param num

  type num

  int

  param nump

  type nump

  int

  rtype

  char *

ParamEntity()

• Returns the StepEntity referenced by a parameter Error if none

  param num

  type num

  int

  param nump

  type nump

  int

  rtype

  opencascade::handle<Standard_Transient>

ParamFirstRank()

• Returns the absolute rank of the beginning of a record (its lsit is from ParamFirstRank+1 to ParamFirstRank+NbParams)

  param num

  type num

  int

  rtype

  int

ParamNumber()

• Returns record number of an entity referenced by a parameter of type Ident; 0 if no EntityNumber has been determined Note that it is used to reference Entities but also Sublists (sublists are not objects, but internal descriptions)

  param num

  type num

  int

  param nump

  type nump

  int

  rtype

  int

ParamType()

• Returns type of parameter ‘nump’ of record ‘num’ Returns literal value of parameter ‘nump’ of record ‘num’ was C++return const &

  param num

  type num

  int

  param nump

  type nump

  int

  rtype

  Interface_ParamType

Params()

• Returns the complete ParamList of a record (read only) num = 0 to return the whole param list for the file

  param num

  type num

  int

  rtype

  opencascade::handle<Interface_ParamList>

ResetErrorLoad()

• Returns the former value of status ‘Error Load’ then resets it Used to read the status then ensure it is reset

  rtype

  bool

SetErrorLoad()

• Sets the status ‘Error Load’ on, to overside check fails <val> Truedeclares unloaded <val> Falsedeclares loaded If not called before loading (see FileReaderTool), check fails give the status IsErrorLoad says if SetErrorLoad has been called by user ResetErrorLoad resets it (called by FileReaderTool) This allows to specify that the currently loaded entity remains unloaded (because of syntactic fail)

  param val

  type val

  bool

  rtype

  None

SetParam()

• Sets a new value for a parameter of a record, given bynumrecord number; numpparameter number in the record

  param num

  type num

  int

  param nump

  type nump

  int

  param FP

  type FP

  Interface_FileParameter

  rtype

  None

property thisown

The membership flag

class Interface_FileReaderTool(*args, **kwargs)

Bases: object

AnalyseRecord()

• Fills an Entity, given record no; specific to each Interface, called by AnalyseFile from InterfaceModel (which manages its calling arguments) To work, each Interface can define a method in its proper Transient class, like this (given as an example)AnalyseRecord (memutable; FRin out FileReaderTool; numInteger; acheckin out Check) returns Boolean; and call it from AnalyseRecord //! Returned ValueTrue if the entity could be loaded, False else (in case of syntactic fail)

  param num

  type num

  int

  param anent

  type anent

  Standard_Transient

  param acheck

  type acheck

  Interface_Check

  rtype

  bool

BeginRead()

• Fills model’s header; each Interface defines for its Model its own file header; this method fills it from FileReaderTool.+ It is called by AnalyseFile from InterfaceModel

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  void

Clear()

• Clear filelds

  rtype

  None

Data()

• Returns the FileReaderData which is used to work

  rtype

  opencascade::handle<Interface_FileReaderData>

EndRead()

• Ends file reading after reading all the entities default is doing nothing; redefinable as necessary

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  void

LoadModel()

• Reads and fills Entities from the FileReaderData set by SetData to an InterfaceModel. It enchains required operations, the specific ones correspond to deferred methods (below) to be defined for each Norm. It manages also error recovery and trace. Remarkit calls SetModel. It Can raise any error which can occur during a load operation, unless Error Handling is set. This method can also be redefined if judged necessary.

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None

LoadedEntity()

• Reads, Fills and Returns one Entity read from a Record of the FileReaderData. This Method manages also case of Fail or Warning, by producing a ReportEntyty plus , for a Fail, a literal Content (as an UnknownEntity). Performs also Trace

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

Messenger()

• Returns Messenger used for outputting messages. The returned object is guaranteed to be non-null; default is Message::Messenger().

  rtype

  opencascade::handle<Message_Messenger>

Model()

• Returns the stored Model

  rtype

  opencascade::handle<Interface_InterfaceModel>

NewModel()

• Creates an empty Model of the norm. Uses Protocol to do it

  rtype

  opencascade::handle<Interface_InterfaceModel>

Protocol()

• Returns the Protocol given at creation time

  rtype

  opencascade::handle<Interface_Protocol>

Recognize()

• Recognizes a record, given its number. Specific to each Interface; called by SetEntities. It can call the basic method RecognizeByLib. Returns False if recognition has failed, True else. <ach> has not to be filled if simply Recognition has failedit must record true error messagesRecognizeByLib can generate error messages if NewRead is called //! Note that it works thru a Recognizer (method Evaluate) which has to be memorized before starting

  param num

  type num

  int

  param ach

  type ach

  Interface_Check

  param ent

  type ent

  Standard_Transient

  rtype

  bool

RecognizeByLib()

• Recognizes a record with the help of Libraries. Can be used to implement the method Recognize. <rlib> is used to find Protocol and CaseNumber to apply <glib> performs the creation (by service NewVoid, or NewRead if NewVoid gave no result) <ach> is a check, which is transmitted to NewRead if it is called, gives a result but which is false <ent> is the result Returns False if recognition has failed, True else

  param num

  type num

  int

  param glib

  type glib

  Interface_GeneralLib

  param rlib

  type rlib

  Interface_ReaderLib

  param ach

  type ach

  Interface_Check

  param ent

  type ent

  Standard_Transient

  rtype

  bool

SetData()

• Sets Data to a FileReaderData. Works with a Protocol

  param reader

  type reader

  Interface_FileReaderData

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None

SetEntities()

• Fills records with empty entities; once done, each entity can ask the FileReaderTool for any entity referenced through an identifier. Calls Recognize which is specific to each specific type of FileReaderTool

  rtype

  None

SetMessenger()

• Sets Messenger used for outputting messages

  param messenger

  type messenger

  Message_Messenger

  rtype

  None

SetModel()

• Stores a Model. Used when the Model has been loaded

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None

SetTraceLevel()

• Sets trace level used for outputting messages - 0: no trace at all - 1: errors - 2: errors and warnings - 3: all messages Default is 1Errors traced

  param tracelev

  type tracelev

  int

  rtype

  None

TraceLevel()

• Returns trace level used for outputting messages.

  rtype

  int

UnknownEntity()

• Provides an unknown entity, specific to the Interface called by SetEntities when Recognize has failed (Unknown alone) or by LoadModel when an Entity has caused a Fail on reading (to keep at least its literal description) Uses Protocol to do it

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Interface_FloatWriter(*args)

Bases: object

• Creates a FloatWriter ready to work, with default options - - zero suppress option is set - main format is set to ‘%E’ - secondary format is set to ‘%f’ for values between 0.1 and 1000. in absolute values If <chars> is given (and positive), it will produce options to produce this count of characters‘%<chars>f’,’%<chars>%E’

  param chars

  default value is 0

  type chars

  int

  rtype

  None

static Convert()

• This class method converts a Real Value to a string, given options given as arguments. It can be called independantly. Warningeven if declared in, content of <text> will be modified

  param val

  type val

  float

  param text

  type text

  char *

  param zerosup

  type zerosup

  bool

  param Range1

  type Range1

  float

  param Range2

  type Range2

  float

  param mainform

  type mainform

  char *

  param rangeform

  type rangeform

  char *

  rtype

  int

FormatForRange()

• Returns the format for range, if set Meaningful only if <range> from Options is True was C++return const

  rtype

  char *

MainFormat()

• Returns the main format was C++return const

  rtype

  char *

Options()

• Returns active options<zerosup> is the option ZeroSuppress, <range> is True if a range is set, False else R1,R2 give the range (if it is set)

  param zerosup

  type zerosup

  bool

  param range

  type range

  bool

  param R1

  type R1

  float

  param R2

  type R2

  float

  rtype

  None

SetDefaults()

• Sets again options to the defaults given by Create

  param chars

  default value is 0

  type chars

  int

  rtype

  None

SetFormat()

• Sets a specific Format for Sending Reals (main format) (Default from Creation is ‘%E’) If <reset> is given True (default), this call clears effects of former calls to SetFormatForRange and SetZeroSuppress

  param form

  type form

  char *

  param reset

  default value is Standard_True

  type reset

  bool

  rtype

  None

SetFormatForRange()

• Sets a secondary Format for Real, to be applied between R1 and R2 (in absolute values). A Call to SetRealForm cancels this secondary form if <reset> is True. (Default from Creation is ‘%f’ between 0.1 and 1000.) Warningif the condition (0. <= R1 < R2) is not fulfilled, this secondary form is canceled.

  param form

  type form

  char *

  param R1

  type R1

  float

  param R2

  type R2

  float

  rtype

  None

SetZeroSuppress()

• Sets Sending Real Parameters to suppress trailing Zeros and Null Exponant (‘E+00’), if <mode> is given True, Resets this mode if <mode> is False (in addition to Real Forms) A call to SetRealFrom resets this mode to False ig <reset> is given True (Default from Creation is True)

  param mode

  type mode

  bool

  rtype

  None

Write()

• Writes a Real value <val> to a string <text> by using the options. Returns the useful Length of produced string. It calls the class method Convert. Warning<text> is assumed to be wide enough (20-30 is correct) And, even if declared in, its content will be modified

  param val

  type val

  float

  param text

  type text

  char *

  rtype

  int

property thisown

The membership flag

class Interface_GTool(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty, not set, GTool

  rtype

  None* Creates a GTool from a Protocol Optional starting count of entities

  param proto

  type proto

  Interface_Protocol

  param nbent

  default value is 0

  type nbent

  int

  rtype

  None

ClearEntities()

• Clears the maps which record, for each already recorded entity its Module and Case Number

  rtype

  None

static DownCast(t)

Lib()

• Returns the GeneralLib itself

  rtype

  Interface_GeneralLib

Protocol()

• Returns the Protocol. Warningit can be Null

  rtype

  opencascade::handle<Interface_Protocol>

Reservate()

• Reservates maps for a count of entities <enforce> Falseminimum count <enforce> Trueclears former reservations Does not clear the maps

  param nb

  type nb

  int

  param enforce

  default value is Standard_False

  type enforce

  bool

  rtype

  None

Select()

• Selects for an entity, its Module and Case Number It is optimisedonce done for each entity, the result is mapped and the GeneralLib is not longer queried <enforce> True overpasses this optimisation

  param ent

  type ent

  Standard_Transient

  param gmod

  type gmod

  Interface_GeneralModule

  param CN

  type CN

  int

  param enforce

  default value is Standard_False

  type enforce

  bool

  rtype

  bool

SetProtocol()

• Sets a new Protocol if <enforce> is False and the new Protocol equates the old one then nothing is done

  param proto

  type proto

  Interface_Protocol

  param enforce

  default value is Standard_False

  type enforce

  bool

  rtype

  None

SetSignType()

• Sets a new SignType

  param sign

  type sign

  Interface_SignType

  rtype

  None

SignName()

• Returns the Name of the SignType, or ‘Class Name’

  rtype

  char *

SignType()

• Returns the SignType. Can be null

  rtype

  opencascade::handle<Interface_SignType>

SignValue()

• Returns the Signature for a Transient Object in a Model It calls SignType to do that If SignType is not defined, return ClassName of <ent>

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  char *

property thisown

The membership flag

class Interface_GeneralLib(*args)

Bases: object

• Creates a Library which complies with a Protocol, that isSame class (criterium IsInstance) This creation gets the Modules from the global set, those which are bound to the given Protocol and its Resources

  param aprotocol

  type aprotocol

  Interface_Protocol

  rtype

  None* Creates an empty Library : it will later by filled by method AddProtocol

  rtype

  None

AddProtocol()

• Adds a couple (Module-Protocol) to the Library, given the class of a Protocol. Takes Resources into account. (if <aprotocol> is not of type TheProtocol, it is not added)

  param aprotocol

  type aprotocol

  Standard_Transient

  rtype

  None

Clear()

• Clears the list of Modules of a library (can be used to redefine the order of Modules before actionClear then refill the Library by calls to AddProtocol)

  rtype

  None

Module()

• Returns the current Module in the Iteration

  rtype

  opencascade::handle<Interface_GeneralModule>

More()

• Returns True if there are more Modules to iterate on

  rtype

  bool

Next()

• Iterates by getting the next Module in the list If there is none, the exception will be raised by Value

  rtype

  None

Protocol()

• Returns the current Protocol in the Iteration

  rtype

  opencascade::handle<Interface_Protocol>

Select()

• Selects a Module from the Library, given an Object. Returns True if Select has succeeded, False else. Also Returns (as arguments) the selected Module and the Case Number determined by the associated Protocol. If Select has failed, <module> is Null Handle and CN is zero. (Select can work on any criterium, such as Object DynamicType)

  param obj

  type obj

  Standard_Transient

  param module

  type module

  Interface_GeneralModule

  param CN

  type CN

  int

  rtype

  bool

SetComplete()

• Sets a library to be defined with the complete Global list (all the couples Protocol/Modules recorded in it)

  rtype

  None

static SetGlobal()

• Adds a couple (Module-Protocol) into the global definition set for this class of Library.

  param amodule

  type amodule

  Interface_GeneralModule

  param aprotocol

  type aprotocol

  Interface_Protocol

  rtype

  void

Start()

• Starts Iteration on the Modules (sets it on the first one)

  rtype

  None

property thisown

The membership flag

class Interface_GeneralModule(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

CanCopy()

• Specific answer to the question ‘is Copy properly implemented’ Remark that it should be in phase with the implementation of NewVoid+CopyCase/NewCopyCase Default returns always False, can be redefined

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  rtype

  bool

CategoryNumber()

• Returns a category number which characterizes an entity Category Numbers are managed by the class Category <shares> can be used to evaluate this number in the context Default returns 0 which means ‘unspecified’

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  param shares

  type shares

  Interface_ShareTool

  rtype

  int

CheckCase()

• Specific Checking of an Entity <ent> Can check context queried through a ShareTool, as required

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  param shares

  type shares

  Interface_ShareTool

  param ach

  type ach

  Interface_Check

  rtype

  void

CopyCase()

• Specific Copy (‘Deep’) from <entfrom> to <entto> (same type) by using a CopyTool which provides its working Map. Use method Transferred from CopyTool to work

  param CN

  type CN

  int

  param entfrom

  type entfrom

  Standard_Transient

  param entto

  type entto

  Standard_Transient

  param TC

  type TC

  Interface_CopyTool

  rtype

  void

Dispatch()

• Dispatches an entity Returns True if it works by copy, False if it just duplicates the starting Handle //! Dispatching means producing a new entity, image of the starting one, in order to be put into a new Model, this Model being itself the result of a dispatch from an original Model //! According to the cases, dispatch can either * just return <entto> as equating <entfrom> -> the new model designates the starting entityit is lighter, but the dispatched entity being shared might not be modified for dispatch * copy <entfrom> to <entto> by calling NewVoid+CopyCase (two steps) or NewCopiedCase (1) -> the dispatched entity is a COPY, hence it can be modified //! The provided default just duplicates the handle without copying, then returns False. Can be redefined

  param CN

  type CN

  int

  param entfrom

  type entfrom

  Standard_Transient

  param entto

  type entto

  Standard_Transient

  param TC

  type TC

  Interface_CopyTool

  rtype

  bool

static DownCast(t)

FillShared()

• Specific filling of the list of Entities shared by an Entity <ent>, according a Case Number <CN> (formerly computed by CaseNum), considered in the context of a Model <model> Default calls FillSharedCase (i.e., ignores the model) Can be redefined to use the model for working

  param model

  type model

  Interface_InterfaceModel

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  param iter

  type iter

  Interface_EntityIterator

  rtype

  void

FillSharedCase()

• Specific filling of the list of Entities shared by an Entity <ent>, according a Case Number <CN> (formerly computed by CaseNum). Can use the internal utility method Share, below

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  param iter

  type iter

  Interface_EntityIterator

  rtype

  void

ListImplied()

• List the Implied References of <ent> considered in the context of a Model <model>i.e. the Entities which are Referenced while not considered as Shared (not copied if <ent> is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillShared + ListImplied give the complete list of References Default calls ListImpliedCase (i.e. ignores the model) Can be redefined to use the model for working

  param model

  type model

  Interface_InterfaceModel

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  param iter

  type iter

  Interface_EntityIterator

  rtype

  void

ListImpliedCase()

• List the Implied References of <ent> (see above) are Referenced while not considered as Shared (not copied if <ent> is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillSharedCase + ListImpliedCase give the complete list of Referenced Entities The provided default method does nothing (Implied References are specific of a little amount of Entity Classes).

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  param iter

  type iter

  Interface_EntityIterator

  rtype

  void

Name()

• Determines if an entity brings a Name (or widerly, if a Name can be attached to it, through the ShareTool By default, returns a Null opencascade::handle<nonamecanbeproduced> Can be redefined //! WarningWhile this string may be edited on the spot, if it is a read field, the returned value must be copied before.

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  param shares

  type shares

  Interface_ShareTool

  rtype

  opencascade::handle<TCollection_HAsciiString>

NewCopiedCase()

• Specific operator (create+copy) defaulted to do nothing. It can be redefinedWhen it is not possible to work in two steps (NewVoid then CopyCase). This can occur when there is no default constructorhence the result <entto> must be created with an effective definition. Remarkif NewCopiedCase is defined, CopyCase has nothing to do Returns True if it has produced something, false else

  param CN

  type CN

  int

  param entfrom

  type entfrom

  Standard_Transient

  param entto

  type entto

  Standard_Transient

  param TC

  type TC

  Interface_CopyTool

  rtype

  bool

NewVoid()

• Creates a new void entity <entto> according to a Case Number This entity remains to be filled, by reading from a file or by copying from another entity of same type (see CopyCase)

  param CN

  type CN

  int

  param entto

  type entto

  Standard_Transient

  rtype

  bool

RenewImpliedCase()

• Specific Copying of Implied References A Default is provided which does nothing (must current case !) Already copied references (by CopyFrom) must remain unchanged Use method Search from CopyTool to work

  param CN

  type CN

  int

  param entfrom

  type entfrom

  Standard_Transient

  param entto

  type entto

  Standard_Transient

  param TC

  type TC

  Interface_CopyTool

  rtype

  void

Share()

• Adds an Entity to a Shared List (uses GetOneItem on <iter>)

  param iter

  type iter

  Interface_EntityIterator

  param shared

  type shared

  Standard_Transient

  rtype

  None

WhenDeleteCase()

• Prepares an entity to be deleted. What does it meanBasically, any class of entity may define its own destructor By default, it does nothing but calling destructors on fields With the Memory Manager, it is useless to call destructor, it is done automatically when the Handle is nullified(cleared) BUT this is ineffective in looping structures (whatever these are ‘Implied’ references or not). //! THUSif no loop may appear in definitions, a class which inherits from TShared is correctly managed by automatic way BUT if there can be loops (or simply back pointers), they must be broken, for instance by clearing fields of one of the nodes The default does nothing, to be redefined if a loop can occur (Implied generally requires WhenDelete, but other cases can occur) //! Warning<dispatched> tells if the entity to be deleted has been produced by Dispatch or not. Hence WhenDelete must be in coherence with Dispatch Dispatch can either copy or not. If it copies the entity, this one should be deleted If it doesnt (i.e. duplicates the handle) nothing to do //! If <dispatch> is False, normal deletion is to be performed

  param CN

  type CN

  int

  param ent

  type ent

  Standard_Transient

  param dispatched

  type dispatched

  bool

  rtype

  void

property thisown

The membership flag

class Interface_GlobalNodeOfGeneralLib(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty GlobalNode, with no Next

  rtype

  None

Add()

• Adds a Module bound with a Protocol to the listdoes nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required) Once added, stores its attached Protocol in correspondance

  param amodule

  type amodule

  Interface_GeneralModule

  param aprotocol

  type aprotocol

  Interface_Protocol

  rtype

  None

static DownCast(t)

Module()

• Returns the Module stored in a given GlobalNode

  rtype

  opencascade::handle<Interface_GeneralModule>

Next()

• Returns the Next GlobalNode. If none is defined, returned value is a Null Handle

  rtype

  opencascade::handle<Interface_GlobalNodeOfGeneralLib>

Protocol()

• Returns the attached Protocol stored in a given GlobalNode

  rtype

  opencascade::handle<Interface_Protocol>

property thisown

The membership flag

class Interface_GlobalNodeOfReaderLib(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty GlobalNode, with no Next

  rtype

  None

Add()

• Adds a Module bound with a Protocol to the listdoes nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required) Once added, stores its attached Protocol in correspondance

  param amodule

  type amodule

  Interface_ReaderModule

  param aprotocol

  type aprotocol

  Interface_Protocol

  rtype

  None

static DownCast(t)

Module()

• Returns the Module stored in a given GlobalNode

  rtype

  opencascade::handle<Interface_ReaderModule>

Next()

• Returns the Next GlobalNode. If none is defined, returned value is a Null Handle

  rtype

  opencascade::handle<Interface_GlobalNodeOfReaderLib>

Protocol()

• Returns the attached Protocol stored in a given GlobalNode

  rtype

  opencascade::handle<Interface_Protocol>

property thisown

The membership flag

class Interface_Graph(*args)

Bases: object

• Creates an empty graph, ready to receive Entities from amodel Note that this way of Creation allows <self> 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

  param amodel

  type amodel

  Interface_InterfaceModel

  param lib

  type lib

  Interface_GeneralLib

  param theModeStats

  default value is Standard_True

  type theModeStats

  bool

  rtype

  None* Same as above, but the Library is defined through a Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  param theModeStats

  default value is Standard_True

  type theModeStats

  bool

  rtype

  None* Same as above, but the Library is defined through a Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  param gtool

  type gtool

  Interface_GTool

  param theModeStats

  default value is Standard_True

  type theModeStats

  bool

  rtype

  None* Same a above but works with the Protocol recorded in the Model

  param amodel

  type amodel

  Interface_InterfaceModel

  param theModeStats

  default value is Standard_True

  type theModeStats

  bool

  rtype

  None* 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

  param agraph

  type agraph

  Interface_Graph

  param copied

  default value is Standard_False

  type copied

  bool

  rtype

  None

BitMap()

• Returns the Bit Map in order to read or edit flag values

  rtype

  Interface_BitMap

CBitMap()

• Returns the Bit Map in order to edit it (add new flags)

  rtype

  Interface_BitMap

ChangeStatus()

• Changes all status which value is oldstat to new value newstat

  param oldstat

  type oldstat

  int

  param newstat

  type newstat

  int

  rtype

  None

Entity()

• Returns mapped Entity given its no (if it is present)

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

EntityNumber()

• 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 <self> (that is, <ent> is unknown from <self>)

  param ent

  type ent

  Standard_Transient

  rtype

  int

GetFromEntity()

• 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

  param ent

  type ent

  Standard_Transient

  param shared

  type shared

  bool

  param newstat

  default value is 0

  type newstat

  int

  rtype

  None* 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 : - 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)

  param ent

  type ent

  Standard_Transient

  param shared

  type shared

  bool

  param newstat

  type newstat

  int

  param overlapstat

  type overlapstat

  int

  param cumul

  type cumul

  bool

  rtype

  None

GetFromGraph()

• Gets all present items from another graph

  param agraph

  type agraph

  Interface_Graph

  rtype

  None* Gets items from another graph which have a specific Status

  param agraph

  type agraph

  Interface_Graph

  param stat

  type stat

  int

  rtype

  None

GetFromIter()

• 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

  param iter

  type iter

  Interface_EntityIterator

  param newstat

  type newstat

  int

  rtype

  None* Gets Entities given by an EntityIterator and distinguishes those already present in the Graph : - 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)

  param iter

  type iter

  Interface_EntityIterator

  param newstat

  type newstat

  int

  param overlapstat

  type overlapstat

  int

  param cumul

  type cumul

  bool

  rtype

  None

GetFromModel()

• Loads Graph with all Entities contained in the Model

  rtype

  None

GetShareds()

• Returns the sequence of Entities Shared by an Entity

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

GetSharings()

• Returns the sequence of Entities Sharings by an Entity

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

HasShareErrors()

• Returns True if <ent> or the list of entities shared by <ent> (not redefined) contains items unknown from this Graph Remarkapart from the status HasShareError, these items are ignored

  param ent

  type ent

  Standard_Transient

  rtype

  bool

IsPresent()

• 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

  param num

  type num

  int

  rtype

  bool* 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

  param ent

  type ent

  Standard_Transient

  rtype

  bool

ModeStat()

• Returns mode resposible for computation of statuses;

  rtype

  bool

Model()

• Returns the Model with which this Graph was created

  rtype

  opencascade::handle<Interface_InterfaceModel>

Name()

• 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

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TCollection_HAsciiString>

NbStatuses()

• Returns size of array of statuses

  rtype

  int

RemoveItem()

• Clears Entity and sets Status to 0, for a numero

  param num

  type num

  int

  rtype

  None

RemoveStatus()

• Removes all items of which status has a given value stat

  param stat

  type stat

  int

  rtype

  None

Reset()

• Erases data, making graph ready to rebegin from void (also resets Shared lists redefinitions)

  rtype

  None

ResetStatus()

• Erases Status (Values and Flags of Presence), making graph ready to rebegin from void. Does not concerns Shared lists

  rtype

  None

RootEntities()

• Returns the Entities which are not Shared (their Sharing List is empty) in the Model

  rtype

  Interface_EntityIterator

SetStatus()

• Modifies Status associated to a numero

  param num

  type num

  int

  param stat

  type stat

  int

  rtype

  None

Shareds()

• 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

  param ent

  type ent

  Standard_Transient

  rtype

  Interface_EntityIterator

SharingTable()

• Returns the Table of Sharing lists. Used to Create another Graph from <self>

  rtype

  opencascade::handle<TColStd_HArray1OfListOfInteger>

Sharings()

• Returns the list of Entities which Share an Entity, computed from the Basic or Redefined Shared Lists

  param ent

  type ent

  Standard_Transient

  rtype

  Interface_EntityIterator

Size()

• Returns size (max nb of entities, i.e. Model’s nb of entities)

  rtype

  int

Status()

• Returns Status associated to a numero (only to read it)

  param num

  type num

  int

  rtype

  int

TypedSharings()

• 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

  param ent

  type ent

  Standard_Transient

  param type

  type type

  Standard_Type

  rtype

  Interface_EntityIterator

property thisown

The membership flag

class Interface_GraphContent(*args)

Bases: OCC.Core.Interface.Interface_EntityIterator

• Creates an empty GraphContent, ready to be filled

  rtype

  None* Creates with all entities designated by a Graph

  param agraph

  type agraph

  Interface_Graph

  rtype

  None* Creates with entities having specific Status value in a Graph

  param agraph

  type agraph

  Interface_Graph

  param stat

  type stat

  int

  rtype

  None* Creates an Iterator with Shared entities of an entity (equivalente to EntityIterator but with a Graph)

  param agraph

  type agraph

  Interface_Graph

  param ent

  type ent

  Standard_Transient

  rtype

  None

Begin()

• Does the Evaluation before starting the iteration itself (in out)

  rtype

  None

Evaluate()

• Evaluates list of Entities to be iterated. Called by Start Default is set to doing nothingintended to be redefined by each sub-class

  rtype

  void

GetFromGraph()

• Gets all Entities designated by a Graph (once created), adds them to those already recorded

  param agraph

  type agraph

  Interface_Graph

  rtype

  None* Gets entities from a graph which have a specific Status value (one created), adds them to those already recorded

  param agraph

  type agraph

  Interface_Graph

  param stat

  type stat

  int

  rtype

  None

Result()

• Returns Result under the exact form of an EntityIteratorCan be used when EntityIterator itself is required (as a returned value for instance), whitout way for a sub-class

  rtype

  Interface_EntityIterator

property thisown

The membership flag

class Interface_HArray1OfHAsciiString(*args)

Bases: OCC.Core.Interface.Interface_Array1OfHAsciiString, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Array1()

ChangeArray1()

static DownCast(t)

property thisown

The membership flag

class Interface_HGraph(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an HGraph directly from a Graph. Remark that the starting Graph is duplicated

  param agraph

  type agraph

  Interface_Graph

  rtype

  None* Creates an HGraph with a Graph created from <amodel> and <lib>

  param amodel

  type amodel

  Interface_InterfaceModel

  param lib

  type lib

  Interface_GeneralLib

  param theModeStats

  default value is Standard_True

  type theModeStats

  bool

  rtype

  None* Creates an HGraph with a graph itself created from <amodel> and <protocol>

  param amodel

  type amodel

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  param theModeStats

  default value is Standard_True

  type theModeStats

  bool

  rtype

  None* Creates an HGraph with a graph itself created from <amodel> and <protocol>

  param amodel

  type amodel

  Interface_InterfaceModel

  param gtool

  type gtool

  Interface_GTool

  param theModeStats

  default value is Standard_True

  type theModeStats

  bool

  rtype

  None* Same a above, but works with the GTool in the model

  param amodel

  type amodel

  Interface_InterfaceModel

  param theModeStats

  default value is Standard_True

  type theModeStats

  bool

  rtype

  None

CGraph()

• Same as above, but for Read-Write Operations Then, The Graph will be modified in the HGraph itself

  rtype

  Interface_Graph

static DownCast(t)

Graph()

• Returns the Graph contained in <self>, for Read Only Operations Remark that it is returns as ‘const &’ Getting it in a new variable instead of a reference would be a pitty, because all the graph’s content would be duplicated

  rtype

  Interface_Graph

property thisown

The membership flag

class Interface_HSequenceOfCheck(*args)

Bases: OCC.Core.Interface.Interface_SequenceOfCheck, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Append()

ChangeSequence()

static DownCast(t)

Sequence()

property thisown

The membership flag

class Interface_IndexedMapOfAsciiString(*args)

Bases: object

Add()

Assign()

Clear()

Contains()

Exchange()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Set()

Size()

Substitute()

Swap()

cbegin()

cend()

property thisown

The membership flag

class Interface_IntList(*args)

Bases: object

• Creates empty IntList.

  rtype

  None* Creates an IntList for <nbe> entities

  param nbe

  type nbe

  int

  rtype

  None* Creates an IntList from another one. if <copied> is True, copies data else, data are not copied, only the header object is

  param other

  type other

  Interface_IntList

  param copied

  type copied

  bool

  rtype

  None

Add()

• Adds a reference (as an integer value, an entity number) to the current entity number. Zero is ignored

  param ref

  type ref

  int

  rtype

  None

AdjustSize()

• Resizes lists to exact sizes. For list of refs, a positive margin can be added.

  param margin

  default value is 0

  type margin

  int

  rtype

  None

Clear()

• Clears all data, hence each entity number has an empty list

  rtype

  None

Initialize()

• Initialize IntList by number of entities.

  param nbe

  type nbe

  int

  rtype

  None

Internals()

• Returns internal values, used for copying

  param nbrefs

  type nbrefs

  int

  param ents

  type ents

  TColStd_HArray1OfInteger

  param refs

  type refs

  TColStd_HArray1OfInteger

  rtype

  None

IsRedefined()

• Returns True if the list for a number (default is taken as current) is ‘redefined’ (usefull for empty list)

  param num

  default value is 0

  type num

  int

  rtype

  bool

Length()

• Returns the count of refs attached to current entity number

  rtype

  int

List()

• Returns an IntList, identical to <self> but set to a specified entity Number By default, not copied (in order to be read) Specified <copied> to produce another list and edit it

  param number

  type number

  int

  param copied

  default value is Standard_False

  type copied

  bool

  rtype

  Interface_IntList

NbEntities()

• Returns count of entities to be aknowledged

  rtype

  int

Number()

• Returns the current entity number

  rtype

  int

Remove()

• Removes an item in the list for current number, given its rank Returns True if done, False else

  param num

  type num

  int

  rtype

  bool

Reservate()

• Makes a reservation for <count> references to be later attached to the current entity. If required, it increases the size of array used to store refs. Remark that if count is less than two, it does nothing (because immediate storing)

  param count

  type count

  int

  rtype

  None

SetNbEntities()

• Changes the count of entities (ignored if decreased)

  param nbe

  type nbe

  int

  rtype

  None

SetNumber()

• Sets an entity number as current (for read and fill)

  param number

  type number

  int

  rtype

  None

SetRedefined()

• Sets current entity list to be redefined or not This is used in a Graph for redefinition listit can be disable (no redefinition, i.e. list is cleared), or enabled (starts as empty). The original list has not to be ‘redefined’

  param mode

  type mode

  bool

  rtype

  None

Value()

• Returns a reference number in the list for current number, according to its rank

  param num

  type num

  int

  rtype

  int

property thisown

The membership flag

class Interface_IntVal(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None

static DownCast(t)

GetCValue(Interface_IntVal self) → Standard_Integer

SetCValue(Interface_IntVal self, Standard_Integer value)

Value()

Return type

int

property thisown

The membership flag

class Interface_InterfaceModel(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

AddEntity()

• Internal method for adding an Entity. Used by file reading (defined by each Interface) and Transfer tools. It adds the entity required to be added, not its refssee AddWithRefs. If <anentity> is a ReportEntity, it is added to the list of Reports, its Concerned Entity (Erroneous or Corrected, else Unknown) is added to the list of Entities. That is, the ReportEntity must be created before Adding

  param anentity

  type anentity

  Standard_Transient

  rtype

  void

AddReportEntity()

• Adds a ReportEntity as such. Returns False if the concerned entity is not recorded in the Model Else, adds it into, either the main report list or the list for semantic checks, then returns True

  param rep

  type rep

  Interface_ReportEntity

  param semantic

  default value is Standard_False

  type semantic

  bool

  rtype

  bool

AddWithRefs()

• Adds to the Model, an Entity with all its References, as they are defined by General Services FillShared and ListImplied. Process is recursive (any sub-levels) if <level> = 0 (Default) Else, adds sub-entities until the required sub-level. Especially, if <level> = 1, adds immediate subs and that’s all //! If <listall> is False (Default), an entity (<anentity> itself or one of its subs at any level) which is already recorded in the Model is not analysed, only the newly added ones are. If <listall> is True, all items are analysed (this allows to ensure the consistency of an adding made by steps)

  param anent

  type anent

  Standard_Transient

  param proto

  type proto

  Interface_Protocol

  param level

  default value is 0

  type level

  int

  param listall

  default value is Standard_False

  type listall

  bool

  rtype

  None* Same as above, but works with the Protocol of the Model

  param anent

  type anent

  Standard_Transient

  param level

  default value is 0

  type level

  int

  param listall

  default value is Standard_False

  type listall

  bool

  rtype

  None* Same as above, but works with an already created GeneralLib

  param anent

  type anent

  Standard_Transient

  param lib

  type lib

  Interface_GeneralLib

  param level

  default value is 0

  type level

  int

  param listall

  default value is Standard_False

  type listall

  bool

  rtype

  None

CategoryNumber()

• Returns the recorded category number for a given entity number 0 if none was defined for this entity

  param num

  type num

  int

  rtype

  int

ChangeOrder()

• Changes the Numbers of some Entities<oldnum> is moved to <newnum>, same for <count> entities. Thus1,2 … newnum-1 newnum … oldnum .. oldnum+count oldnum+count+1 .. gives 1,2 … newnum-1 oldnum .. oldnum+count newnum … oldnum+count+1 (can be seen as a circular permutation)

  param oldnum

  type oldnum

  int

  param newnum

  type newnum

  int

  param count

  default value is 1

  type count

  int

  rtype

  None

Check()

• Returns the check attached to an entity, designated by its Number. 0 for global check <semantic> Truerecorded semantic check <semantic> Falserecorded syntactic check (see ReportEntity) If no check is recorded for <num>, returns an empty Check

  param num

  type num

  int

  param syntactic

  type syntactic

  bool

  rtype

  opencascade::handle<Interface_Check>

static ClassName()

• From a CDL Type Name, returns the Class part (package dropped) WARNINGbuffered, to be immediately copied or printed

  param typnam

  type typnam

  char *

  rtype

  char *

Clear()

• Erases contained data; used when a Model is copied to othersthe new copied ones begin from clear Clear calls specific method ClearHeader (see below)

  rtype

  void

ClearEntities()

• Clears the entities; uses the general service WhenDelete, in addition to the standard Memory Manager; can be redefined

  rtype

  void

ClearHeader()

• Clears Model’s headerspecific to each norm

  rtype

  void

ClearLabels()

• Erases informations about labels, if anyspecific to each norm

  rtype

  void

ClearReportEntity()

• Removes the ReportEntity attached to Entity <num>. Returns True if done, False if no ReportEntity was attached to <num>. Warningthe caller must assume that this clearing is meaningfull

  param num

  type num

  int

  rtype

  bool

Contains()

• Returns True if a Model contains an Entity (for a ReportEntity, looks for the ReportEntity itself AND its Concerned Entity)

  param anentity

  type anentity

  Standard_Transient

  rtype

  bool

Destroy()

• Clears the list of entities (service WhenDelete)

  rtype

  None

static DownCast(t)

DumpHeader()

• Dumps Header in a short, easy to read, form, onto a Stream <level> allows to print more or less parts of the header, if necessary. 0 for basic print

  param S

  type S

  Message_Messenger

  param level

  default value is 0

  type level

  int

  rtype

  void

Entities()

• Returns the list of all Entities, as an Iterator on Entities (the Entities themselves, not the Reports)

  rtype

  Interface_EntityIterator

EntityState()

• Returns the State of an entity, given its number

  param num

  type num

  int

  rtype

  Interface_DataState

FillIterator()

• Allows an EntityIterator to get a list of Entities

  param iter

  type iter

  Interface_EntityIterator

  rtype

  None

FillSemanticChecks()

• Fills the list of semantic checks. This list is computed (by CheckTool). Hence, it can be stored in the model for later queries <clear> True (D)new list replaces <clear> Falsenew list is cumulated

  param checks

  type checks

  Interface_CheckIterator

  param clear

  default value is Standard_True

  type clear

  bool

  rtype

  None

GTool()

• Returns the GTool, set by SetProtocol or by SetGTool

  rtype

  opencascade::handle<Interface_GTool>

GetDispatchStatus(Interface_InterfaceModel self) → Standard_Boolean

GetFromAnother()

• Gets header (data specific of a defined Interface) from another InterfaceModel; called from TransferCopy

  param other

  type other

  Interface_InterfaceModel

  rtype

  void

GetFromTransfer()

• Gets contents from an EntityIterator, prepared by a Transfer tool (e.g TransferCopy). Starts from clear

  param aniter

  type aniter

  Interface_EntityIterator

  rtype

  None

GlobalCheck()

• Returns the GlobalCheck, which memorizes messages global to the file (not specific to an Entity), especially Header

  param syntactic

  default value is Standard_True

  type syntactic

  bool

  rtype

  opencascade::handle<Interface_Check>

HasSemanticChecks()

• Returns True if semantic checks have been filled

  rtype

  bool

static HasTemplate()

• Returns true if a template is attached to a given name

  param name

  type name

  char *

  rtype

  bool

IsErrorEntity()

• Returns True if <num> identifies an Error Entityin this case, a ReportEntity brings Fail Messages and possibly an ‘undefined’ Content, see IsRedefinedEntity

  param num

  type num

  int

  rtype

  bool

IsRedefinedContent()

• Returns True if <num> identifies an Entity which content is redefined through a ReportEntity (i.e. with literal data only) This happens when an entity is syntactically erroneous in the way that its basic content remains empty. For more details (such as content itself), see ReportEntity

  param num

  type num

  int

  rtype

  bool

IsReportEntity()

• Returns True if <num> identifies a ReportEntity in the Model Hence, ReportEntity can be called. //! By default, queries main report, if <semantic> is True, it queries report for semantic check //! Remember that a Report Entity can be defined for an Unknown Entity, or a Corrected or Erroneous (at read time) Entity. The ReportEntity is defined before call to method AddEntity.

  param num

  type num

  int

  param semantic

  default value is Standard_False

  type semantic

  bool

  rtype

  bool

IsUnknownEntity()

• Returns True if <num> identifies an Unknown Entityin this case, a ReportEntity with no Check Messages designates it.

  param num

  type num

  int

  rtype

  bool

static ListTemplates()

• Returns the complete list of names attached to template models

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

NbEntities()

• Returns count of contained Entities

  rtype

  int

NbTypes()

• Returns the count of DISTINCT types under which an entity may be processed. Defined by the Protocol, which gives default as 1 (dynamic Type).

  param ent

  type ent

  Standard_Transient

  rtype

  int

NewEmptyModel()

• Returns a New Empty Model, same type as <self> (whatever its Type); called to Copy parts a Model into other ones, then followed by a call to GetFromAnother (Header) then filling with specified Entities, themselves copied

  rtype

  opencascade::handle<Interface_InterfaceModel>

NextNumberForLabel()

• Searches a label which matches with one entity. Begins from <lastnum>+1 (default:1) and scans the entities until <NbEntities>. For the first which matches <label>, this method returns its Number. Returns 0 if nothing found Can be called recursively (labels are not specified as unique) <exact>if True (default), exact match is required else, checks the END of entity label //! This method is virtual, hence it can be redefined for a more efficient search (if exact is true).

  param label

  type label

  char *

  param lastnum

  default value is 0

  type lastnum

  int

  param exact

  default value is Standard_True

  type exact

  bool

  rtype

  int

Number()

• Returns the Number of an Entity in the Model if it contains it. Else returns 0. For a ReportEntity, looks at Concerned Entity. Returns the Directory entry Number of an Entity in the Model if it contains it. Else returns 0. For a ReportEntity, looks at Concerned Entity.

  param anentity

  type anentity

  Standard_Transient

  rtype

  int

Print()

• Prints identification of a given entity in <self>, in order to be printed in a list or phrase <mode> < 0prints only its number <mode> = 1just calls PrintLabel <mode> = 0 (D)prints its number plus ‘/’ plus PrintLabel If <ent> == <self>, simply prints ‘Global’ If <ent> is unknown, prints ‘/its type’

  param ent

  type ent

  Standard_Transient

  param s

  type s

  Message_Messenger

  param mode

  default value is 0

  type mode

  int

  rtype

  None

PrintLabel()

• Prints label specific to each norm, for a given entity. Must only print label itself, in order to be included in a phrase. Can call the result of StringLabel, but not obliged.

  param ent

  type ent

  Standard_Transient

  param S

  type S

  Message_Messenger

  rtype

  void

PrintToLog()

• Prints label specific to each norm in log format, for a given entity. By default, just calls PrintLabel, can be redefined

  param ent

  type ent

  Standard_Transient

  param S

  type S

  Message_Messenger

  rtype

  void

Protocol()

• Returns the Protocol which has been set by SetProtocol, or AddWithRefs with Protocol

  rtype

  opencascade::handle<Interface_Protocol>

Redefineds()

• Returns the list of ReportEntities which redefine data (generally, if concerned entity is ‘Error’, a literal content is added to itthis is a ‘redefined entity’

  rtype

  Interface_EntityIterator

ReplaceEntity()

• Replace Entity with Number=nument on other entity - ‘anent’

  param nument

  type nument

  int

  param anent

  type anent

  Standard_Transient

  rtype

  None

ReportEntity()

• Returns a ReportEntity identified by its number in the Model, or a Null Handle If <num> does not identify a ReportEntity. //! By default, queries main report, if <semantic> is True, it queries report for semantic check

  param num

  type num

  int

  param semantic

  default value is Standard_False

  type semantic

  bool

  rtype

  opencascade::handle<Interface_ReportEntity>

Reports()

• Returns the list of all ReportEntities, i.e. data about Entities read with Error or Warning informations (each item has to be casted to Report Entity then it can be queried for Concerned Entity, Content, Check …) By default, returns the main reports, is <semantic> is True it returns the list for sematic checks

  param semantic

  default value is Standard_False

  type semantic

  bool

  rtype

  Interface_EntityIterator

Reservate()

• Does a reservation for the List of Entities (for optimized storage management). If it is not called, storage management can be less efficient. <nbent> is the expected count of Entities to store

  param nbent

  type nbent

  int

  rtype

  void

ReverseOrders()

• Reverses the Numbers of the Entities, between <after> and the total count of Entities. Thus, the entities1,2 … after, after+1 … nb-1, nb become numbered as1,2 … after, nb, nb-1 … after+1 By default (after = 0) the whole list of Entities is reversed

  param after

  default value is 0

  type after

  int

  rtype

  None

SetCategoryNumber()

• Records a category number for an entity number Returns True when done, False if <num> is out of range

  param num

  type num

  int

  param val

  type val

  int

  rtype

  bool

SetDispatchStatus(Interface_InterfaceModel self, Standard_Boolean value)

SetGTool()

• Sets a GTool for this model, which already defines a Protocol

  param gtool

  type gtool

  Interface_GTool

  rtype

  None

SetGlobalCheck()

• Allows to modify GlobalCheck, after getting then completing it Remarkit is SYNTACTIC check. Semantics, see FillChecks

  param ach

  type ach

  Interface_Check

  rtype

  None

SetProtocol()

• Sets a Protocol for this Model It is also set by a call to AddWithRefs with Protocol It is used forDumpHeader (as required), ClearEntities …

  param proto

  type proto

  Interface_Protocol

  rtype

  None

SetReportEntity()

• Sets or Replaces a ReportEntity for the Entity <num>. Returns True if Report is replaced, False if it has been replaced Warningthe caller must assume that this setting is meaningfull

  param num

  type num

  int

  param rep

  type rep

  Interface_ReportEntity

  rtype

  bool

static SetTemplate()

• Records a new template model with a name. If the name was already recorded, the corresponding template is replaced by the new one. Then, WARNINGtest HasTemplate to avoid surprises

  param name

  type name

  char *

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool

StringLabel()

• Returns a string with the label attached to a given entity. WarningWhile this string may be edited on the spot, if it is a read field, the returned value must be copied before.

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TCollection_HAsciiString>

static Template()

• Returns the template model attached to a name, or a Null Handle

  param name

  type name

  char *

  rtype

  opencascade::handle<Interface_InterfaceModel>

Type()

• Returns a type, given its rankdefined by the Protocol (by default, the first one)

  param ent

  type ent

  Standard_Transient

  param num

  default value is 1

  type num

  int

  rtype

  opencascade::handle<Standard_Type>

TypeName()

• Returns the type name of an entity, from the list of types (one or more …) <complete> True (D) gives the complete type, else packages are removed WARNINGbuffered, to be immediately copied or printed

  param ent

  type ent

  Standard_Transient

  param complete

  default value is Standard_True

  type complete

  bool

  rtype

  char *

Value()

• Returns an Entity identified by its number in the Model Each sub-class of InterfaceModel can define its own method Entity to return its specific class of Entity (e.g. for VDA, VDAModel returns a VDAEntity), working by calling Value RemarkFor a Reported Entity, (Erroneous, Corrected, Unknown), this method returns this Reported Entity. See ReportEntity for other questions.

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

VerifyCheck()

• Minimum Semantic Global Check on data in model (header) Can only check basic Data. See also GlobalCheck from Protocol for a check which takes the Graph into account Default does nothing, can be redefined

  param ach

  type ach

  Interface_Check

  rtype

  void

property thisown

The membership flag

class Interface_LineBuffer(*args)

Bases: object

• Creates a LineBuffer with an absolute maximum size (Default value is only to satisfy compiler requirement)

  param size

  default value is 10

  type size

  int

  rtype

  None

Add()

• Adds a text as a CString. Its Length is evaluated from the text (by C function strlen)

  param text

  type text

  char *

  rtype

  None* Adds a text as a CString. Its length is given as <lntext>

  param text

  type text

  char *

  param lntext

  type lntext

  int

  rtype

  None* Adds a text as a AsciiString from TCollection

  param text

  type text

  TCollection_AsciiString

  rtype

  None* Adds a text made of only ONE Character

  param text

  type text

  Standard_Character

  rtype

  None

CanGet()

• Returns True if there is room enough to add <more> characters Else, it is required to Dump the Buffer before refilling it <more> is recorded to manage SetKeep status

  param more

  type more

  int

  rtype

  bool

Clear()

• Clears completely the LineBuffer

  rtype

  None

Content()

• Returns the Content of the LineBuffer

  rtype

  char *

FreezeInitial()

• Inhibits effect of SetInitial until the next Move (i.e. Keep) Then Prepare will not insert initial blanks, but further ones will. This allows to cancel initial blanks on an internal Split A call to SetInitial has no effect on this until Move

  rtype

  None

Length()

• Returns the Length of the LineBuffer

  rtype

  int

Move()

• Fills a AsciiString <str> with the Content of the Line Buffer, then Clears the LineBuffer

  param str

  type str

  TCollection_AsciiString

  rtype

  None* Same as above, but <str> is known through a Handle

  param str

  type str

  TCollection_HAsciiString

  rtype

  None

Moved()

• Same as above, but generates the HAsciiString

  rtype

  opencascade::handle<TCollection_HAsciiString>

SetInitial()

• Sets an Initial reservation for Blank characters (this reservation is counted in the size of the current Line)

  param initial

  type initial

  int

  rtype

  None

SetKeep()

• Sets a Keep Status at current Length. It means that at next Move, the new line will begin by characters between Keep + 1 and current Length

  rtype

  None

SetMax()

• Changes Maximum allowed size of Buffer. If <max> is Zero, Maximum size is set to the initial size.

  param max

  type max

  int

  rtype

  None

property thisown

The membership flag

class Interface_MSG(*args)

Bases: object

• A MSG is created to write a ‘functional code’ in conjunction with operator () attached to Value Then, to have a translated message, write in C++//! Interface_MSG(‘…mykey…’) which returns a CString See also some help which follow

  param key

  type key

  char *

  rtype

  None* Translates a message which contains one integer variable It is just a help which avoid the following : char mess[100]; sprintf(mess,Interface_MSG(‘code’),ival); then AddFail(mess); replaced by AddFail (Interface_MSG(‘code’,ival)); //! The basic message is intended to be in C-sprintf format, with one %d form in it

  param key

  type key

  char *

  param i1

  type i1

  int

  rtype

  None* Translates a message which contains two integer variables As for one integer, it is just a writing help //! The basic message is intended to be in C-sprintf format with two %d forms in it

  param key

  type key

  char *

  param i1

  type i1

  int

  param i2

  type i2

  int

  rtype

  None* Translates a message which contains one real variable <intervals> if set, commands the variable to be rounded to an interval (see below, method Intervals) As for one integer, it is just a writing help //! The basic message is intended to be in C-sprintf format with one %f form (or equivalent : %e etc) in it

  param key

  type key

  char *

  param r1

  type r1

  float

  param intervals

  default value is -1

  type intervals

  int

  rtype

  None* Translates a message which contains one string variable As for one integer, it is just a writing help //! The basic message is intended to be in C-sprintf format with one %s form in it

  param key

  type key

  char *

  param str

  type str

  char *

  rtype

  None* Translates a message which contains one integer and one string variables As for one integer, it is just a writing help Used for instance to say ‘Param n0.<ival> i.e. <str> is not..’ //! The basic message is intended to be in C-sprintf format with one %d then one %s forms in it

  param key

  type key

  char *

  param ival

  type ival

  int

  param str

  type str

  char *

  rtype

  None

static Blanks()

• Returns a blank string, of length between 0 and <max>, to fill the printing of a numeric value <val>, i.e.If val < 10 , max-1 blanks If val between 10 and 99, max-2 blanks … etc…

  param val

  type val

  int

  param max

  type max

  int

  rtype

  char ** Returns a blank string, to complete a given string <val> up to <max> characters : If strlen(val) is 0, max blanks If strlen(val) is 5, max-5 blanks etc…

  param val

  type val

  char *

  param max

  type max

  int

  rtype

  char ** Returns a blank string of <count> blanks (mini 0, maxi 76)

  param count

  type count

  int

  rtype

  char *

static CDate()

• Returns a value about comparison of two dates 0equal. <0 text1 anterior. >0 text1 posterior

  param text1

  type text1

  char *

  param text2

  type text2

  char *

  rtype

  int

Destroy()

• Optimised destructor (applies for additional forms of Create)

  rtype

  None

static Intervalled()

• Returns an ‘intervalled’ value from a starting real <val>i.e. a value which is rounded on an interval limit Interval limits are defined to be in a coarsely ‘geometric’ progression (two successive intervals are inside a limit ratio) //! <order> gives the count of desired intervals in a range <1-10> <upper> False, returns the first lower interval (D) <upper> True, returns the first upper interval Values of Intervals according <order>0,11 10 100 … 21 3 10 30 100 … 3(D): 1 2 5 10 20 50 100 … 41 2 3 6 10 20 30 60 100 … 61 1.5 2 3 5 7 10 15 20 … 101 1.2 1.5 2 2.5 3 4 5 6 8 10 12 15 20 25 …

  param val

  type val

  float

  param order

  default value is 3

  type order

  int

  param upper

  default value is Standard_False

  type upper

  bool

  rtype

  float

static IsKey()

• Returns True if a given message is surely a key (according to the form adopted for keys) (before activating messages, answer is false)

  param mess

  type mess

  char *

  rtype

  bool

static NDate()

• Decodes a date to numeric integer values Returns True if OK, False if text does not fit with required format. Incomplete forms are allowed (for instance, for only YYYY-MM-DD, hour is zero)

  param text

  type text

  char *

  param yy

  type yy

  int

  param mm

  type mm

  int

  param dd

  type dd

  int

  param hh

  type hh

  int

  param mn

  type mn

  int

  param ss

  type ss

  int

  rtype

  bool

static Print()

• Prints a String on an Output Stream, as followsAccompagned with blanks, to give up to <max> charis at all, justified according just-1 (D)left 0center 1right Maximum 76 characters

  param S

  type S

  Standard_OStream

  param val

  type val

  char *

  param max

  type max

  int

  param just

  default value is -1

  type just

  int

  rtype

  void

PrintTraceToString(Interface_MSG self) → std::string

static Read()

• Reads a list of messages from a file defined by its name

  param file

  type file

  char *

  rtype

  int

ReadFromString(Interface_MSG self, std::string src)

static Record()

• Fills the dictionary with a couple (key-item) If a key is already recorded, it is possible to- keep the last definition, and activate the trace system

  param key

  type key

  char *

  param item

  type item

  char *

  rtype

  void

static SetMode()

• Sets the main modes for MSG- if <running> is True, translation works normally - if <running> is False, translated item equate keys - if <raising> is True, errors (from Record or Translate) cause MSG to raise an exception - if <raising> is False, MSG runs without exception, then see also Trace Modes above

  param running

  type running

  bool

  param raising

  type raising

  bool

  rtype

  void

static SetTrace()

• Sets the trace system to work when activated, as follow- if <toprint> is True, print immediately on standard output - if <torecord> is True, record it for further print

  param toprint

  type toprint

  bool

  param torecord

  type torecord

  bool

  rtype

  void

static TDate()

• Codes a date as a text, from its numeric value (-> seconds)YYYY-MM-DD:HH-MN-SS fixed format, completed by leading zeros Another format can be provided, as followsC:%d … C like format, preceeded by C: S:… format to call system (not yet implemented)

  param text

  type text

  char *

  param yy

  type yy

  int

  param mm

  type mm

  int

  param dd

  type dd

  int

  param hh

  type hh

  int

  param mn

  type mn

  int

  param ss

  type ss

  int

  param format

  default value is

  type format

  char *

  rtype

  void

static Translated()

• Returns the item recorded for a key. Returns the key itself if- it is not recorded (then, the trace system is activated) - MSG has been required to be hung on

  param key

  type key

  char *

  rtype

  char *

Value()

• Returns the translated message, in a functional form with operator () was C++return const

  rtype

  char *

static Write()

• Writes the list of messages recorded to be translated, to a stream. Writes all the list (Default) or only keys which begin by <rootkey>. Returns the count of written messages

  param S

  type S

  Standard_OStream

  param rootkey

  default value is

  type rootkey

  char *

  rtype

  int

property thisown

The membership flag

class Interface_MapAsciiStringHasher

Bases: object

static HashCode()

• Computes a hash code for the given ASCII string, in the range [1, theUpperBound] @param theAsciiString the ASCII string which hash code is to be computed @param theUpperBound the upper bound of the range a computing hash code must be within returns a computed hash code, in the range [1, theUpperBound]

  param theAsciiString

  type theAsciiString

  TCollection_AsciiString

  param theUpperBound

  type theUpperBound

  int

  rtype

  int

static IsEqual()

Parameters

K1 –

type K1

TCollection_AsciiString

param K2

type K2

TCollection_AsciiString

rtype

bool

property thisown

The membership flag

class Interface_NodeOfGeneralLib(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty Node, with no Next

  rtype

  None

AddNode()

• Adds a couple (Module,Protocol), that is, stores it into itself if not yet done, else creates a Next Node to do it

  param anode

  type anode

  Interface_GlobalNodeOfGeneralLib

  rtype

  None

static DownCast(t)

Module()

• Returns the Module designated by a precise Node

  rtype

  opencascade::handle<Interface_GeneralModule>

Next()

• Returns the Next Node. If none was defined, returned value is a Null Handle

  rtype

  opencascade::handle<Interface_NodeOfGeneralLib>

Protocol()

• Returns the Protocol designated by a precise Node

  rtype

  opencascade::handle<Interface_Protocol>

property thisown

The membership flag

class Interface_NodeOfReaderLib(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty Node, with no Next

  rtype

  None

AddNode()

• Adds a couple (Module,Protocol), that is, stores it into itself if not yet done, else creates a Next Node to do it

  param anode

  type anode

  Interface_GlobalNodeOfReaderLib

  rtype

  None

static DownCast(t)

Module()

• Returns the Module designated by a precise Node

  rtype

  opencascade::handle<Interface_ReaderModule>

Next()

• Returns the Next Node. If none was defined, returned value is a Null Handle

  rtype

  opencascade::handle<Interface_NodeOfReaderLib>

Protocol()

• Returns the Protocol designated by a precise Node

  rtype

  opencascade::handle<Interface_Protocol>

property thisown

The membership flag

class Interface_ParamList(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an vector with size of memmory blok equal to theIncrement

  param theIncrement

  default value is 256

  type theIncrement

  int

  rtype

  None

ChangeValue()

• return the value of the <Index>th element of the array.

  param Index

  type Index

  int

  rtype

  Interface_FileParameter

Clear()

Return type

None

static DownCast(t)

Length()

• Returns the number of elements of <self>.

  rtype

  int

Lower()

• Returns the lower bound. Warning

  rtype

  int

SetValue()

• Assigns the value <Value> to the <Index>-th item of this array.

  param Index

  type Index

  int

  param Value

  type Value

  Interface_FileParameter

  rtype

  None

Upper()

• Returns the upper bound. Warning

  rtype

  int

Value()

• Return the value of the <Index>th element of the array.

  param Index

  type Index

  int

  rtype

  Interface_FileParameter

property thisown

The membership flag

class Interface_ParamSet(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty ParamSet, beginning at number ‘nst’ and of initial reservation ‘nres’the ‘nres’ first parameters which follow ‘ndeb’ (included) will be put in an Array (a ParamList). The remainders are set in Next(s) ParamSet(s)

  param nres

  type nres

  int

  param nst

  default value is 1

  type nst

  int

  rtype

  None

Append()

• Adds a parameter defined as its Value (CString and length) and Type. Optionnal EntityNumber (for FileReaderData) can be given Allows a better memory management than Appending a complete FileParameter If <lnval> < 0, <val> is assumed to be managed elsewhereits adress is stored as such. Else, <val> is copied in a locally (quickly) managed Page of Characters Returns new count of recorded Parameters

  param val

  type val

  char *

  param lnval

  type lnval

  int

  param typ

  type typ

  Interface_ParamType

  param nument

  type nument

  int

  rtype

  int* Adds a parameter at the end of the ParamSet (transparent about reservation and ‘Next’) Returns new count of recorded Parameters

  param FP

  type FP

  Interface_FileParameter

  rtype

  int

ChangeParam()

• Same as above, but in order to be modified on place

  param num

  type num

  int

  rtype

  Interface_FileParameter

Destroy()

• Destructor (waiting for transparent memory management)

  rtype

  None

static DownCast(t)

NbParams()

• Returns the total count of parameters (including nexts)

  rtype

  int

Param()

• Returns a parameter identified by its number

  param num

  type num

  int

  rtype

  Interface_FileParameter

Params()

• Builds and returns the sub-list correspinding to parameters, from ‘num’ included, with count ‘nb’ If <num> and <nb> are zero, returns the whole list

  param num

  type num

  int

  param nb

  type nb

  int

  rtype

  opencascade::handle<Interface_ParamList>

SetParam()

• Changes a parameter identified by its number

  param num

  type num

  int

  param FP

  type FP

  Interface_FileParameter

  rtype

  None

property thisown

The membership flag

class Interface_Protocol(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static Active()

• Returns the Active Protocol, if defined (else, returns a Null Handle, which means ‘no defined active protocol’)

  rtype

  opencascade::handle<Interface_Protocol>

CaseNumber()

• Returns a unique positive CaseNumber for each Recognized Object. By default, recognition is based on Type(1) By default, calls the following one which is deferred.

  param obj

  type obj

  Standard_Transient

  rtype

  int

static ClearActive()

• Erases the Active Protocol (hence it becomes undefined)

  rtype

  void

static DownCast(t)

GlobalCheck()

• Evaluates a Global Check for a model (with its Graph) Returns True when done, False if data in model do not apply //! Very specific of each norm, i.e. of each protocolthe uppest level Protocol assumes it, it can call GlobalCheck of its ressources only if it is necessary //! Default does nothing, can be redefined

  param G

  type G

  Interface_Graph

  param ach

  type ach

  Interface_Check

  rtype

  bool

IsDynamicType()

• Returns True if type of <obj> is that defined from CDL This is the default but it may change according implementation

  param obj

  type obj

  Standard_Transient

  rtype

  bool

IsSuitableModel()

• Returns True if <model> is a Model of the considered Norm

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool

IsUnknownEntity()

• Returns True if <ent> is an Unknown Entity for the Norm, i.e. same Type as them created by method UnknownEntity (for an Entity out of the Norm, answer can be unpredicable)

  param ent

  type ent

  Standard_Transient

  rtype

  bool

NbResources()

• Returns count of Protocol used as Resources (level one)

  rtype

  int

NbTypes()

• Returns the count of DISTINCT types under which an entity may be processed. Each one is candidate to be recognized by TypeNumber, <obj> is then processed according it By default, returns 1 (the DynamicType)

  param obj

  type obj

  Standard_Transient

  rtype

  int

NewModel()

• Creates an empty Model of the considered Norm

  rtype

  opencascade::handle<Interface_InterfaceModel>

Resource()

• Returns a Resource, given its rank (between 1 and NbResources)

  param num

  type num

  int

  rtype

  opencascade::handle<Interface_Protocol>

static SetActive()

• Sets a given Protocol to be the Active one (for the users of Active, see just above). Applies to every sub-type of Protocol

  param aprotocol

  type aprotocol

  Interface_Protocol

  rtype

  void

Type()

• Returns a type under which <obj> can be recognized and processed, according its rank in its definition list (see NbTypes). By default, returns DynamicType

  param obj

  type obj

  Standard_Transient

  param nt

  default value is 1

  type nt

  int

  rtype

  opencascade::handle<Standard_Type>

TypeNumber()

• Returns a unique positive CaseNumber for each Recognized Type, Returns Zero for ‘<type> not recognized’

  param atype

  type atype

  Standard_Type

  rtype

  int

UnknownEntity()

• Creates a new Unknown Entity for the considered Norm

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Interface_ReaderLib(*args)

Bases: object

• Creates a Library which complies with a Protocol, that isSame class (criterium IsInstance) This creation gets the Modules from the global set, those which are bound to the given Protocol and its Resources

  param aprotocol

  type aprotocol

  Interface_Protocol

  rtype

  None* Creates an empty Library : it will later by filled by method AddProtocol

  rtype

  None

AddProtocol()

• Adds a couple (Module-Protocol) to the Library, given the class of a Protocol. Takes Resources into account. (if <aprotocol> is not of type TheProtocol, it is not added)

  param aprotocol

  type aprotocol

  Standard_Transient

  rtype

  None

Clear()

• Clears the list of Modules of a library (can be used to redefine the order of Modules before actionClear then refill the Library by calls to AddProtocol)

  rtype

  None

Module()

• Returns the current Module in the Iteration

  rtype

  opencascade::handle<Interface_ReaderModule>

More()

• Returns True if there are more Modules to iterate on

  rtype

  bool

Next()

• Iterates by getting the next Module in the list If there is none, the exception will be raised by Value

  rtype

  None

Protocol()

• Returns the current Protocol in the Iteration

  rtype

  opencascade::handle<Interface_Protocol>

Select()

• Selects a Module from the Library, given an Object. Returns True if Select has succeeded, False else. Also Returns (as arguments) the selected Module and the Case Number determined by the associated Protocol. If Select has failed, <module> is Null Handle and CN is zero. (Select can work on any criterium, such as Object DynamicType)

  param obj

  type obj

  Standard_Transient

  param module

  type module

  Interface_ReaderModule

  param CN

  type CN

  int

  rtype

  bool

SetComplete()

• Sets a library to be defined with the complete Global list (all the couples Protocol/Modules recorded in it)

  rtype

  None

static SetGlobal()

• Adds a couple (Module-Protocol) into the global definition set for this class of Library.

  param amodule

  type amodule

  Interface_ReaderModule

  param aprotocol

  type aprotocol

  Interface_Protocol

  rtype

  void

Start()

• Starts Iteration on the Modules (sets it on the first one)

  rtype

  None

property thisown

The membership flag

class Interface_ReaderModule(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

CaseNum()

• Translates the type of record <num> in <data> to a positive Case Number. If Recognition fails, must return 0

  param data

  type data

  Interface_FileReaderData

  param num

  type num

  int

  rtype

  int

static DownCast(t)

NewRead()

• Specific operator (create+read) defaulted to do nothing. It can be redefined when it is not possible to work in two steps (NewVoid then Read). This occurs when no default constructor is definedhence the result <ent> must be created with an effective definition from the reader. Remarkif NewRead is defined, Copy has nothing to do. //! Returns True if it has produced something, false else. If nothing was produced, <ach> should be filledit will be treated as ‘Unrecognized case’ by reader tool.

  param casenum

  type casenum

  int

  param data

  type data

  Interface_FileReaderData

  param num

  type num

  int

  param ach

  type ach

  Interface_Check

  param ent

  type ent

  Standard_Transient

  rtype

  bool

Read()

• Performs the effective loading from <data>, record <num>, to the Entity <ent> formerly created In case of Error or Warning, fills <ach> with messages Remark that the Case Number comes from translating a record

  param casenum

  type casenum

  int

  param data

  type data

  Interface_FileReaderData

  param num

  type num

  int

  param ach

  type ach

  Interface_Check

  param ent

  type ent

  Standard_Transient

  rtype

  void

property thisown

The membership flag

class Interface_ReportEntity(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a ReportEntity for an Unknown EntityCheck is empty, and Concerned equates Content (i.e. the Unknown Entity)

  param unknown

  type unknown

  Standard_Transient

  rtype

  None* Creates a ReportEntity with its features : - <acheck> is the Check to be memorised - <concerned> is the Entity to which the Check is bound Later, a Content can be set : it is required for an Error

  param acheck

  type acheck

  Interface_Check

  param concerned

  type concerned

  Standard_Transient

  rtype

  None

CCheck()

• Returns the stored Check in order to change it

  rtype

  opencascade::handle<Interface_Check>

Check()

• Returns the stored Check

  rtype

  opencascade::handle<Interface_Check>

Concerned()

• Returns the stored Concerned Entity. It equates the Content in the case of an Unknown Entity

  rtype

  opencascade::handle<Standard_Transient>

Content()

• Returns the stored Content, or a Null Handle Remark that it must be an ‘Unknown Entity’ suitable for the norm of the containing Model

  rtype

  opencascade::handle<Standard_Transient>

static DownCast(t)

HasContent()

• Returns True if a Content is stored (it can equate Concerned)

  rtype

  bool

HasNewContent()

• Returns True if a Content is stored AND differs from Concerned (i.e. redefines content)used when Concerned could not be loaded

  rtype

  bool

IsError()

• Returns True for an Error Entity, i.e. if the Check brings at least one Fail message

  rtype

  bool

IsUnknown()

• Returns True for an Unknown Entity, i,e. if the Check is empty and Concerned equates Content

  rtype

  bool

SetContent()

• Sets a Contentit brings non interpreted data which belong to the Concerned Entity. It can be empty then loaded later. Remark that for an Unknown Entity, Content is set by Create.

  param content

  type content

  Standard_Transient

  rtype

  None

property thisown

The membership flag

class Interface_STAT(*args)

Bases: object

• Creates a STAT form. At start, one default phase is defined, with one default step. Then, it suffises to start with a count of items (and cycles if several) then record items, to have a queryable report.

  param title

  default value is

  type title

  char *

  rtype

  None* used when starting

  param other

  type other

  Interface_STAT

  rtype

  None

AddPhase()

• Adds a new phase to the description. The first one after Create replaces the default unique one

  param weight

  type weight

  float

  param name

  default value is

  type name

  char *

  rtype

  None

AddStep()

• Adds a new step for the last added phase, the default unique one if no AddPhase has already been added WarningAddStep before the first AddPhase are cancelled

  param weight

  default value is 1

  type weight

  float

  rtype

  None

Description()

• Returns global description (cumulated weights of all phases, count of phases,1 for default, and title)

  param nbphases

  type nbphases

  int

  param total

  type total

  float

  param title

  type title

  char *

  rtype

  None

static End()

• Commands to declare the process ended (hence, advancement is forced to 100 %)

  rtype

  void

Internals()

• Returns fields in once, without copying them, used for copy when starting

  param tit

  type tit

  TCollection_HAsciiString

  param total

  type total

  float

  param phn

  type phn

  TColStd_HSequenceOfAsciiString

  param phw

  type phw

  TColStd_HSequenceOfReal

  param phdeb

  type phdeb

  TColStd_HSequenceOfInteger

  param phfin

  type phfin

  TColStd_HSequenceOfInteger

  param stw

  type stw

  TColStd_HSequenceOfReal

  rtype

  None

static NextCycle()

• Commands to resume the preceeding cycle and start a new one, with a count of items Ignored if count of cycles is already passed Then, first step is started (or default one) NextItem can be called for the first step, or NextStep to pass to the next one

  param items

  type items

  int

  rtype

  void

static NextItem()

• Commands to add an item in the current step of the current cycle of the current phase By default, one item per call, can be overpassed Ignored if count of items of this cycle is already passed

  param nbitems

  default value is 1

  type nbitems

  int

  rtype

  void

static NextPhase()

• Commands to resume the preceeding phase and start a new one <items> and <cycles> as for Start, but for this new phase Ignored if count of phases is already passed If <cycles> is more than one, the first Cycle must then be started by NextCycle (NextStep/NextItem are ignored). If it is one, NextItem/NextStep can then be called

  param items

  type items

  int

  param cycles

  default value is 1

  type cycles

  int

  rtype

  void

static NextStep()

• Commands to resume the preceeding step of the cycle Ignored if count of steps is already passed NextItem can be called for this step, NextStep passes to next

  rtype

  void

static Percent()

• Returns the advancement as a percentage<phase> Trueinside the current phase <phase> False (D)relative to the whole process

  param phase

  default value is Standard_False

  type phase

  bool

  rtype

  int

Phase()

• Returns description of a phase, given its rank (n0 for first step, count of steps, default gives one; weight, name)

  param num

  type num

  int

  param n0step

  type n0step

  int

  param nbstep

  type nbstep

  int

  param weight

  type weight

  float

  param name

  type name

  char *

  rtype

  None

static SetPhase()

• Changes the parameters of the phase to start To be used before first counting (i.e. just after NextPhase) Can be used by an operator which has to reajust counts on run

  param items

  type items

  int

  param cycles

  default value is 1

  type cycles

  int

  rtype

  void

Start()

• Starts a STAT on its first phase (or its default one) <items> gives the total count of items, <cycles> the count of cycles If <cycles> is more than one, the first Cycle must then be started by NextCycle (NextStep/NextItem are ignored). If it is one, NextItem/NextStep can then be called

  param items

  type items

  int

  param cycles

  default value is 1

  type cycles

  int

  rtype

  None

static StartCount()

• Starts a default STAT, with no phase, no step, ready to just count items. <items> gives the total count of items Hence, NextItem is available to directly count

  param items

  type items

  int

  param title

  default value is

  type title

  char *

  rtype

  void

Step()

• Returns weight of a Step, related to the cumul given for the phase. <num> is given by <n0step> + i, i between 1 and <nbsteps> (default gives n0step < 0 then weight is one)

  param num

  type num

  int

  rtype

  float

static Where()

• Returns an identification of the STAT<phase> True (D)the name of the current phase <phase> Falsethe title of the current STAT

  param phase

  default value is Standard_True

  type phase

  bool

  rtype

  char *

property thisown

The membership flag

class Interface_SequenceOfCheck(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class Interface_ShareFlags(*args)

Bases: object

• Creates a ShareFlags from a Model and builds required data (flags) by calling the General Service Library given as argument <lib>

  param amodel

  type amodel

  Interface_InterfaceModel

  param lib

  type lib

  Interface_GeneralLib

  rtype

  None* Same as above, but GeneralLib is detained by a GTool

  param amodel

  type amodel

  Interface_InterfaceModel

  param gtool

  type gtool

  Interface_GTool

  rtype

  None* Same as above, but GeneralLib is defined through a Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None* Same as above, but works with the GTool of the Model

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None* Creates a ShareFlags by querying informations from a Graph (remark that Graph also has a method IsShared)

  param agraph

  type agraph

  Interface_Graph

  rtype

  None

IsShared()

• Returns True if <ent> is Shared by one or more other Entity(ies) of the Model

  param ent

  type ent

  Standard_Transient

  rtype

  bool

Model()

• Returns the Model used for the evaluation

  rtype

  opencascade::handle<Interface_InterfaceModel>

NbRoots()

• Returns the count of root entities

  rtype

  int

Root()

• Returns a root entity according its rank in the list of roots By default, it returns the first one

  param num

  default value is 1

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

RootEntities()

• Returns the Entities which are not Shared (see their flags)

  rtype

  Interface_EntityIterator

property thisown

The membership flag

class Interface_ShareTool(*args)

Bases: object

• Creates a ShareTool from a Model and builds all required data, by calling the General Service Library and Modules (GeneralLib given as an argument)

  param amodel

  type amodel

  Interface_InterfaceModel

  param lib

  type lib

  Interface_GeneralLib

  rtype

  None* Same a above, but GeneralLib is detained by a GTool

  param amodel

  type amodel

  Interface_InterfaceModel

  param gtool

  type gtool

  Interface_GTool

  rtype

  None* Same a above, but GeneralLib is defined through a Protocol Protocol is used to build the working library

  param amodel

  type amodel

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None* Same as above, but works with the GTool of the Model

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None* Creates a ShareTool from an already defined Graph Remark that the data of the Graph are copied

  param agraph

  type agraph

  Interface_Graph

  rtype

  None* Completes the Graph by Adding Implied References. Hence, they are considered as Sharing References in all the other queries

  param ahgraph

  type ahgraph

  Interface_HGraph

  rtype

  None

All()

• Returns the complete list of entities shared by <ent> at any level, including <ent> itself If <ent> is the Model, considers the concatenation of AllShared for each root If <rootlast> is True (D), the list starts with lower level entities and ends by the root. Else, the root is first and the lower level entities are at end

  param ent

  type ent

  Standard_Transient

  param rootlast

  default value is Standard_True

  type rootlast

  bool

  rtype

  Interface_EntityIterator

Graph()

• Returns the data used by the ShareTool to work Can then be used directly (read only)

  rtype

  Interface_Graph

IsShared()

• Returns True if <ent> is Shared by other Entities in the Model

  param ent

  type ent

  Standard_Transient

  rtype

  bool

Model()

• Returns the Model used for Creation (directly or for Graph)

  rtype

  opencascade::handle<Interface_InterfaceModel>

NbTypedSharings()

• Returns the count of Sharing Entities of an Entity, which are Kind of a given Type

  param ent

  type ent

  Standard_Transient

  param atype

  type atype

  Standard_Type

  rtype

  int

Print()

• Utility method which Prints the content of an iterator (by their Numbers)

  param iter

  type iter

  Interface_EntityIterator

  param S

  type S

  Message_Messenger

  rtype

  None

RootEntities()

• Returns the Entities which are not Shared (their Sharing List is empty) in the Model

  rtype

  Interface_EntityIterator

Shareds()

• Returns the List of Entities Shared by a given Entity <ent>

  param ent

  type ent

  Standard_Transient

  rtype

  Interface_EntityIterator

Sharings()

• Returns the List of Entities Sharing a given Entity <ent>

  param ent

  type ent

  Standard_Transient

  rtype

  Interface_EntityIterator

TypedSharing()

• Returns the Sharing Entity of an Entity, which is Kind of a given Type. Allows to access a Sharing Entity of a given type when there is one and only one (current case)

  param ent

  type ent

  Standard_Transient

  param atype

  type atype

  Standard_Type

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Interface_SignLabel(*args)

Bases: OCC.Core.MoniTool.MoniTool_SignText

Return type

None

static DownCast(t)

property thisown

The membership flag

class Interface_SignType(*args, **kwargs)

Bases: OCC.Core.MoniTool.MoniTool_SignText

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static ClassName()

• From a CDL Type Name, returns the Class part (package dropped) WARNINGbuffered, to be immediately copied or printed

  param typnam

  type typnam

  char *

  rtype

  char *

static DownCast(t)

Value()

• Returns the Signature for a Transient object. It is specific of each sub-class of Signature. For a Null Handle, it should provide ‘’ It can work with the model which contains the entity

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  char *

property thisown

The membership flag

class Interface_Static(*args)

Bases: OCC.Core.Interface.Interface_TypedValue

• Creates and records a Static, with a family and a name family can report to a name of ressource or to a system or internal definition. The name must be unique. //! type gives the type of the parameter, default is free text Also availableInteger, Real, Enum, Entity (i.e. Object) More precise specifications, titles, can be given to the Static once created //! init gives an initial value. If it is not given, the Static begin as ‘not set’, its value is empty

  param family

  type family

  char *

  param name

  type name

  char *

  param type

  default value is Interface_ParamText

  type type

  Interface_ParamType

  param init

  default value is

  type init

  char *

  rtype

  None* Creates a new Static with same definition as another one (value is copied, except for Entity : it remains null)

  param family

  type family

  char *

  param name

  type name

  char *

  param other

  type other

  Interface_Static

  rtype

  None

static CDef()

• Returns a part of the definition of a Static, as a CString The part is designated by its name, as a CString If the required value is not a string, it is converted to a CString then returned If <name> is not present, or <part> not defined for <name>, this function returns an empty string //! Allowed parts for CDeffamilythe family typethe type (‘integer’,’real’,’text’,’enum’) labelthe label satissatisfy function name if any rminminimum real value rmaxmaximum real value iminminimum integer value imaxmaximum integer value enum nn (nnvalue of an integer)enum value for nn unitunit definition for a real

  param name

  type name

  char *

  param part

  type part

  char *

  rtype

  char *

static CVal()

• Returns the value of the parameter identified by the string name. If the specified parameter does not exist, an empty string is returned. Example Interface_Static::CVal(‘write.step.schema’); which could return: ‘AP214’

  param name

  type name

  char *

  rtype

  char *

static DownCast(t)

Family()

• Returns the family. It can bea resource name for applis, an internal name between$e (environment variables), $l (other, purely local)

  rtype

  char *

static IDef()

• Returns a part of the definition of a Static, as an Integer The part is designated by its name, as a CString If the required value is not a string, returns zero For a Boolean, 0 for false, 1 for true If <name> is not present, or <part> not defined for <name>, this function returns zero //! Allowed parts for IDefimin, imaxminimum or maximum integer value estartstarting number for enum ecountcount of enum values (starting from estart) ematchexact match status eval valcase determined from a string

  param name

  type name

  char *

  param part

  type part

  char *

  rtype

  int

static IVal()

• Returns the integer value of the translation parameter identified by the string name. Returns the value 0 if the parameter does not exist. Example Interface_Static::IVal(‘write.step.schema’); which could return: 3

  param name

  type name

  char *

  rtype

  int

static Init()

• Declares a new Static (by calling its constructor) If this name is already taken, does nothing and returns False Else, creates it and returns True For additional definitions, get the Static then edit it

  param family

  type family

  char *

  param name

  type name

  char *

  param type

  type type

  Interface_ParamType

  param init

  default value is

  type init

  char *

  rtype

  bool* As Init with ParamType, but type is given as a character This allows a simpler call Types : ‘i’ Integer, ‘r’ Real, ‘t’ Text, ‘e’ Enum, ‘o’ Object ‘=’ for same definition as, <init> gives the initial Static Returns False if <type> does not match this list

  param family

  type family

  char *

  param name

  type name

  char *

  param type

  type type

  Standard_Character

  param init

  default value is

  type init

  char *

  rtype

  bool

static IsPresent()

• Returns True if a Static named <name> is present, False else

  param name

  type name

  char *

  rtype

  bool

static IsSet()

• Returns True if <name> is present AND set <proper> True (D)considers this item only <proper> Falseif not set and attached to a wild-card, considers this wild-card

  param name

  type name

  char *

  param proper

  default value is Standard_True

  type proper

  bool

  rtype

  bool

static IsUpdated()

• Returns the status ‘uptodate’ from a Static Returns False if <name> is not present

  param name

  type name

  char *

  rtype

  bool

static Items()

• Returns a list of names of statics<mode> = 0 (D)criter is for family <mode> = 1criter is regexp on names, takes final items (ignore wild cards) <mode> = 2idem but take only wilded, not final items <mode> = 3idem, take all items matching criter idem + 100takes only non-updated items idem + 200takes only updated items criter empty (D)returns all names else returns names which match the given criter Remarkfamilies beginning by ‘$’ are not listed by criter ‘’ they are listed only by criter ‘$’ //! This allows for instance to set new values after having loaded or reloaded a resource, then to update them as required

  param mode

  default value is 0

  type mode

  int

  param criter

  default value is

  type criter

  char *

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

PrintStatic()

• Writes the properties of a parameter in the diagnostic file. These include: - Name - Family, - Wildcard (if it has one) - Current status (empty string if it was updated or if it is the original one) - Value

  param S

  type S

  Message_Messenger

  rtype

  None

static RVal()

• Returns the value of a static translation parameter identified by the string name. Returns the value 0.0 if the parameter does not exist.

  param name

  type name

  char *

  rtype

  float

static SetCVal()

• Modifies the value of the parameter identified by name. The modification is specified by the string val. false is returned if the parameter does not exist. Example Interface_Static::SetCVal (‘write.step.schema’,’AP203’) This syntax specifies a switch from the default STEP 214 mode to STEP 203 mode.

  param name

  type name

  char *

  param val

  type val

  char *

  rtype

  bool

static SetIVal()

• Modifies the value of the parameter identified by name. The modification is specified by the integer value val. false is returned if the parameter does not exist. Example Interface_Static::SetIVal (‘write.step.schema’, 3) This syntax specifies a switch from the default STEP 214 mode to STEP 203 mode.S

  param name

  type name

  char *

  param val

  type val

  int

  rtype

  bool

static SetRVal()

• Modifies the value of a translation parameter. false is returned if the parameter does not exist. The modification is specified by the real number value val.

  param name

  type name

  char *

  param val

  type val

  float

  rtype

  bool

SetUptodate()

• Records a Static has ‘uptodate’, i.e. its value has been taken into account by a reinitialisation procedure This flag is reset at each successful SetValue

  rtype

  None

SetWild()

• Sets a ‘wild-card’ staticits value will be considered if <self> is not properly set. (reset by set a null one)

  param wildcard

  type wildcard

  Interface_Static

  rtype

  None

static Standards()

• Initializes all standard static parameters, which can be used by every function. statics specific of a norm or a function must be defined around it

  rtype

  void

static Static()

• Returns a Static from its name. Null Handle if not present

  param name

  type name

  char *

  rtype

  opencascade::handle<Interface_Static>

static Update()

• Sets a Static to be ‘uptodate’ Returns False if <name> is not present This status can be used by a reinitialisation procedure to rerun if a value has been changed

  param name

  type name

  char *

  rtype

  bool

UpdatedStatus()

• Returns the status ‘uptodate’

  rtype

  bool

Wild()

• Returns the wildcard static, which can be (is most often) null

  rtype

  opencascade::handle<Interface_Static>

property thisown

The membership flag

class Interface_TypedValue(*args)

Bases: OCC.Core.MoniTool.MoniTool_TypedValue

• Creates a TypedValue, with a name //! type gives the type of the parameter, default is free text Also availableInteger, Real, Enum, Entity (i.e. Object) More precise specifications, titles, can be given to the TypedValue once created //! init gives an initial value. If it is not given, the TypedValue begins as ‘not set’, its value is empty

  param name

  type name

  char *

  param type

  default value is Interface_ParamText

  type type

  Interface_ParamType

  param init

  default value is

  type init

  char *

  rtype

  None

static DownCast(t)

static ParamTypeToValueType()

• Correspondance ParamType from Interface to ValueType from MoniTool

  param typ

  type typ

  Interface_ParamType

  rtype

  MoniTool_ValueType

Type()

• Returns the type I.E. calls ValueType then makes correspondance between ParamType from Interface (which remains for compatibility reasons) and ValueType from MoniTool

  rtype

  Interface_ParamType

static ValueTypeToParamType()

• Correspondance ParamType from Interface to ValueType from MoniTool

  param typ

  type typ

  MoniTool_ValueType

  rtype

  Interface_ParamType

property thisown

The membership flag

class Interface_UndefinedContent(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Defines an empty UndefinedContent

  rtype

  None

AddEntity()

• Adds a Parameter which references an Entity

  param ptype

  type ptype

  Interface_ParamType

  param ent

  type ent

  Standard_Transient

  rtype

  None

AddLiteral()

• Adds a literal Parameter to the list

  param ptype

  type ptype

  Interface_ParamType

  param val

  type val

  TCollection_HAsciiString

  rtype

  None

static DownCast(t)

EntityList()

• Returns globally the list of param entities. Note that it can be used as shared entity list for the UndefinedEntity

  rtype

  Interface_EntityList

GetFromAnother()

• Copies contents of undefined entities; deigned to be called by GetFromAnother method from Undefined entity of each Interface (the basic operation is the same regardless the norm)

  param other

  type other

  Interface_UndefinedContent

  param TC

  type TC

  Interface_CopyTool

  rtype

  None

IsParamEntity()

• Returns True if a Parameter is recorded as an entity Error if num is not between 1 and NbParams

  param num

  type num

  int

  rtype

  bool

NbLiterals()

• Gives count of Literal Parameters

  rtype

  int

NbParams()

• Gives count of recorded parameters

  rtype

  int

ParamData()

• Returns data of a Parameterits type, and the entity if it designates en entity (‘ent’) or its literal value else (‘str’) Returned value (Boolean)True if it is an Entity, False else

  param num

  type num

  int

  param ptype

  type ptype

  Interface_ParamType

  param ent

  type ent

  Standard_Transient

  param val

  type val

  TCollection_HAsciiString

  rtype

  bool

ParamEntity()

• Returns Entity corresponding to a Param, given its rank

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

ParamType()

• Returns the ParamType of a Param, given its rank Error if num is not between 1 and NbParams

  param num

  type num

  int

  rtype

  Interface_ParamType

ParamValue()

• Returns litteral value of a Parameter, given its rank

  param num

  type num

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

RemoveParam()

• Removes a Parameter given its rank

  param num

  type num

  int

  rtype

  None

Reservate()

• Manages reservation for parameters (internal use) (nbtotal count of parameters, nblitcount of literals)

  param nb

  type nb

  int

  param nblit

  type nblit

  int

  rtype

  None

SetEntity()

• Sets a new value for the Parameter <num>, to reference an Entity. To simply change the Entity, see the variant below

  param num

  type num

  int

  param ptype

  type ptype

  Interface_ParamType

  param ent

  type ent

  Standard_Transient

  rtype

  None* Changes the Entity referenced by the Parameter <num> (with same ParamType)

  param num

  type num

  int

  param ent

  type ent

  Standard_Transient

  rtype

  None

SetLiteral()

• Sets a new value for the Parameter <num>, to a literal value (if it referenced formerly an Entity, this Entity is removed)

  param num

  type num

  int

  param ptype

  type ptype

  Interface_ParamType

  param val

  type val

  TCollection_HAsciiString

  rtype

  None

property thisown

The membership flag

class Interface_VectorOfFileParameter(*args)

Bases: object

Append()

Appended()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

First()

IsEmpty()

Last()

Length()

Lower()

Set()

SetValue()

Size()

Upper()

Value()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()