OCC.Interface module

class Handle_Interface_Check(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_CopyControl(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_CopyMap(*args)

Bases: OCC.Interface.Handle_Interface_CopyControl

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_DataMapNodeOfDataMapOfTransientInteger(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_EntityCluster(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_FileReaderData(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_GTool(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_GeneralModule(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_GlobalNodeOfGeneralLib(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_GlobalNodeOfReaderLib(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_HArray1OfHAsciiString(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_HGraph(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_HSequenceOfCheck(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_IndexedMapNodeOfIndexedMapOfAsciiString(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_IntVal(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_InterfaceModel(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_NodeOfGeneralLib(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_NodeOfReaderLib(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_ParamList(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_ParamSet(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_Protocol(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_ReaderModule(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_ReportEntity(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_SequenceNodeOfSequenceOfCheck(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_SignLabel(*args)

Bases: object

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_SignType(*args)

Bases: object

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_Static(*args)

Bases: OCC.Interface.Handle_Interface_TypedValue

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_TypedValue(*args)

Bases: object

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_Interface_UndefinedContent(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Interface_Array1OfFileParameter(*args)

Bases: object

Parameters:
  • Low (int) –
  • Up (int) –
  • Item (Interface_FileParameter &) –
  • Low –
  • Up –
Return type:

None
Return type:

None
Assign()
Parameters:Other (Interface_Array1OfFileParameter &) –
Return type:Interface_Array1OfFileParameter
ChangeValue()
Parameters:Index (int) –
Return type:Interface_FileParameter
Destroy()
Return type:None
Init()
Parameters:V (Interface_FileParameter &) –
Return type:None
IsAllocated()
Return type:bool
Length()
Return type:int
Lower()
Return type:int
Set()
Parameters:Other (Interface_Array1OfFileParameter &) –
Return type:Interface_Array1OfFileParameter
SetValue()
Parameters:
  • Index (int) –
  • Value (Interface_FileParameter &) –
Return type:

None
Upper()
Return type:int
Value()
Parameters:Index (int) –
Return type:Interface_FileParameter
thisown

The membership flag

class Interface_Array1OfHAsciiString(*args)

Bases: object

Parameters:
  • Low (int) –
  • Up (int) –
  • Item (Handle_TCollection_HAsciiString &) –
  • Low –
  • Up –
Return type:

None
Return type:

None
Assign()
Parameters:Other (Interface_Array1OfHAsciiString &) –
Return type:Interface_Array1OfHAsciiString
ChangeValue()
Parameters:Index (int) –
Return type:Handle_TCollection_HAsciiString
Destroy()
Return type:None
Init()
Parameters:V (Handle_TCollection_HAsciiString &) –
Return type:None
IsAllocated()
Return type:bool
Length()
Return type:int
Lower()
Return type:int
Set()
Parameters:Other (Interface_Array1OfHAsciiString &) –
Return type:Interface_Array1OfHAsciiString
SetValue()
Parameters:
  • Index (int) –
  • Value (Handle_TCollection_HAsciiString &) –
Return type:

None
Upper()
Return type:int
Value()
Parameters:Index (int) –
Return type:Handle_TCollection_HAsciiString
thisown

The membership flag

class Interface_BitMap(*args)

Bases: object

  • Creates a empty BitMap
Return type: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
Parameters:
  • nbitems (int) –
  • resflags (int) – default value is 0
Return type:

None
  • Creates a BitMap from another one if <copied> is True, copies data else, data are not copied, only the header object is
Parameters:
  • other (Interface_BitMap &) –
  • copied (bool) – default value is Standard_False
Return type:

None
AddFlag()
  • Adds a flag, a name can be attached to it Returns its flag number Makes required reservation
Parameters:name (char *) – default value is
Return type:int
AddSomeFlags()
  • Adds several flags (<more>) with no name Returns the number of last added flag
Parameters:more (int) –
Return type:int
CFalse()
  • Returns the former value for a flag and sets it to False (before : value returned; after : False)
Parameters:
  • item (int) –
  • flag (int) – default value is 0
Return type:

bool
CTrue()
  • Returns the former value for a flag and sets it to True (before : value returned; after : True)
Parameters:
  • item (int) –
  • flag (int) – default value is 0
Return type:

bool
Clear()
  • Clear all field of bit map
Return type:None
FlagName()
  • Returns the name recorded for a flag, or an empty string
Parameters:num (int) –
Return type:char *
FlagNumber()
  • Returns the number or a flag given its name, or zero
Parameters:name (char *) –
Return type:int
Init()
  • Initialises all the values of Flag Number <flag> to a given value <val>
Parameters:
  • val (bool) –
  • flag (int) – default value is 0
Return type:

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
Parameters:
  • nbitems (int) –
  • resflags (int) – default value is 0
Return type:

None
  • Initialize a BitMap from another one
Parameters:
  • other (Interface_BitMap &) –
  • copied (bool) – default value is Standard_False
Return type:

None
Internals()
  • Returns internal values, used for copying Flags values start at false
Parameters:
  • nbitems (int &) –
  • nbwords (int &) –
  • nbflags (int &) –
  • flags (Handle_TColStd_HArray1OfInteger &) –
  • names (Handle_TColStd_HSequenceOfAsciiString &) –
Return type:

None
Length()
  • Returns the count of items (i.e. the length of the bitmap)
Return type:int
NbFlags()
  • Returns the count of flags (flag 0 not included)
Return type:int
RemoveFlag()
  • Removes a flag given its number. Returns True if done, false if num is out of range
Parameters:num (int) –
Return type:bool
Reservate()
  • Reservates for a count of more flags
Parameters:moreflags (int) –
Return type:None
SetFalse()
  • Sets a flag to False
Parameters:
  • item (int) –
  • flag (int) – default value is 0
Return type:

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 if : num is out of range, or name non-empty already set to another flag
Parameters:
  • num (int) –
  • name (char *) –
Return type:

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
Parameters:nbitems (int) –
Return type:None
SetTrue()
  • Sets a flag to True
Parameters:
  • item (int) –
  • flag (int) – default value is 0
Return type:

None
SetValue()
  • Sets a new value for a flag
Parameters:
  • item (int) –
  • val (bool) –
  • flag (int) – default value is 0
Return type:

None
Value()
  • Returns the value (true/false) of a flag, from : - the number of the item - the flag number, by default 0
Parameters:
  • item (int) –
  • flag (int) – default value is 0
Return type:

bool
thisown

The membership flag

class Interface_Category(*args)

Bases: object

  • Creates a Category, with no protocol yet
Return type:None
  • Creates a Category with a given protocol
Parameters:proto (Handle_Interface_Protocol &) –
Return type:None
  • Creates a Category with a given GTool
Parameters:gtool (Handle_Interface_GTool &) –
Return type:None
static AddCategory(*args)
  • Records a new Category defined by its names, produces a number New if not yet recorded
Parameters:name (char *) –
Return type:int
CatNum()
  • Determines the Category Number for an entity in its context, by using general service CategoryNumber
Parameters:
  • ent (Handle_Standard_Transient &) –
  • shares (Interface_ShareTool &) –
Return type:

int
ClearNums()
  • Clears the recorded list of category numbers for a Model
Return type: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)
Parameters:
  • model (Handle_Interface_InterfaceModel &) –
  • shares (Interface_ShareTool &) –
Return type:

None
static Init(*args)
  • Default initialisation (protected against several calls : passes only once)
Return type:void
static Name(*args)
  • Returns the name of a category, according to its number
Parameters:num (int) –
Return type:char *
static NbCategories(*args)
  • Returns the count of recorded categories
Return type:int
Num()
  • Returns the category number recorded for an entity number Returns 0 if out of range
Parameters:nument (int) –
Return type:int
static Number(*args)
  • Returns the number of a category, according to its name
Parameters:name (char *) –
Return type:int
SetProtocol()
  • Sets/Changes Protocol
Parameters:proto (Handle_Interface_Protocol &) –
Return type:None
thisown

The membership flag

Interface_Category_AddCategory(*args)
  • Records a new Category defined by its names, produces a number New if not yet recorded
Parameters:name (char *) –
Return type:int
Interface_Category_Init(*args)
  • Default initialisation (protected against several calls : passes only once)
Return type:void
Interface_Category_Name(*args)
  • Returns the name of a category, according to its number
Parameters:num (int) –
Return type:char *
Interface_Category_NbCategories(*args)
  • Returns the count of recorded categories
Return type:int
Interface_Category_Number(*args)
  • Returns the number of a category, according to its name
Parameters:name (char *) –
Return type:int
class Interface_Check(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Allows definition of a Sequence. Used also for Global Check of an InterfaceModel (which stores global messages for file)
Return type:None
  • Defines a Check on an Entity
Parameters:anentity (Handle_Standard_Transient &) –
Return type:None
AddFail()
  • Records a new Fail message
Parameters:amess (Handle_TCollection_HAsciiString &) –
Return type:None
  • Records a new Fail message under two forms : final,original
Parameters:
  • amess (Handle_TCollection_HAsciiString &) –
  • orig (Handle_TCollection_HAsciiString &) –
Return type:

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>
Parameters:
  • amess (char *) –
  • orig (char *) – default value is
Return type:

None
  • Records a new Fail from the definition of a Msg (Original+Value)
Parameters:amsg (Message_Msg &) –
Return type:None
AddWarning()
  • Records a new Warning message
Parameters:amess (Handle_TCollection_HAsciiString &) –
Return type:None
  • Records a new Warning message under two forms : final,original
Parameters:
  • amess (Handle_TCollection_HAsciiString &) –
  • orig (Handle_TCollection_HAsciiString &) –
Return type:

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>
Parameters:
  • amess (char *) –
  • orig (char *) – default value is
Return type:

None
  • Records a new Warning from the definition of a Msg (Original+Value)
Parameters:amsg (Message_Msg &) –
Return type:None
CFail()
  • Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False
Parameters:
  • num (int) –
  • final (bool) – default value is Standard_True
Return type:

char *
CInfoMsg()
  • Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False
Parameters:
  • num (int) –
  • final (bool) – default value is Standard_True
Return type:

char *
CWarning()
  • Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False
Parameters:
  • num (int) –
  • final (bool) – default value is Standard_True
Return type:

char *
Clear()
  • Clears a check, in order to receive informations from transfer (Messages and Entity)
Return type:None
ClearFails()
  • Clears the Fail Messages (for instance to keep only Warnings)
Return type:None
ClearInfoMsgs()
  • Clears the Info Messages
Return type:None
ClearWarnings()
  • Clears the Warning Messages (for instance to keep only Fails)
Return type:None
Complies()
  • Tells if Check Status complies with a given one (i.e. also status for query)
Parameters:status (Interface_CheckStatus) –
Return type: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)
Parameters:
  • mess (Handle_TCollection_HAsciiString &) –
  • incl (int) –
  • status (Interface_CheckStatus) –
Return type:

bool
Entity()
  • Returns the entity on which the Check has been defined
Return type:Handle_Standard_Transient
Fail()
  • Returns Fail Message as a String Final form by default, Original form if <final> is False
Parameters:
  • num (int) –
  • final (bool) – default value is Standard_True
Return type:

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
Parameters:final (bool) – default value is Standard_True
Return type: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
Parameters:
  • other (Handle_Interface_Check &) –
  • failsonly (bool) –
Return type:

None
GetEntity()
  • same as SetEntity (old form kept for compatibility) Warning : Does nothing if Entity field is not yet clear
Parameters:anentity (Handle_Standard_Transient &) –
Return type:None
GetHandle()
GetMessages()
  • Copies messages stored in another Check, cumulating Does not regard other’s Entity. Used to cumulate messages
Parameters:other (Handle_Interface_Check &) –
Return type:None
HasEntity()
  • Returns True if a Check is devoted to an entity; else, it is global (for InterfaceModel’s storing of global error messages)
Return type:bool
HasFailed()
  • Returns True if Check brings at least one Fail Message
Return type:bool
HasWarnings()
  • Returns True if Check brings at least one Warning Message
Return type:bool
InfoMsg()
  • Returns information message as a String
Parameters:
  • num (int) –
  • final (bool) – default value is Standard_True
Return type:

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
Parameters:final (bool) – default value is Standard_True
Return type: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 messages : here, <num> is ignored
Parameters:
  • pref (char *) –
  • num (int) – default value is 0
Return type:

bool
NbFails()
  • Returns count of recorded Fails
Return type:int
NbInfoMsgs()
  • Returns the count of recorded information messages
Return type:int
NbWarnings()
  • Returns count of recorded Warning messages
Return type:int
Print()
  • Prints the messages of the check to an Messenger <level> = 1 : only fails <level> = 2 : fails and warnings <level> = 3 : all (fails, warnings, info msg) <final> : if positive (D) prints final values of messages if negative, prints originals if null, prints both forms
Parameters:
  • S (Handle_Message_Messenger &) –
  • level (int) –
  • final (int) – default value is 1
Return type:

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
Parameters:
  • mess (Handle_TCollection_HAsciiString &) –
  • incl (int) –
  • status (Interface_CheckStatus) –
Return type:

bool
SendFail()
  • New name for AddFail (Msg)
Parameters:amsg (Message_Msg &) –
Return type:None
SendMsg()
  • Records an information message This does not change the status of the Check
Parameters:amsg (Message_Msg &) –
Return type:None
SendWarning()
  • New name for AddWarning
Parameters:amsg (Message_Msg &) –
Return type:None
SetEntity()
  • Receives an entity result of a Transfer
Parameters:anentity (Handle_Standard_Transient &) –
Return type:None
Status()
  • Returns the Check Status : OK, Warning or Fail
Return type: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)
Parameters:
  • level (int) – default value is -1
  • final (int) – default value is 1
Return type:

None
Warning()
  • Returns Warning message as a String Final form by default, Original form if <final> is False
Parameters:
  • num (int) –
  • final (bool) – default value is Standard_True
Return type:

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
Parameters:final (bool) – default value is Standard_True
Return type:Handle_TColStd_HSequenceOfHAsciiString
thisown

The membership flag

class Interface_CheckIterator(*args)

Bases: object

  • Creates an empty CheckIterator
Return type:None
  • Creates a CheckIterator with a name (displayed by Print as a title)
Parameters:name (char *) –
Return type: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
Parameters:
  • ach (Handle_Interface_Check &) –
  • num (int) – default value is 0
Return type:

None
CCheck()
  • Returns the Check bound to an Entity Number (0 : Global) 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
Parameters:num (int) –
Return type: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
Parameters:ent (Handle_Standard_Transient &) –
Return type: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. Remark : Works apart from the iteration methods (no interference)
Parameters:num (int) –
Return type: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)
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Parameters:
  • failsonly (bool) –
  • global (bool) –
Return type:

Handle_TColStd_HSequenceOfTransient
Clear()
  • Clears the list of checks
Return type:None
Complies()
  • Tells if this check list complies with a given status : OK (i.e. empty), Warning (at least one Warning, but no Fail), Fail (at least one), Message (not OK), NoFail, Any
Parameters:status (Interface_CheckStatus) –
Return type:bool
Destroy()
  • Clears data of iteration
Return type:None
Extract()
  • Returns a CheckIterator which contains the checks which comply with a given status Each check is added completely (no split Warning/Fail)
Parameters:status (Interface_CheckStatus) –
Return type: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
Parameters:
  • mess (char *) –
  • incl (int) –
  • status (Interface_CheckStatus) –
Return type:

Interface_CheckIterator
IsEmpty()
  • Returns True if : no Fail has been recorded if <failsonly> is True, no Check at all if <failsonly> is False
Parameters:failsonly (bool) –
Return type: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
Parameters:other (Interface_CheckIterator &) –
Return type:None
Model()
  • Returns the stored model (can be a null handle)
Return type:Handle_Interface_InterfaceModel
More()
  • Returns True if there are more Checks to get
Return type:bool
Name()
  • Returns the recorded name (can be empty)
Return type:char *
Next()
  • Sets Iteration to next Item
Return type:None
Number()
  • Returns Number of Entity for the Check currently iterated or 0 for GlobalCheck
Return type: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 Remark : Works apart from the iteration methods (no interference)
Parameters:
  • S (Handle_Message_Messenger &) –
  • failsonly (bool) –
  • final (int) – default value is 0
Return type:

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’
Parameters:
  • S (Handle_Message_Messenger &) –
  • model (Handle_Interface_InterfaceModel &) –
  • failsonly (bool) –
  • final (int) – default value is 0
Return type:

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
Parameters:
  • mess (char *) –
  • incl (int) –
  • status (Interface_CheckStatus) –
Return type:

bool
SetModel()
  • Defines a Model, used to locate entities (not required, if it is absent, entities are simply less documented)
Parameters:model (Handle_Interface_InterfaceModel &) –
Return type:None
SetName()
  • Sets / Changes the name
Parameters:name (char *) –
Return type:None
Start()
  • Starts Iteration. Thus, it is possible to restart it Remark : an 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
Return type:None
Status()
  • Returns worst status among : OK, Warning, Fail
Return type: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
Return type:Handle_Interface_Check
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
Parameters:
  • model (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

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)
Parameters:model (Handle_Interface_InterfaceModel &) –
Return type:None
  • Creates a CheckTool from a Graph. The Graph contains a Model which designates a Protocol: they are used to create ShareTool
Parameters:
  • graph (Interface_Graph &) –
  • hgraph (Handle_Interface_HGraph &) –
Return type:

None
Return type:

None
AnalyseCheckList()
  • Returns list of errors dectected at Analyse time (syntactic) (note that GlobalCheck is not in this list)
Return type:Interface_CheckIterator
Check()
  • Returns the Check associated to an Entity identified by its Number in a Model.
Parameters:num (int) –
Return type:Handle_Interface_Check
CheckList()
  • Returns list of all Errors detected Note that presence of Unknown Entities is not an error Cumulates : GlobalCheck if error + AnalyseCheckList + VerifyCheckList
Return type: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
Parameters:reset (bool) – default value is Standard_False
Return type: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 Entities : for those, each Unknown Entity is associated to an empty Check (it is neither an Error nor a Correction, but a remarkable information)
Return type: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 Entity : Check build at Analyse time; else, Check computed for Entity (Verify integrity), can use a Graph as required to control context
Parameters:
  • ent (Handle_Standard_Transient &) –
  • sh (Interface_ShareTool &) –
  • ach (Handle_Interface_Check &) –
Return type:

None
Print()
  • Utility method which Prints the content of a Check
Parameters:
  • ach (Handle_Interface_Check &) –
  • S (Handle_Message_Messenger &) –
Return type:

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)
Parameters:
  • list (Interface_CheckIterator &) –
  • S (Handle_Message_Messenger &) –
Return type:

None
UnknownEntities()
  • Returns list of Unknown Entities Note that Error and Erroneous Entities are not considered as Unknown
Return type:Interface_EntityIterator
VerifyCheckList()
  • Returns list of integrity constraints errors (semantic) (note that GlobalCheck is not in this list)
Return type:Interface_CheckIterator
WarningCheckList()
  • Returns list of Corrections (includes GlobalCheck if corrected)
Return type:Interface_CheckIterator
thisown

The membership flag

class Interface_CopyControl(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

Bind()
  • Bind a Result to a Starting Entity identified by its Number
Parameters:
  • ent (Handle_Standard_Transient &) –
  • res (Handle_Standard_Transient &) –
Return type:

void
Clear()
  • Clears List of Copy Results. Gets Ready to begin another Copy Process.
Return type:void
GetHandle()
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>
Parameters:
  • ent (Handle_Standard_Transient &) –
  • res (Handle_Standard_Transient &) –
Return type:

bool
thisown

The membership flag

class Interface_CopyMap(*args)

Bases: OCC.Interface.Interface_CopyControl

  • Creates a CopyMap adapted to work from a Model
Parameters:amodel (Handle_Interface_InterfaceModel &) –
Return type:None
GetHandle()
Model()
  • Returns the InterfaceModel used at Creation time
Return type:Handle_Interface_InterfaceModel
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
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • lib (Interface_GeneralLib &) –
Return type:

None
  • Same as above, but Library is defined through a Protocol
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

None
  • Same as above, but works with the Active Protocol
Parameters:amodel (Handle_Interface_InterfaceModel &) –
Return type: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 result : in the latter case, the enforced result must be compatible with the other Transfers which are performed
Parameters:
  • ent (Handle_Standard_Transient &) –
  • res (Handle_Standard_Transient &) –
Return type:

None
Clear()
  • Clears Transfer List. Gets Ready to begin another Transfer
Return type: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.
Return type: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
Parameters:withreports (bool) – default value is Standard_False
Return type:Interface_EntityIterator
Control()
  • Returns the object used for Control
Return type: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 produced : it 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 Erroneous : in 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.
Parameters:
  • entfrom (Handle_Standard_Transient &) –
  • entto (Handle_Standard_Transient &) –
  • mapped (bool) –
  • errstat (bool) –
Return type:

bool
Destroy()
Return type:void
FillModel()
  • Fills a Model with the result of the transfer (TransferList) Commands copy of Header too, and calls RenewImpliedRefs
Parameters:bmodel (Handle_Interface_InterfaceModel &) –
Return type: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 follow : Integer num = 0; while ( (num = CopyTool.LastCopiedAfter(num,ent,res)) ) { .. Process Starting <ent> and its Result <res> }
Parameters:
  • numfrom (int) –
  • ent (Handle_Standard_Transient &) –
  • res (Handle_Standard_Transient &) –
Return type:

int
Model()
  • Returns the Model on which the CopyTool works
Return type: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. Remark : this concerns only some specific references, such as ‘back pointers’.
Return type: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)
Parameters:withreports (bool) – default value is Standard_False
Return type: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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • res (Handle_Standard_Transient &) –
Return type:

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)
Parameters:othermap (Handle_Interface_CopyControl &) –
Return type:None
TransferEntity()
  • Transfers one Entity and records result into the Transfer List Calls method Transferred
Parameters:ent (Handle_Standard_Transient &) –
Return type:None
Transferred()
  • Transfers one Entity, if not yet bound to a result Remark : For 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 Content : see method Copy)
Parameters:ent (Handle_Standard_Transient &) –
Return type:Handle_Standard_Transient
thisown

The membership flag

class Interface_DataMapIteratorOfDataMapOfTransientInteger(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (Interface_DataMapOfTransientInteger &) –
Return type:None
Initialize()
Parameters:aMap (Interface_DataMapOfTransientInteger &) –
Return type:None
Key()
Return type:Handle_Standard_Transient
Value()
Return type:int
thisown

The membership flag

class Interface_DataMapNodeOfDataMapOfTransientInteger(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (Handle_Standard_Transient &) –
  • I (int &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None
GetHandle()
GetValue()

Interface_DataMapNodeOfDataMapOfTransientInteger_GetValue(Interface_DataMapNodeOfDataMapOfTransientInteger self) -> Standard_Integer

Key()
Return type:Handle_Standard_Transient
SetValue()

Interface_DataMapNodeOfDataMapOfTransientInteger_SetValue(Interface_DataMapNodeOfDataMapOfTransientInteger self, Standard_Integer value)

thisown

The membership flag

class Interface_DataMapOfTransientInteger(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (Interface_DataMapOfTransientInteger &) –
Return type:Interface_DataMapOfTransientInteger
Bind()
Parameters:
  • K (Handle_Standard_Transient &) –
  • I (int &) –
Return type:

bool
ChangeFind()
Parameters:K (Handle_Standard_Transient &) –
Return type:int
ChangeFind1()
Parameters:K (Handle_Standard_Transient &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (Handle_Standard_Transient &) –
Return type:int
Find1()
Parameters:K (Handle_Standard_Transient &) –
Return type:Standard_Address
IsBound()
Parameters:K (Handle_Standard_Transient &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (Interface_DataMapOfTransientInteger &) –
Return type:Interface_DataMapOfTransientInteger
UnBind()
Parameters:K (Handle_Standard_Transient &) –
Return type:bool
thisown

The membership flag

class Interface_EntityCluster(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates an empty, non-chained, EntityCluster
Return type:None
  • Creates a non-chained EntityCluster, filled with one Entity
Parameters:ent (Handle_Standard_Transient &) –
Return type:None
  • Creates an empty EntityCluster, chained with another one (that is, put BEFORE this other one in the list)
Parameters:ec (Handle_Interface_EntityCluster &) –
Return type:None
  • Creates an EntityCluster, filled with a first Entity, and chained to another EntityCluster (BEFORE it, as above)
Parameters:
  • ant (Handle_Standard_Transient &) –
  • ec (Handle_Interface_EntityCluster &) –
Return type:

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
Parameters:ent (Handle_Standard_Transient &) –
Return type:None
FillIterator()
  • Fills an Iterator with designated Entities (includes Next)
Parameters:iter (Interface_EntityIterator &) –
Return type:None
GetHandle()
NbEntities()
  • Returns total count of Entities (including Next)
Return type: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)
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Parameters:num (int) –
Return type:bool
SetValue()
  • Changes an Entity given its rank.
Parameters:
  • num (int) –
  • ent (Handle_Standard_Transient &) –
Return type:

None
Value()
  • Returns the Entity identified by its rank in the list (including Next)
Parameters:num (int) –
Return type:Handle_Standard_Transient
thisown

The membership flag

class Interface_EntityIterator(*args)

Bases: object

  • Defines an empty iterator (see AddList & AddItem)
Return type:None
  • Defines an iterator on a list, directly i.e. without copying it
Parameters:list (Handle_TColStd_HSequenceOfTransient &) –
Return type:None
AddItem()
  • Adds to the iteration list a defined entity
Parameters:anentity (Handle_Standard_Transient &) –
Return type:None
AddList()
  • Gets a list of entities and adds its to the iteration list
Parameters:list (Handle_TColStd_HSequenceOfTransient &) –
Return type: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
Return type:Handle_TColStd_HSequenceOfTransient
Destroy()
  • Clears data of iteration
Return type:void
GetOneItem()
  • same as AddItem (kept for compatibility)
Parameters:anentity (Handle_Standard_Transient &) –
Return type:None
More()
  • Says if there are other entities (vertices) to iterate the first time, calls Start
Return type:bool
NbEntities()
  • Returns count of entities which will be iterated on Calls Start if not yet done
Return type:int
NbTyped()
  • Returns count of entities of a given type (kind of)
Parameters:type (Handle_Standard_Type &) –
Return type:int
Next()
  • Sets iteration to the next entity (vertex) to give
Return type: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)
Parameters:
  • atype (Handle_Standard_Type &) –
  • keep (bool) –
Return type:

None
Start()
  • Allows re-iteration (useless for the first iteration)
Return type:void
Typed()
  • Returns the list of entities of a given type (kind of)
Parameters:type (Handle_Standard_Type &) –
Return type:Interface_EntityIterator
Value()
  • Returns the current Entity iterated, to be used by Interface tools
Return type:Handle_Standard_Transient
thisown

The membership flag

class Interface_EntityList(*args)

Bases: object

  • Creates a List as beeing empty
Return type: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)
Parameters:ent (Handle_Standard_Transient &) –
Return type:None
Append()
  • Appends an Entity, that is to the END of the list (keeps order, but works slowerly than Add, see below)
Parameters:ent (Handle_Standard_Transient &) –
Return type:None
Clear()
  • Clears the List
Return type:None
FillIterator()
  • fills an Iterator with the content of the list (normal way to consult a list which has been filled with Add)
Parameters:iter (Interface_EntityIterator &) –
Return type:None
IsEmpty()
  • Returns True if the list is empty
Return type:bool
NbEntities()
  • Returns count of recorded Entities
Return type:int
NbTypedEntities()
  • Returns count of Entities of a given Type (0 : none)
Parameters:atype (Handle_Standard_Type &) –
Return type:int
Remove()
  • Removes an Entity from the list, if it is there
Parameters:ent (Handle_Standard_Transient &) –
Return type:None
  • Removes an Entity from the list, given its rank
Parameters:num (int) –
Return type:None
SetValue()
  • Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append)
Parameters:
  • num (int) –
  • ent (Handle_Standard_Transient &) –
Return type:

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
Parameters:
  • atype (Handle_Standard_Type &) –
  • num (int) – default value is 0
Return type:

Handle_Standard_Transient
Value()
  • Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append)
Parameters:num (int) –
Return type:Handle_Standard_Transient
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
Return type:char *
Clear()
  • Clears stored data : frees memory taken for the String Value
Return type:None
Destroy()
  • Destructor. Does nothing because Memory is managed by ParamSet
Return type:None
EntityNumber()
  • Returns value set by SetEntityNumber
Return type:int
Init()
  • Fills fields (with Entity Number set to zero)
Parameters:
  • val (TCollection_AsciiString &) –
  • typ (Interface_ParamType) –
Return type:

None
  • Same as above, but builds the Value from a CString
Parameters:
  • val (char *) –
  • typ (Interface_ParamType) –
Return type:

None
ParamType()
  • Returns the type of the parameter
Return type:Interface_ParamType
SetEntityNumber()
  • Allows to set a reference to an Entity in a numbered list
Parameters:num (int) –
Return type:None
thisown

The membership flag

class Interface_FileReaderData(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

AddParam()
  • Adds a parameter to record no ‘num’ and fills its fields (EntityNumber is optional) Warning : <aval> is assumed to be memory-managed elsewhere : it is NOT copied. This gives a best speed : strings remain stored in pages of characters
Parameters:
  • num (int) –
  • aval (char *) –
  • atype (Interface_ParamType) –
  • nument (int) – default value is 0
Return type:

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)
Parameters:
  • num (int) –
  • aval (TCollection_AsciiString &) –
  • atype (Interface_ParamType) –
  • nument (int) – default value is 0
Return type:

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)
Parameters:
  • num (int) –
  • FP (Interface_FileParameter &) –
Return type:

None
BindEntity()
  • Binds an entity to a record
Parameters:
  • num (int) –
  • ent (Handle_Standard_Transient &) –
Return type:

None
BoundEntity()
  • Returns the entity bound to a record, set by SetEntities
Parameters:num (int) –
Return type:Handle_Standard_Transient
ChangeParam()
  • Same as above, but in order to be modified on place
Parameters:
  • num (int) –
  • nump (int) –
Return type:

Interface_FileParameter
Destroy()
  • Destructor (waiting for memory management)
Return type:None
static Fastof(*args)
  • Same spec.s as standard <atof> but 5 times faster
Parameters:str (char *) –
Return type: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
Parameters:num (int) –
Return type:int
GetHandle()
InitParams()
  • attaches an empty ParamList to a Record
Parameters:num (int) –
Return type:None
IsErrorLoad()
  • Returns True if the status ‘Error Load’ has been set (to True or False)
Return type:bool
IsParamDefined()
  • Returns True if parameter ‘nump’ of record ‘num’ is defined (it is not if its type is ParamVoid)
Parameters:
  • num (int) –
  • nump (int) –
Return type:

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
Return type:int
NbParams()
  • Returns count of parameters attached to record ‘num’ If <num> = 0, returns the total recorded count of parameters
Parameters:num (int) –
Return type:int
NbRecords()
  • Returns the count of registered records That is, value given for Initialization (can be redefined)
Return type:int
Param()
  • Returns parameter ‘nump’ of record ‘num’, as a complete FileParameter
Parameters:
  • num (int) –
  • nump (int) –
Return type:

Interface_FileParameter
ParamCValue()
  • Same as above, but as a CString was C++ : return const
Parameters:
  • num (int) –
  • nump (int) –
Return type:

char *
ParamEntity()
  • Returns the StepEntity referenced by a parameter Error if none
Parameters:
  • num (int) –
  • nump (int) –
Return type:

Handle_Standard_Transient
ParamFirstRank()
  • Returns the absolute rank of the beginning of a record (its lsit is from ParamFirstRank+1 to ParamFirstRank+NbParams)
Parameters:num (int) –
Return type: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)
Parameters:
  • num (int) –
  • nump (int) –
Return type:

int
ParamType()
  • Returns type of parameter ‘nump’ of record ‘num’ Returns literal value of parameter ‘nump’ of record ‘num’ was C++ : return const &
Parameters:
  • num (int) –
  • nump (int) –
Return type:

Interface_ParamType
Params()
  • Returns the complete ParamList of a record (read only) num = 0 to return the whole param list for the file
Parameters:num (int) –
Return type: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
Return type:bool
SetErrorLoad()
  • Sets the status ‘Error Load’ on, to overside check fails <val> True : declares unloaded <val> False : declares 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)
Parameters:val (bool) –
Return type:None
SetParam()
  • Sets a new value for a parameter of a record, given by : num : record number; nump : parameter number in the record
Parameters:
  • num (int) –
  • nump (int) –
  • FP (Interface_FileParameter &) –
Return type:

None
thisown

The membership flag

Interface_FileReaderData_Fastof(*args)
  • Same spec.s as standard <atof> but 5 times faster
Parameters:str (char *) –
Return type:float
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 (me : mutable; FR : in out FileReaderTool; num : Integer; acheck : in out Check) returns Boolean; and call it from AnalyseRecord //! Returned Value : True if the entity could be loaded, False else (in case of syntactic fail)
Parameters:
  • num (int) –
  • anent (Handle_Standard_Transient &) –
  • acheck (Handle_Interface_Check &) –
Return type:

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
Parameters:amodel (Handle_Interface_InterfaceModel &) –
Return type:void
Clear()
  • Clear filelds
Return type:None
Data()
  • Returns the FileReaderData which is used to work
Return type:Handle_Interface_FileReaderData
Destroy()
Return type:void
EndRead()
  • Ends file reading after reading all the entities default is doing nothing; redefinable as necessary
Parameters:amodel (Handle_Interface_InterfaceModel &) –
Return type: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. Remark : it 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.
Parameters:amodel (Handle_Interface_InterfaceModel &) –
Return type: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
Parameters:num (int) –
Return type:Handle_Standard_Transient
Messenger()
  • Returns Messenger used for outputting messages. The returned object is guaranteed to be non-null; default is Message::Messenger().
Return type:Handle_Message_Messenger
Model()
  • Returns the stored Model
Return type:Handle_Interface_InterfaceModel
NewModel()
  • Creates an empty Model of the norm. Uses Protocol to do it
Return type:Handle_Interface_InterfaceModel
Protocol()
  • Returns the Protocol given at creation time
Return type: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 failed : it must record true error messages : RecognizeByLib can generate error messages if NewRead is called //! Note that it works thru a Recognizer (method Evaluate) which has to be memorized before starting
Parameters:
  • num (int) –
  • ach (Handle_Interface_Check &) –
  • ent (Handle_Standard_Transient &) –
Return type:

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
Parameters:
  • num (int) –
  • glib (Interface_GeneralLib &) –
  • rlib (Interface_ReaderLib &) –
  • ach (Handle_Interface_Check &) –
  • ent (Handle_Standard_Transient &) –
Return type:

bool
SetData()
  • Sets Data to a FileReaderData. Works with a Protocol
Parameters:
  • reader (Handle_Interface_FileReaderData &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

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
Return type:None
SetMessenger()
  • Sets Messenger used for outputting messages
Parameters:messenger (Handle_Message_Messenger &) –
Return type:None
SetModel()
  • Stores a Model. Used when the Model has been loaded
Parameters:amodel (Handle_Interface_InterfaceModel &) –
Return type: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 1 : Errors traced
Parameters:tracelev (int) –
Return type:None
TraceLevel()
  • Returns trace level used for outputting messages.
Return type: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
Return type:Handle_Standard_Transient
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’
Parameters:chars (int) – default value is 0
Return type:None
static Convert(*args)
  • This class method converts a Real Value to a string, given options given as arguments. It can be called independantly. Warning : even if declared in, content of <text> will be modified
Parameters:
  • val (float) –
  • text (char *) –
  • zerosup (bool) –
  • Range1 (float) –
  • Range2 (float) –
  • mainform (char *) –
  • rangeform (char *) –
Return type:

int
FormatForRange()
  • Returns the format for range, if set Meaningful only if <range> from Options is True was C++ : return const
Return type:char *
MainFormat()
  • Returns the main format was C++ : return const
Return type: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)
Parameters:
  • zerosup (bool) –
  • range (bool) –
  • R1 (float &) –
  • R2 (float &) –
Return type:

None
SetDefaults()
  • Sets again options to the defaults given by Create
Parameters:chars (int) – default value is 0
Return type: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
Parameters:
  • form (char *) –
  • reset (bool) – default value is Standard_True
Return type:

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.) Warning : if the condition (0. <= R1 < R2) is not fulfilled, this secondary form is canceled.
Parameters:
Return type:

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)
Parameters:mode (bool) –
Return type: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
Parameters:
  • val (float) –
  • text (char *) –
Return type:

int
thisown

The membership flag

Interface_FloatWriter_Convert(*args)
  • This class method converts a Real Value to a string, given options given as arguments. It can be called independantly. Warning : even if declared in, content of <text> will be modified
Parameters:
  • val (float) –
  • text (char *) –
  • zerosup (bool) –
  • Range1 (float) –
  • Range2 (float) –
  • mainform (char *) –
  • rangeform (char *) –
Return type:

int
class Interface_GTool(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates an empty, not set, GTool
Return type:None
  • Creates a GTool from a Protocol Optional starting count of entities
Parameters:
  • proto (Handle_Interface_Protocol &) –
  • nbent (int) – default value is 0
Return type:

None
ClearEntities()
  • Clears the maps which record, for each already recorded entity its Module and Case Number
Return type:None
GetHandle()
Lib()
  • Returns the GeneralLib itself
Return type:Interface_GeneralLib
Protocol()
  • Returns the Protocol. Warning : it can be Null
Return type:Handle_Interface_Protocol
Reservate()
  • Reservates maps for a count of entities <enforce> False : minimum count <enforce> True : clears former reservations Does not clear the maps
Parameters:
  • nb (int) –
  • enforce (bool) – default value is Standard_False
Return type:

None
Select()
  • Selects for an entity, its Module and Case Number It is optimised : once done for each entity, the result is mapped and the GeneralLib is not longer queried <enforce> True overpasses this optimisation
Parameters:
  • ent (Handle_Standard_Transient &) –
  • gmod (Handle_Interface_GeneralModule &) –
  • CN (int &) –
  • enforce (bool) – default value is Standard_False
Return type:

bool
SetProtocol()
  • Sets a new Protocol if <enforce> is False and the new Protocol equates the old one then nothing is done
Parameters:
  • proto (Handle_Interface_Protocol &) –
  • enforce (bool) – default value is Standard_False
Return type:

None
SetSignType()
  • Sets a new SignType
Parameters:sign (Handle_Interface_SignType &) –
Return type:None
SignName()
  • Returns the Name of the SignType, or ‘Class Name’
Return type:char *
SignType()
  • Returns the SignType. Can be null
Return type: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>
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

char *
thisown

The membership flag

class Interface_GeneralLib(*args)

Bases: object

Parameters:aprotocol (Handle_Interface_Protocol &) –
Return type:None
Return type:None
AddProtocol()
Parameters:aprotocol (Handle_Standard_Transient &) –
Return type:None
Clear()
Return type:None
Module()
Return type:Handle_Interface_GeneralModule
More()
Return type:bool
Next()
Return type:None
Protocol()
Return type:Handle_Interface_Protocol
Select()
Parameters:
  • obj (Handle_Standard_Transient &) –
  • module (Handle_Interface_GeneralModule &) –
  • CN (int &) –
Return type:

bool
SetComplete()
Return type:None
static SetGlobal(*args)
Parameters:
  • amodule (Handle_Interface_GeneralModule &) –
  • aprotocol (Handle_Interface_Protocol &) –
Return type:

void
Start()
Return type:None
thisown

The membership flag

Interface_GeneralLib_SetGlobal(*args)
Parameters:
  • amodule (Handle_Interface_GeneralModule &) –
  • aprotocol (Handle_Interface_Protocol &) –
Return type:

void
class Interface_GeneralModule(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

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
Parameters:
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
Return type:

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’
Parameters:
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
  • shares (Interface_ShareTool &) –
Return type:

int
CheckCase()
  • Specific Checking of an Entity <ent> Can check context queried through a ShareTool, as required
Parameters:
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
  • shares (Interface_ShareTool &) –
  • ach (Handle_Interface_Check &) –
Return type:

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
Parameters:
  • CN (int) –
  • entfrom (Handle_Standard_Transient &) –
  • entto (Handle_Standard_Transient &) –
  • TC (Interface_CopyTool &) –
Return type:

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 entity : it 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
Parameters:
  • CN (int) –
  • entfrom (Handle_Standard_Transient &) –
  • entto (Handle_Standard_Transient &) –
  • TC (Interface_CopyTool &) –
Return type:

bool
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
Parameters:
  • model (Handle_Interface_InterfaceModel &) –
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
  • iter (Interface_EntityIterator &) –
Return type:

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
Parameters:
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
  • iter (Interface_EntityIterator &) –
Return type:

void
GetHandle()
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
Parameters:
  • model (Handle_Interface_InterfaceModel &) –
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
  • iter (Interface_EntityIterator &) –
Return type:

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).
Parameters:
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
  • iter (Interface_EntityIterator &) –
Return type:

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 Handle_nonamecanbeproduced Can be redefined //! Warning : While this string may be edited on the spot, if it is a read field, the returned value must be copied before.
Parameters:
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
  • shares (Interface_ShareTool &) –
Return type:

Handle_TCollection_HAsciiString
NewCopiedCase()
  • Specific operator (create+copy) defaulted to do nothing. It can be redefined : When it is not possible to work in two steps (NewVoid then CopyCase). This can occur when there is no default constructor : hence the result <entto> must be created with an effective definition. Remark : if NewCopiedCase is defined, CopyCase has nothing to do Returns True if it has produced something, false else
Parameters:
  • CN (int) –
  • entfrom (Handle_Standard_Transient &) –
  • entto (Handle_Standard_Transient &) –
  • TC (Interface_CopyTool &) –
Return type:

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)
Parameters:
  • CN (int) –
  • entto (Handle_Standard_Transient &) –
Return type:

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
Parameters:
  • CN (int) –
  • entfrom (Handle_Standard_Transient &) –
  • entto (Handle_Standard_Transient &) –
  • TC (Interface_CopyTool &) –
Return type:

void
Share()
  • Adds an Entity to a Shared List (uses GetOneItem on <iter>)
Parameters:
  • iter (Interface_EntityIterator &) –
  • shared (Handle_Standard_Transient &) –
Return type:

None
WhenDeleteCase()
  • Prepares an entity to be deleted. What does it mean : Basically, 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). //! THUS : if 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
Parameters:
  • CN (int) –
  • ent (Handle_Standard_Transient &) –
  • dispatched (bool) –
Return type:

void
thisown

The membership flag

class Interface_GlobalNodeOfGeneralLib(*args)

Bases: OCC.Standard.Standard_Transient

Return type:None
Add()
Parameters:
  • amodule (Handle_Interface_GeneralModule &) –
  • aprotocol (Handle_Interface_Protocol &) –
Return type:

None
GetHandle()
Module()
Return type:Handle_Interface_GeneralModule
Next()
Return type:Handle_Interface_GlobalNodeOfGeneralLib
Protocol()
Return type:Handle_Interface_Protocol
thisown

The membership flag

class Interface_GlobalNodeOfReaderLib(*args)

Bases: OCC.Standard.Standard_Transient

Return type:None
Add()
Parameters:
  • amodule (Handle_Interface_ReaderModule &) –
  • aprotocol (Handle_Interface_Protocol &) –
Return type:

None
GetHandle()
Module()
Return type:Handle_Interface_ReaderModule
Next()
Return type:Handle_Interface_GlobalNodeOfReaderLib
Protocol()
Return type:Handle_Interface_Protocol
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
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • lib (Interface_GeneralLib &) –
  • theModeStats (bool) – default value is Standard_True
Return type:

None
  • Same as above, but the Library is defined through a Protocol
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
  • theModeStats (bool) – default value is Standard_True
Return type:

None
  • Same as above, but the Library is defined through a Protocol
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • gtool (Handle_Interface_GTool &) –
  • theModeStats (bool) – default value is Standard_True
Return type:

None
  • Same a above but works with the Protocol recorded in the Model
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • theModeStats (bool) – default value is Standard_True
Return type:

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
Parameters:
  • agraph (Interface_Graph &) –
  • copied (bool) – default value is Standard_False
Return type:

None
BitMap()
  • Returns the Bit Map in order to read or edit flag values
Return type:Interface_BitMap
CBitMap()
  • Returns the Bit Map in order to edit it (add new flags)
Return type:Interface_BitMap
ChangeStatus()
  • Changes all status which value is oldstat to new value newstat
Parameters:
  • oldstat (int) –
  • newstat (int) –
Return type:

None
Entity()
  • Returns mapped Entity given its no (if it is present)
Parameters:num (int) –
Return type: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>)
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • shared (bool) –
  • newstat (int) – default value is 0
Return type:

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)
Parameters:
  • ent (Handle_Standard_Transient &) –
  • shared (bool) –
  • newstat (int) –
  • overlapstat (int) –
  • cumul (bool) –
Return type:

None
GetFromGraph()
  • Gets all present items from another graph
Parameters:agraph (Interface_Graph &) –
Return type:None
  • Gets items from another graph which have a specific Status
Parameters:
  • agraph (Interface_Graph &) –
  • stat (int) –
Return type:

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
Parameters:
  • iter (Interface_EntityIterator &) –
  • newstat (int) –
Return type:

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)
Parameters:
  • iter (Interface_EntityIterator &) –
  • newstat (int) –
  • overlapstat (int) –
  • cumul (bool) –
Return type:

None
GetFromModel()
  • Loads Graph with all Entities contained in the Model
Return type:None
GetShareds()
  • Returns the sequence of Entities Shared by an Entity
Parameters:ent (Handle_Standard_Transient &) –
Return type:Handle_TColStd_HSequenceOfTransient
GetSharings()
  • Returns the sequence of Entities Sharings by an Entity
Parameters:ent (Handle_Standard_Transient &) –
Return type:Handle_TColStd_HSequenceOfTransient
HasShareErrors()
  • Returns True if <ent> or the list of entities shared by <ent> (not redefined) contains items unknown from this Graph Remark : apart from the status HasShareError, these items are ignored
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Parameters:num (int) –
Return type: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
Parameters:ent (Handle_Standard_Transient &) –
Return type:bool
ModeStat()
  • Returns mode resposible for computation of statuses;
Return type:bool
Model()
  • Returns the Model with which this Graph was created
Return type: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
Parameters:ent (Handle_Standard_Transient &) –
Return type:Handle_TCollection_HAsciiString
NbStatuses()
  • Returns size of array of statuses
Return type:int
RemoveItem()
  • Clears Entity and sets Status to 0, for a numero
Parameters:num (int) –
Return type:None
RemoveStatus()
  • Removes all items of which status has a given value stat
Parameters:stat (int) –
Return type:None
Reset()
  • Erases data, making graph ready to rebegin from void (also resets Shared lists redefinitions)
Return type:None
ResetStatus()
  • Erases Status (Values and Flags of Presence), making graph ready to rebegin from void. Does not concerns Shared lists
Return type:None
RootEntities()
  • Returns the Entities which are not Shared (their Sharing List is empty) in the Model
Return type:Interface_EntityIterator
SetStatus()
  • Modifies Status associated to a numero
Parameters:
  • num (int) –
  • stat (int) –
Return type:

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
Parameters:ent (Handle_Standard_Transient &) –
Return type:Interface_EntityIterator
SharingTable()
  • Returns the Table of Sharing lists. Used to Create another Graph from <self>
Return type:Handle_TColStd_HArray1OfListOfInteger
Sharings()
  • Returns the list of Entities which Share an Entity, computed from the Basic or Redefined Shared Lists
Parameters:ent (Handle_Standard_Transient &) –
Return type:Interface_EntityIterator
Size()
  • Returns size (max nb of entities, i.e. Model’s nb of entities)
Return type:int
Status()
  • Returns Status associated to a numero (only to read it)
Parameters:num (int) –
Return type: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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • type (Handle_Standard_Type &) –
Return type:

Interface_EntityIterator
thisown

The membership flag

class Interface_GraphContent(*args)

Bases: OCC.Interface.Interface_EntityIterator

  • Creates an empty GraphContent, ready to be filled
Return type:None
  • Creates with all entities designated by a Graph
Parameters:agraph (Interface_Graph &) –
Return type:None
  • Creates with entities having specific Status value in a Graph
Parameters:
  • agraph (Interface_Graph &) –
  • stat (int) –
Return type:

None
  • Creates an Iterator with Shared entities of an entity (equivalente to EntityIterator but with a Graph)
Parameters:
  • agraph (Interface_Graph &) –
  • ent (Handle_Standard_Transient &) –
Return type:

None
Begin()
  • Does the Evaluation before starting the iteration itself (in out)
Return type:None
Evaluate()
  • Evaluates list of Entities to be iterated. Called by Start Default is set to doing nothing : intended to be redefined by each sub-class
Return type:void
GetFromGraph()
  • Gets all Entities designated by a Graph (once created), adds them to those already recorded
Parameters:agraph (Interface_Graph &) –
Return type:None
  • Gets entities from a graph which have a specific Status value (one created), adds them to those already recorded
Parameters:
  • agraph (Interface_Graph &) –
  • stat (int) –
Return type:

None
Result()
  • Returns Result under the exact form of an EntityIterator : Can be used when EntityIterator itself is required (as a returned value for instance), whitout way for a sub-class
Return type:Interface_EntityIterator
thisown

The membership flag

class Interface_HArray1OfHAsciiString(*args)

Bases: OCC.MMgt.MMgt_TShared

Parameters:
  • Low (int) –
  • Up (int) –
  • Low –
  • Up –
  • V (Handle_TCollection_HAsciiString &) –
Return type:

None
Return type:

None
Array1()
Return type:Interface_Array1OfHAsciiString
ChangeArray1()
Return type:Interface_Array1OfHAsciiString
ChangeValue()
Parameters:Index (int) –
Return type:Handle_TCollection_HAsciiString
GetHandle()
Init()
Parameters:V (Handle_TCollection_HAsciiString &) –
Return type:None
Length()
Return type:int
Lower()
Return type:int
SetValue()
Parameters:
  • Index (int) –
  • Value (Handle_TCollection_HAsciiString &) –
Return type:

None
Upper()
Return type:int
Value()
Parameters:Index (int) –
Return type:Handle_TCollection_HAsciiString
thisown

The membership flag

class Interface_HGraph(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates an HGraph directly from a Graph. Remark that the starting Graph is duplicated
Parameters:agraph (Interface_Graph &) –
Return type:None
  • Creates an HGraph with a Graph created from <amodel> and <lib>
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • lib (Interface_GeneralLib &) –
  • theModeStats (bool) – default value is Standard_True
Return type:

None
  • Creates an HGraph with a graph itself created from <amodel> and <protocol>
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
  • theModeStats (bool) – default value is Standard_True
Return type:

None
  • Creates an HGraph with a graph itself created from <amodel> and <protocol>
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • gtool (Handle_Interface_GTool &) –
  • theModeStats (bool) – default value is Standard_True
Return type:

None
  • Same a above, but works with the GTool in the model
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • theModeStats (bool) – default value is Standard_True
Return type:

None
CGraph()
  • Same as above, but for Read-Write Operations Then, The Graph will be modified in the HGraph itself
Return type:Interface_Graph
GetHandle()
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
Return type:Interface_Graph
thisown

The membership flag

class Interface_HSequenceOfCheck(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None
Append()
Parameters:
  • anItem (Handle_Interface_Check &) –
  • aSequence (Handle_Interface_HSequenceOfCheck &) –
Return type:

None
Return type:

None
ChangeSequence()
Return type:Interface_SequenceOfCheck
ChangeValue()
Parameters:anIndex (int) –
Return type:Handle_Interface_Check
Clear()
Return type:None
Exchange()
Parameters:
  • anIndex (int) –
  • anOtherIndex (int) –
Return type:

None
GetHandle()
InsertAfter()
Parameters:
  • anIndex (int) –
  • anItem (Handle_Interface_Check &) –
  • anIndex –
  • aSequence (Handle_Interface_HSequenceOfCheck &) –
Return type:

None
Return type:

None
InsertBefore()
Parameters:
  • anIndex (int) –
  • anItem (Handle_Interface_Check &) –
  • anIndex –
  • aSequence (Handle_Interface_HSequenceOfCheck &) –
Return type:

None
Return type:

None
IsEmpty()
Return type:bool
Length()
Return type:int
Prepend()
Parameters:
  • anItem (Handle_Interface_Check &) –
  • aSequence (Handle_Interface_HSequenceOfCheck &) –
Return type:

None
Return type:

None
Remove()
Parameters:
  • anIndex (int) –
  • fromIndex (int) –
  • toIndex (int) –
Return type:

None
Return type:

None
Reverse()
Return type:None
Sequence()
Return type:Interface_SequenceOfCheck
SetValue()
Parameters:
  • anIndex (int) –
  • anItem (Handle_Interface_Check &) –
Return type:

None
Split()
Parameters:anIndex (int) –
Return type:Handle_Interface_HSequenceOfCheck
Value()
Parameters:anIndex (int) –
Return type:Handle_Interface_Check
thisown

The membership flag

class Interface_IndexedMapNodeOfIndexedMapOfAsciiString(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K1 (TCollection_AsciiString &) –
  • K2 (int) –
  • n1 (TCollection_MapNodePtr &) –
  • n2 (TCollection_MapNodePtr &) –
Return type:

None
GetHandle()
GetKey2()

Interface_IndexedMapNodeOfIndexedMapOfAsciiString_GetKey2(Interface_IndexedMapNodeOfIndexedMapOfAsciiString self) -> Standard_Integer

Key1()
Return type:TCollection_AsciiString
Next2()
Return type:TCollection_MapNodePtr
SetKey2()

Interface_IndexedMapNodeOfIndexedMapOfAsciiString_SetKey2(Interface_IndexedMapNodeOfIndexedMapOfAsciiString self, Standard_Integer value)

thisown

The membership flag

class Interface_IndexedMapOfAsciiString(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:
  • NbBuckets (int) – default value is 1
  • Other (Interface_IndexedMapOfAsciiString &) –
Return type:

None
Return type:

None
Add()
Parameters:K (TCollection_AsciiString &) –
Return type:int
Assign()
Parameters:Other (Interface_IndexedMapOfAsciiString &) –
Return type:Interface_IndexedMapOfAsciiString
Clear()
Return type:None
Contains()
Parameters:K (TCollection_AsciiString &) –
Return type:bool
FindIndex()
Parameters:K (TCollection_AsciiString &) –
Return type:int
FindKey()
Parameters:I (int) –
Return type:TCollection_AsciiString
ReSize()
Parameters:NbBuckets (int) –
Return type:None
RemoveLast()
Return type:None
Set()
Parameters:Other (Interface_IndexedMapOfAsciiString &) –
Return type:Interface_IndexedMapOfAsciiString
Substitute()
Parameters:
  • I (int) –
  • K (TCollection_AsciiString &) –
Return type:

None
thisown

The membership flag

class Interface_IntList(*args)

Bases: object

  • Creates empty IntList.
Return type:None
  • Creates an IntList for <nbe> entities
Parameters:nbe (int) –
Return type:None
  • Creates an IntList from another one. if <copied> is True, copies data else, data are not copied, only the header object is
Parameters:
  • other (Interface_IntList &) –
  • copied (bool) –
Return type:

None
Add()
  • Adds a reference (as an integer value, an entity number) to the current entity number. Zero is ignored
Parameters:ref (int) –
Return type:None
AdjustSize()
  • Resizes lists to exact sizes. For list of refs, a positive margin can be added.
Parameters:margin (int) – default value is 0
Return type:None
Clear()
  • Clears all data, hence each entity number has an empty list
Return type:None
Initialize()
  • Initialize IntList by number of entities.
Parameters:nbe (int) –
Return type:None
Internals()
  • Returns internal values, used for copying
Parameters:
  • nbrefs (int &) –
  • ents (Handle_TColStd_HArray1OfInteger &) –
  • refs (Handle_TColStd_HArray1OfInteger &) –
Return type:

None
IsRedefined()
  • Returns True if the list for a number (default is taken as current) is ‘redefined’ (usefull for empty list)
Parameters:num (int) – default value is 0
Return type:bool
Length()
  • Returns the count of refs attached to current entity number
Return type: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
Parameters:
  • number (int) –
  • copied (bool) – default value is Standard_False
Return type:

Interface_IntList
NbEntities()
  • Returns count of entities to be aknowledged
Return type:int
Number()
  • Returns the current entity number
Return type:int
Remove()
  • Removes an item in the list for current number, given its rank Returns True if done, False else
Parameters:num (int) –
Return type: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)
Parameters:count (int) –
Return type:None
SetNbEntities()
  • Changes the count of entities (ignored if decreased)
Parameters:nbe (int) –
Return type:None
SetNumber()
  • Sets an entity number as current (for read and fill)
Parameters:number (int) –
Return type:None
SetRedefined()
  • Sets current entity list to be redefined or not This is used in a Graph for redefinition list : it can be disable (no redefinition, i.e. list is cleared), or enabled (starts as empty). The original list has not to be ‘redefined’
Parameters:mode (bool) –
Return type:None
Value()
  • Returns a reference number in the list for current number, according to its rank
Parameters:num (int) –
Return type:int
thisown

The membership flag

class Interface_IntVal(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None
GetCValue()

Interface_IntVal_GetCValue(Interface_IntVal self) -> Standard_Integer

GetHandle()
SetCValue()

Interface_IntVal_SetCValue(Interface_IntVal self, Standard_Integer value)

Value()
Return type:int
thisown

The membership flag

class Interface_InterfaceModel(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

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 refs : see 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
Parameters:anentity (Handle_Standard_Transient &) –
Return type: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
Parameters:
  • rep (Handle_Interface_ReportEntity &) –
  • semantic (bool) – default value is Standard_False
Return type:

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)
Parameters:
  • anent (Handle_Standard_Transient &) –
  • proto (Handle_Interface_Protocol &) –
  • level (int) – default value is 0
  • listall (bool) – default value is Standard_False
Return type:

None
  • Same as above, but works with the Protocol of the Model
Parameters:
  • anent (Handle_Standard_Transient &) –
  • level (int) – default value is 0
  • listall (bool) – default value is Standard_False
Return type:

None
  • Same as above, but works with an already created GeneralLib
Parameters:
  • anent (Handle_Standard_Transient &) –
  • lib (Interface_GeneralLib &) –
  • level (int) – default value is 0
  • listall (bool) – default value is Standard_False
Return type:

None
CategoryNumber()
  • Returns the recorded category number for a given entity number 0 if none was defined for this entity
Parameters:num (int) –
Return type:int
ChangeOrder()
  • Changes the Numbers of some Entities : <oldnum> is moved to <newnum>, same for <count> entities. Thus : 1,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)
Parameters:
  • oldnum (int) –
  • newnum (int) –
  • count (int) – default value is 1
Return type:

None
Check()
  • Returns the check attached to an entity, designated by its Number. 0 for global check <semantic> True : recorded semantic check <semantic> False : recorded syntactic check (see ReportEntity) If no check is recorded for <num>, returns an empty Check
Parameters:
  • num (int) –
  • syntactic (bool) –
Return type:

Handle_Interface_Check
static ClassName(*args)
  • From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed
Parameters:typnam (char *) –
Return type:char *
Clear()
  • Erases contained data; used when a Model is copied to others : the new copied ones begin from clear Clear calls specific method ClearHeader (see below)
Return type:void
ClearEntities()
  • Clears the entities; uses the general service WhenDelete, in addition to the standard Memory Manager; can be redefined
Return type:void
ClearHeader()
  • Clears Model’s header : specific to each norm
Return type:void
ClearLabels()
  • Erases informations about labels, if any : specific to each norm
Return type:void
ClearReportEntity()
  • Removes the ReportEntity attached to Entity <num>. Returns True if done, False if no ReportEntity was attached to <num>. Warning : the caller must assume that this clearing is meaningfull
Parameters:num (int) –
Return type:bool
Contains()
  • Returns True if a Model contains an Entity (for a ReportEntity, looks for the ReportEntity itself AND its Concerned Entity)
Parameters:anentity (Handle_Standard_Transient &) –
Return type:bool
Destroy()
  • Clears the list of entities (service WhenDelete)
Return type:None
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
Parameters:
  • S (Handle_Message_Messenger &) –
  • level (int) – default value is 0
Return type:

void
Entities()
  • Returns the list of all Entities, as an Iterator on Entities (the Entities themselves, not the Reports)
Return type:Interface_EntityIterator
EntityState()
  • Returns the State of an entity, given its number
Parameters:num (int) –
Return type:Interface_DataState
FillIterator()
  • Allows an EntityIterator to get a list of Entities
Parameters:iter (Interface_EntityIterator &) –
Return type: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> False : new list is cumulated
Parameters:
  • checks (Interface_CheckIterator &) –
  • clear (bool) – default value is Standard_True
Return type:

None
GTool()
  • Returns the GTool, set by SetProtocol or by SetGTool
Return type:Handle_Interface_GTool
GetDispatchStatus()

Interface_InterfaceModel_GetDispatchStatus(Interface_InterfaceModel self) -> Standard_Boolean

GetFromAnother()
  • Gets header (data specific of a defined Interface) from another InterfaceModel; called from TransferCopy
Parameters:other (Handle_Interface_InterfaceModel &) –
Return type:void
GetFromTransfer()
  • Gets contents from an EntityIterator, prepared by a Transfer tool (e.g TransferCopy). Starts from clear
Parameters:aniter (Interface_EntityIterator &) –
Return type:None
GetHandle()
GlobalCheck()
  • Returns the GlobalCheck, which memorizes messages global to the file (not specific to an Entity), especially Header
Parameters:syntactic (bool) – default value is Standard_True
Return type:Handle_Interface_Check
HasSemanticChecks()
  • Returns True if semantic checks have been filled
Return type:bool
static HasTemplate(*args)
  • Returns true if a template is attached to a given name
Parameters:name (char *) –
Return type:bool
IsErrorEntity()
  • Returns True if <num> identifies an Error Entity : in this case, a ReportEntity brings Fail Messages and possibly an ‘undefined’ Content, see IsRedefinedEntity
Parameters:num (int) –
Return type: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
Parameters:num (int) –
Return type: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.
Parameters:
  • num (int) –
  • semantic (bool) – default value is Standard_False
Return type:

bool
IsUnknownEntity()
  • Returns True if <num> identifies an Unknown Entity : in this case, a ReportEntity with no Check Messages designates it.
Parameters:num (int) –
Return type:bool
static ListTemplates(*args)
  • Returns the complete list of names attached to template models
Return type:Handle_TColStd_HSequenceOfHAsciiString
NbEntities()
  • Returns count of contained Entities
Return type: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).
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Return type: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).
Parameters:
  • label (char *) –
  • lastnum (int) – default value is 0
  • exact (bool) – default value is Standard_True
Return type:

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.
Parameters:anentity (Handle_Standard_Transient &) –
Return type:int
Print()
  • Prints identification of a given entity in <self>, in order to be printed in a list or phrase <mode> < 0 : prints only its number <mode> = 1 : just calls PrintLabel <mode> = 0 (D) : prints its number plus ‘/’ plus PrintLabel If <ent> == <self>, simply prints ‘Global’ If <ent> is unknown, prints ‘/its type’
Parameters:
  • ent (Handle_Standard_Transient &) –
  • s (Handle_Message_Messenger &) –
  • mode (int) – default value is 0
Return type:

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.
Parameters:
  • ent (Handle_Standard_Transient &) –
  • S (Handle_Message_Messenger &) –
Return type:

void
PrintToLog()
  • Prints label specific to each norm in log format, for a given entity. By default, just calls PrintLabel, can be redefined
Parameters:
  • ent (Handle_Standard_Transient &) –
  • S (Handle_Message_Messenger &) –
Return type:

void
Protocol()
  • Returns the Protocol which has been set by SetProtocol, or AddWithRefs with Protocol
Return type:Handle_Interface_Protocol
Redefineds()
  • Returns the list of ReportEntities which redefine data (generally, if concerned entity is ‘Error’, a literal content is added to it : this is a ‘redefined entity’
Return type:Interface_EntityIterator
ReplaceEntity()
  • Replace Entity with Number=nument on other entity - ‘anent’
Parameters:
  • nument (int) –
  • anent (Handle_Standard_Transient &) –
Return type:

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
Parameters:
  • num (int) –
  • semantic (bool) – default value is Standard_False
Return type:

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
Parameters:semantic (bool) – default value is Standard_False
Return type: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
Parameters:nbent (int) –
Return type:void
ReverseOrders()
  • Reverses the Numbers of the Entities, between <after> and the total count of Entities. Thus, the entities : 1,2 ... after, after+1 ... nb-1, nb become numbered as : 1,2 ... after, nb, nb-1 ... after+1 By default (after = 0) the whole list of Entities is reversed
Parameters:after (int) – default value is 0
Return type:None
SetCategoryNumber()
  • Records a category number for an entity number Returns True when done, False if <num> is out of range
Parameters:
Return type:

bool
SetDispatchStatus()

Interface_InterfaceModel_SetDispatchStatus(Interface_InterfaceModel self, Standard_Boolean value)

SetGTool()
  • Sets a GTool for this model, which already defines a Protocol
Parameters:gtool (Handle_Interface_GTool &) –
Return type:None
SetGlobalCheck()
  • Allows to modify GlobalCheck, after getting then completing it Remark : it is SYNTACTIC check. Semantics, see FillChecks
Parameters:ach (Handle_Interface_Check &) –
Return type:None
SetProtocol()
  • Sets a Protocol for this Model It is also set by a call to AddWithRefs with Protocol It is used for : DumpHeader (as required), ClearEntities ...
Parameters:proto (Handle_Interface_Protocol &) –
Return type:None
SetReportEntity()
  • Sets or Replaces a ReportEntity for the Entity <num>. Returns True if Report is replaced, False if it has been replaced Warning : the caller must assume that this setting is meaningfull
Parameters:
  • num (int) –
  • rep (Handle_Interface_ReportEntity &) –
Return type:

bool
static SetTemplate(*args)
  • Records a new template model with a name. If the name was already recorded, the corresponding template is replaced by the new one. Then, WARNING : test HasTemplate to avoid surprises
Parameters:
  • name (char *) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

bool
StringLabel()
  • Returns a string with the label attached to a given entity. Warning : While this string may be edited on the spot, if it is a read field, the returned value must be copied before.
Parameters:ent (Handle_Standard_Transient &) –
Return type:Handle_TCollection_HAsciiString
static Template(*args)
  • Returns the template model attached to a name, or a Null Handle
Parameters:name (char *) –
Return type:Handle_Interface_InterfaceModel
Type()
  • Returns a type, given its rank : defined by the Protocol (by default, the first one)
Parameters:
  • ent (Handle_Standard_Transient &) –
  • num (int) – default value is 1
Return type:

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 WARNING : buffered, to be immediately copied or printed
Parameters:
  • ent (Handle_Standard_Transient &) –
  • complete (bool) – default value is Standard_True
Return type:

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 Remark : For a Reported Entity, (Erroneous, Corrected, Unknown), this method returns this Reported Entity. See ReportEntity for other questions.
Parameters:num (int) –
Return type: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
Parameters:ach (Handle_Interface_Check &) –
Return type:void
thisown

The membership flag

Interface_InterfaceModel_ClassName(*args)
  • From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed
Parameters:typnam (char *) –
Return type:char *
Interface_InterfaceModel_HasTemplate(*args)
  • Returns true if a template is attached to a given name
Parameters:name (char *) –
Return type:bool
Interface_InterfaceModel_ListTemplates(*args)
  • Returns the complete list of names attached to template models
Return type:Handle_TColStd_HSequenceOfHAsciiString
Interface_InterfaceModel_SetTemplate(*args)
  • Records a new template model with a name. If the name was already recorded, the corresponding template is replaced by the new one. Then, WARNING : test HasTemplate to avoid surprises
Parameters:
  • name (char *) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

bool
Interface_InterfaceModel_Template(*args)
  • Returns the template model attached to a name, or a Null Handle
Parameters:name (char *) –
Return type:Handle_Interface_InterfaceModel
class Interface_LineBuffer(*args)

Bases: object

  • Creates a LineBuffer with an absolute maximum size (Default value is only to satisfy compiler requirement)
Parameters:size (int) – default value is 10
Return type:None
Add()
  • Adds a text as a CString. Its Length is evaluated from the text (by C function strlen)
Parameters:text (char *) –
Return type:None
  • Adds a text as a CString. Its length is given as <lntext>
Parameters:
  • text (char *) –
  • lntext (int) –
Return type:

None
  • Adds a text as a AsciiString from TCollection
Parameters:text (TCollection_AsciiString &) –
Return type:None
  • Adds a text made of only ONE Character
Parameters:text (Standard_Character) –
Return type: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
Parameters:more (int) –
Return type:bool
Clear()
  • Clears completely the LineBuffer
Return type:None
Content()
  • Returns the Content of the LineBuffer was C++ : return const
Return type: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
Return type:None
Length()
  • Returns the Length of the LineBuffer
Return type:int
Move()
  • Fills a AsciiString <str> with the Content of the Line Buffer, then Clears the LineBuffer
Parameters:str (TCollection_AsciiString &) –
Return type:None
  • Same as above, but <str> is known through a Handle
Parameters:str (Handle_TCollection_HAsciiString &) –
Return type:None
Moved()
  • Same as above, but generates the HAsciiString
Return type:Handle_TCollection_HAsciiString
SetInitial()
  • Sets an Initial reservation for Blank characters (this reservation is counted in the size of the current Line)
Parameters:initial (int) –
Return type: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
Return type:None
SetMax()
  • Changes Maximum allowed size of Buffer. If <max> is Zero, Maximum size is set to the initial size.
Parameters:max (int) –
Return type:None
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
Parameters:key (char *) –
Return type: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
Parameters:
  • key (char *) –
  • i1 (int) –
Return type:

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
Parameters:
  • key (char *) –
  • i1 (int) –
  • i2 (int) –
Return type:

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
Parameters:
  • key (char *) –
  • r1 (float) –
  • intervals (int) – default value is -1
Return type:

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
Parameters:
  • key (char *) –
  • str (char *) –
Return type:

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
Parameters:
  • key (char *) –
  • ival (int) –
  • str (char *) –
Return type:

None
static Blanks(*args)
  • 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...
Parameters:
Return type:

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...
Parameters:
  • val (char *) –
  • max (int) –
Return type:

char *
  • Returns a blank string of <count> blanks (mini 0, maxi 76)
Parameters:count (int) –
Return type:char *
static CDate(*args)
  • Returns a value about comparison of two dates 0 : equal. <0 text1 anterior. >0 text1 posterior
Parameters:
  • text1 (char *) –
  • text2 (char *) –
Return type:

int
Destroy()
  • Optimised destructor (applies for additional forms of Create)
Return type:None
static Intervalled(*args)
  • 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,1 : 1 10 100 ... 2 : 1 3 10 30 100 ... 3(D): 1 2 5 10 20 50 100 ... 4 : 1 2 3 6 10 20 30 60 100 ... 6 : 1 1.5 2 3 5 7 10 15 20 ... 10 : 1 1.2 1.5 2 2.5 3 4 5 6 8 10 12 15 20 25 ...
Parameters:
  • val (float) –
  • order (int) – default value is 3
  • upper (bool) – default value is Standard_False
Return type:

float
static IsKey(*args)
  • Returns True if a given message is surely a key (according to the form adopted for keys) (before activating messages, answer is false)
Parameters:mess (char *) –
Return type:bool
static NDate(*args)
  • 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)
Parameters:
  • text (char *) –
  • yy (int &) –
  • mm (int &) –
  • dd (int &) –
  • hh (int &) –
  • mn (int &) –
  • ss (int &) –
Return type:

bool
static Print(*args)
  • Prints a String on an Output Stream, as follows : Accompagned with blanks, to give up to <max> charis at all, justified according just : -1 (D) : left 0 : center 1 : right Maximum 76 characters
Parameters:
  • S (Standard_OStream &) –
  • val (char *) –
  • max (int) –
  • just (int) – default value is -1
Return type:

void
PrintTraceToString()

Interface_MSG_PrintTraceToString(Interface_MSG self) -> std::string

static Read(*args)
  • Reads a list of messages from a file defined by its name
Parameters:file (char *) –
Return type:int
ReadFromString()

Interface_MSG_ReadFromString(Interface_MSG self, std::string src)

static Record(*args)
  • 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
Parameters:
  • key (char *) –
  • item (char *) –
Return type:

void
static SetMode(*args)
  • 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
Parameters:
Return type:

void
static SetTrace(*args)
  • 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
Parameters:
  • toprint (bool) –
  • torecord (bool) –
Return type:

void
static TDate(*args)
  • 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 follows : C:%d ... C like format, preceeded by C: S:... format to call system (not yet implemented)
Parameters:
  • text (char *) –
  • yy (int) –
  • mm (int) –
  • dd (int) –
  • hh (int) –
  • mn (int) –
  • ss (int) –
  • format (char *) – default value is
Return type:

void
static Translated(*args)
  • 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
Parameters:key (char *) –
Return type:char *
Value()
  • Returns the translated message, in a functional form with operator () was C++ : return const
Return type:char *
static Write(*args)
  • 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
Parameters:
  • S (Standard_OStream &) –
  • rootkey (char *) – default value is
Return type:

int
thisown

The membership flag

Interface_MSG_Blanks(*args)
  • 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...
Parameters:
Return type:

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...
Parameters:
  • val (char *) –
  • max (int) –
Return type:

char *
  • Returns a blank string of <count> blanks (mini 0, maxi 76)
Parameters:count (int) –
Return type:char *
Interface_MSG_CDate(*args)
  • Returns a value about comparison of two dates 0 : equal. <0 text1 anterior. >0 text1 posterior
Parameters:
  • text1 (char *) –
  • text2 (char *) –
Return type:

int
Interface_MSG_Intervalled(*args)
  • 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,1 : 1 10 100 ... 2 : 1 3 10 30 100 ... 3(D): 1 2 5 10 20 50 100 ... 4 : 1 2 3 6 10 20 30 60 100 ... 6 : 1 1.5 2 3 5 7 10 15 20 ... 10 : 1 1.2 1.5 2 2.5 3 4 5 6 8 10 12 15 20 25 ...
Parameters:
  • val (float) –
  • order (int) – default value is 3
  • upper (bool) – default value is Standard_False
Return type:

float
Interface_MSG_IsKey(*args)
  • Returns True if a given message is surely a key (according to the form adopted for keys) (before activating messages, answer is false)
Parameters:mess (char *) –
Return type:bool
Interface_MSG_NDate(*args)
  • 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)
Parameters:
  • text (char *) –
  • yy (int &) –
  • mm (int &) –
  • dd (int &) –
  • hh (int &) –
  • mn (int &) –
  • ss (int &) –
Return type:

bool
Interface_MSG_Print(*args)
  • Prints a String on an Output Stream, as follows : Accompagned with blanks, to give up to <max> charis at all, justified according just : -1 (D) : left 0 : center 1 : right Maximum 76 characters
Parameters:
  • S (Standard_OStream &) –
  • val (char *) –
  • max (int) –
  • just (int) – default value is -1
Return type:

void
Interface_MSG_Read(*args)
  • Reads a list of messages from a file defined by its name
Parameters:file (char *) –
Return type:int
Interface_MSG_Record(*args)
  • 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
Parameters:
  • key (char *) –
  • item (char *) –
Return type:

void
Interface_MSG_SetMode(*args)
  • 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
Parameters:
Return type:

void
Interface_MSG_SetTrace(*args)
  • 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
Parameters:
  • toprint (bool) –
  • torecord (bool) –
Return type:

void
Interface_MSG_TDate(*args)
  • 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 follows : C:%d ... C like format, preceeded by C: S:... format to call system (not yet implemented)
Parameters:
  • text (char *) –
  • yy (int) –
  • mm (int) –
  • dd (int) –
  • hh (int) –
  • mn (int) –
  • ss (int) –
  • format (char *) – default value is
Return type:

void
Interface_MSG_Translated(*args)
  • 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
Parameters:key (char *) –
Return type:char *
Interface_MSG_Write(*args)
  • 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
Parameters:
  • S (Standard_OStream &) –
  • rootkey (char *) – default value is
Return type:

int
class Interface_MapAsciiStringHasher

Bases: object

static HashCode(*args)
Parameters:
  • K (TCollection_AsciiString &) –
  • Upper (int) –
Return type:

int
static IsEqual(*args)
Parameters:
  • K1 (TCollection_AsciiString &) –
  • K2 (TCollection_AsciiString &) –
Return type:

bool
thisown

The membership flag

Interface_MapAsciiStringHasher_HashCode(*args)
Parameters:
  • K (TCollection_AsciiString &) –
  • Upper (int) –
Return type:

int
Interface_MapAsciiStringHasher_IsEqual(*args)
Parameters:
  • K1 (TCollection_AsciiString &) –
  • K2 (TCollection_AsciiString &) –
Return type:

bool
class Interface_NodeOfGeneralLib(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None
AddNode()
Parameters:anode (Handle_Interface_GlobalNodeOfGeneralLib &) –
Return type:None
GetHandle()
Module()
Return type:Handle_Interface_GeneralModule
Next()
Return type:Handle_Interface_NodeOfGeneralLib
Protocol()
Return type:Handle_Interface_Protocol
thisown

The membership flag

class Interface_NodeOfReaderLib(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None
AddNode()
Parameters:anode (Handle_Interface_GlobalNodeOfReaderLib &) –
Return type:None
GetHandle()
Module()
Return type:Handle_Interface_ReaderModule
Next()
Return type:Handle_Interface_NodeOfReaderLib
Protocol()
Return type:Handle_Interface_Protocol
thisown

The membership flag

class Interface_ParamList(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates an vector with size of memmory blok equal to theIncrement
Parameters:theIncrement (int) – default value is 256
Return type:None
ChangeValue()
  • return the value of the <Index>th element of the array.
Parameters:Index (int) –
Return type:Interface_FileParameter
Clear()
Return type:None
GetHandle()
Length()
  • Returns the number of elements of <self>.
Return type:int
Lower()
  • Returns the lower bound. Warning
Return type:int
SetValue()
  • Assigns the value <Value> to the <Index>-th item of this array.
Parameters:
  • Index (int) –
  • Value (Interface_FileParameter &) –
Return type:

None
Upper()
  • Returns the upper bound. Warning
Return type:int
Value()
  • Return the value of the <Index>th element of the array.
Parameters:Index (int) –
Return type:Interface_FileParameter
thisown

The membership flag

class Interface_ParamSet(*args)

Bases: OCC.MMgt.MMgt_TShared

  • 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)
Parameters:
  • nres (int) –
  • nst (int) – default value is 1
Return type:

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 elsewhere : its adress is stored as such. Else, <val> is copied in a locally (quickly) managed Page of Characters Returns new count of recorded Parameters
Parameters:
  • val (char *) –
  • lnval (int) –
  • typ (Interface_ParamType) –
  • nument (int) –
Return type:

int
  • Adds a parameter at the end of the ParamSet (transparent about reservation and ‘Next’) Returns new count of recorded Parameters
Parameters:FP (Interface_FileParameter &) –
Return type:int
ChangeParam()
  • Same as above, but in order to be modified on place
Parameters:num (int) –
Return type:Interface_FileParameter
Destroy()
  • Destructor (waiting for transparent memory management)
Return type:None
GetHandle()
NbParams()
  • Returns the total count of parameters (including nexts)
Return type:int
Param()
  • Returns a parameter identified by its number
Parameters:num (int) –
Return type: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
Parameters:
Return type:

Handle_Interface_ParamList
SetParam()
  • Changes a parameter identified by its number
Parameters:
  • num (int) –
  • FP (Interface_FileParameter &) –
Return type:

None
thisown

The membership flag

class Interface_Protocol(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

static Active(*args)
  • Returns the Active Protocol, if defined (else, returns a Null Handle, which means ‘no defined active protocol’)
Return type: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.
Parameters:obj (Handle_Standard_Transient &) –
Return type:int
static ClearActive(*args)
  • Erases the Active Protocol (hence it becomes undefined)
Return type:void
GetHandle()
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 protocol : the uppest level Protocol assumes it, it can call GlobalCheck of its ressources only if it is necessary //! Default does nothing, can be redefined
Parameters:
  • G (Interface_Graph &) –
  • ach (Handle_Interface_Check &) –
Return type:

bool
IsDynamicType()
  • Returns True if type of <obj> is that defined from CDL This is the default but it may change according implementation
Parameters:obj (Handle_Standard_Transient &) –
Return type:bool
IsSuitableModel()
  • Returns True if <model> is a Model of the considered Norm
Parameters:model (Handle_Interface_InterfaceModel &) –
Return type: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)
Parameters:ent (Handle_Standard_Transient &) –
Return type:bool
NbResources()
  • Returns count of Protocol used as Resources (level one)
Return type: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)
Parameters:obj (Handle_Standard_Transient &) –
Return type:int
NewModel()
  • Creates an empty Model of the considered Norm
Return type:Handle_Interface_InterfaceModel
Resource()
  • Returns a Resource, given its rank (between 1 and NbResources)
Parameters:num (int) –
Return type:Handle_Interface_Protocol
static SetActive(*args)
  • Sets a given Protocol to be the Active one (for the users of Active, see just above). Applies to every sub-type of Protocol
Parameters:aprotocol (Handle_Interface_Protocol &) –
Return type: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
Parameters:
  • obj (Handle_Standard_Transient &) –
  • nt (int) – default value is 1
Return type:

Handle_Standard_Type
TypeNumber()
  • Returns a unique positive CaseNumber for each Recognized Type, Returns Zero for ‘<type> not recognized’
Parameters:atype (Handle_Standard_Type &) –
Return type:int
UnknownEntity()
  • Creates a new Unknown Entity for the considered Norm
Return type:Handle_Standard_Transient
thisown

The membership flag

Interface_Protocol_Active(*args)
  • Returns the Active Protocol, if defined (else, returns a Null Handle, which means ‘no defined active protocol’)
Return type:Handle_Interface_Protocol
Interface_Protocol_ClearActive(*args)
  • Erases the Active Protocol (hence it becomes undefined)
Return type:void
Interface_Protocol_SetActive(*args)
  • Sets a given Protocol to be the Active one (for the users of Active, see just above). Applies to every sub-type of Protocol
Parameters:aprotocol (Handle_Interface_Protocol &) –
Return type:void
class Interface_ReaderLib(*args)

Bases: object

Parameters:aprotocol (Handle_Interface_Protocol &) –
Return type:None
Return type:None
AddProtocol()
Parameters:aprotocol (Handle_Standard_Transient &) –
Return type:None
Clear()
Return type:None
Module()
Return type:Handle_Interface_ReaderModule
More()
Return type:bool
Next()
Return type:None
Protocol()
Return type:Handle_Interface_Protocol
Select()
Parameters:
  • obj (Handle_Standard_Transient &) –
  • module (Handle_Interface_ReaderModule &) –
  • CN (int &) –
Return type:

bool
SetComplete()
Return type:None
static SetGlobal(*args)
Parameters:
  • amodule (Handle_Interface_ReaderModule &) –
  • aprotocol (Handle_Interface_Protocol &) –
Return type:

void
Start()
Return type:None
thisown

The membership flag

Interface_ReaderLib_SetGlobal(*args)
Parameters:
  • amodule (Handle_Interface_ReaderModule &) –
  • aprotocol (Handle_Interface_Protocol &) –
Return type:

void
class Interface_ReaderModule(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

CaseNum()
  • Translates the type of record <num> in <data> to a positive Case Number. If Recognition fails, must return 0
Parameters:
  • data (Handle_Interface_FileReaderData &) –
  • num (int) –
Return type:

int
GetHandle()
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 defined : hence the result <ent> must be created with an effective definition from the reader. Remark : if NewRead is defined, Copy has nothing to do. //! Returns True if it has produced something, false else. If nothing was produced, <ach> should be filled : it will be treated as ‘Unrecognized case’ by reader tool.
Parameters:
  • casenum (int) –
  • data (Handle_Interface_FileReaderData &) –
  • num (int) –
  • ach (Handle_Interface_Check &) –
  • ent (Handle_Standard_Transient &) –
Return type:

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
Parameters:
  • casenum (int) –
  • data (Handle_Interface_FileReaderData &) –
  • num (int) –
  • ach (Handle_Interface_Check &) –
  • ent (Handle_Standard_Transient &) –
Return type:

void
thisown

The membership flag

class Interface_ReportEntity(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates a ReportEntity for an Unknown Entity : Check is empty, and Concerned equates Content (i.e. the Unknown Entity)
Parameters:unknown (Handle_Standard_Transient &) –
Return type: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
Parameters:
  • acheck (Handle_Interface_Check &) –
  • concerned (Handle_Standard_Transient &) –
Return type:

None
CCheck()
  • Returns the stored Check in order to change it
Return type:Handle_Interface_Check
Check()
  • Returns the stored Check
Return type:Handle_Interface_Check
Concerned()
  • Returns the stored Concerned Entity. It equates the Content in the case of an Unknown Entity
Return type: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
Return type:Handle_Standard_Transient
GetHandle()
HasContent()
  • Returns True if a Content is stored (it can equate Concerned)
Return type:bool
HasNewContent()
  • Returns True if a Content is stored AND differs from Concerned (i.e. redefines content) : used when Concerned could not be loaded
Return type:bool
IsError()
  • Returns True for an Error Entity, i.e. if the Check brings at least one Fail message
Return type:bool
IsUnknown()
  • Returns True for an Unknown Entity, i,e. if the Check is empty and Concerned equates Content
Return type:bool
SetContent()
  • Sets a Content : it 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.
Parameters:content (Handle_Standard_Transient &) –
Return type:None
thisown

The membership flag

class Interface_SequenceNodeOfSequenceOfCheck(*args)

Bases: OCC.TCollection.TCollection_SeqNode

Parameters:
  • I (Handle_Interface_Check &) –
  • n (TCollection_SeqNodePtr &) –
  • p (TCollection_SeqNodePtr &) –
Return type:

None
GetHandle()
Value()
Return type:Handle_Interface_Check
thisown

The membership flag

class Interface_SequenceOfCheck(*args)

Bases: OCC.TCollection.TCollection_BaseSequence

Return type:None
Parameters:Other (Interface_SequenceOfCheck &) –
Return type:None
Append()
Parameters:
  • T (Handle_Interface_Check &) –
  • S (Interface_SequenceOfCheck &) –
Return type:

None
Return type:

None
Assign()
Parameters:Other (Interface_SequenceOfCheck &) –
Return type:Interface_SequenceOfCheck
ChangeValue()
Parameters:Index (int) –
Return type:Handle_Interface_Check
Clear()
Return type:None
First()
Return type:Handle_Interface_Check
InsertAfter()
Parameters:
  • Index (int) –
  • T (Handle_Interface_Check &) –
  • Index –
  • S (Interface_SequenceOfCheck &) –
Return type:

None
Return type:

None
InsertBefore()
Parameters:
  • Index (int) –
  • T (Handle_Interface_Check &) –
  • Index –
  • S (Interface_SequenceOfCheck &) –
Return type:

None
Return type:

None
Last()
Return type:Handle_Interface_Check
Prepend()
Parameters:
  • T (Handle_Interface_Check &) –
  • S (Interface_SequenceOfCheck &) –
Return type:

None
Return type:

None
Remove()
Parameters:
  • Index (int) –
  • FromIndex (int) –
  • ToIndex (int) –
Return type:

None
Return type:

None
Set()
Parameters:Other (Interface_SequenceOfCheck &) –
Return type:Interface_SequenceOfCheck
SetValue()
Parameters:
  • Index (int) –
  • I (Handle_Interface_Check &) –
Return type:

None
Split()
Parameters:
  • Index (int) –
  • Sub (Interface_SequenceOfCheck &) –
Return type:

None
Value()
Parameters:Index (int) –
Return type:Handle_Interface_Check
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>
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • lib (Interface_GeneralLib &) –
Return type:

None
  • Same as above, but GeneralLib is detained by a GTool
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • gtool (Handle_Interface_GTool &) –
Return type:

None
  • Same as above, but GeneralLib is defined through a Protocol
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

None
  • Same as above, but works with the GTool of the Model
Parameters:amodel (Handle_Interface_InterfaceModel &) –
Return type:None
  • Creates a ShareFlags by querying informations from a Graph (remark that Graph also has a method IsShared)
Parameters:agraph (Interface_Graph &) –
Return type:None
IsShared()
  • Returns True if <ent> is Shared by one or more other Entity(ies) of the Model
Parameters:ent (Handle_Standard_Transient &) –
Return type:bool
Model()
  • Returns the Model used for the evaluation
Return type:Handle_Interface_InterfaceModel
NbRoots()
  • Returns the count of root entities
Return type:int
Root()
  • Returns a root entity according its rank in the list of roots By default, it returns the first one
Parameters:num (int) – default value is 1
Return type:Handle_Standard_Transient
RootEntities()
  • Returns the Entities which are not Shared (see their flags)
Return type:Interface_EntityIterator
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)
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • lib (Interface_GeneralLib &) –
Return type:

None
  • Same a above, but GeneralLib is detained by a GTool
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • gtool (Handle_Interface_GTool &) –
Return type:

None
  • Same a above, but GeneralLib is defined through a Protocol Protocol is used to build the working library
Parameters:
  • amodel (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

None
  • Same as above, but works with the GTool of the Model
Parameters:amodel (Handle_Interface_InterfaceModel &) –
Return type:None
  • Creates a ShareTool from an already defined Graph Remark that the data of the Graph are copied
Parameters:agraph (Interface_Graph &) –
Return type:None
  • Completes the Graph by Adding Implied References. Hence, they are considered as Sharing References in all the other queries
Parameters:ahgraph (Handle_Interface_HGraph &) –
Return type: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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • rootlast (bool) – default value is Standard_True
Return type:

Interface_EntityIterator
Graph()
  • Returns the data used by the ShareTool to work Can then be used directly (read only)
Return type:Interface_Graph
IsShared()
  • Returns True if <ent> is Shared by other Entities in the Model
Parameters:ent (Handle_Standard_Transient &) –
Return type:bool
Model()
  • Returns the Model used for Creation (directly or for Graph)
Return type:Handle_Interface_InterfaceModel
NbTypedSharings()
  • Returns the count of Sharing Entities of an Entity, which are Kind of a given Type
Parameters:
  • ent (Handle_Standard_Transient &) –
  • atype (Handle_Standard_Type &) –
Return type:

int
Print()
  • Utility method which Prints the content of an iterator (by their Numbers)
Parameters:
  • iter (Interface_EntityIterator &) –
  • S (Handle_Message_Messenger &) –
Return type:

None
RootEntities()
  • Returns the Entities which are not Shared (their Sharing List is empty) in the Model
Return type:Interface_EntityIterator
Shareds()
  • Returns the List of Entities Shared by a given Entity <ent>
Parameters:ent (Handle_Standard_Transient &) –
Return type:Interface_EntityIterator
Sharings()
  • Returns the List of Entities Sharing a given Entity <ent>
Parameters:ent (Handle_Standard_Transient &) –
Return type: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)
Parameters:
  • ent (Handle_Standard_Transient &) –
  • atype (Handle_Standard_Type &) –
Return type:

Handle_Standard_Transient
thisown

The membership flag

class Interface_SignLabel(*args)

Bases: object

Return type:None
GetHandle()
Name()
  • Returns ‘Entity Label’
Return type:char *
Text()
  • Considers context as an InterfaceModel and returns the Label computed by it
Parameters:
  • ent (Handle_Standard_Transient &) –
  • context (Handle_Standard_Transient &) –
Return type:

TCollection_AsciiString
thisown

The membership flag

class Interface_SignType(*args, **kwargs)

Bases: object

static ClassName(*args)
  • From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed
Parameters:typnam (char *) –
Return type:char *
GetHandle()
Text()
  • Returns an identification of the Signature (a word), given at initialization time Specialised to consider context as an InterfaceModel
Parameters:
  • ent (Handle_Standard_Transient &) –
  • context (Handle_Standard_Transient &) –
Return type:

TCollection_AsciiString
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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

char *
thisown

The membership flag

Interface_SignType_ClassName(*args)
  • From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed
Parameters:typnam (char *) –
Return type:char *
class Interface_Static(*args)

Bases: OCC.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 available : Integer, 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
Parameters:
  • family (char *) –
  • name (char *) –
  • type (Interface_ParamType) – default value is Interface_ParamText
  • init (char *) – default value is
Return type:

None
  • Creates a new Static with same definition as another one (value is copied, except for Entity : it remains null)
Parameters:
  • family (char *) –
  • name (char *) –
  • other (Handle_Interface_Static &) –
Return type:

None
static CDef(*args)
  • 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 CDef : family : the family type : the type (‘integer’,’real’,’text’,’enum’) label : the label satis : satisfy function name if any rmin : minimum real value rmax : maximum real value imin : minimum integer value imax : maximum integer value enum nn (nn : value of an integer) : enum value for nn unit : unit definition for a real
Parameters:
  • name (char *) –
  • part (char *) –
Return type:

char *
static CVal(*args)
  • 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’
Parameters:name (char *) –
Return type:char *
Family()
  • Returns the family. It can be : a resource name for applis, an internal name between : $e (environment variables), $l (other, purely local)
Return type:char *
GetHandle()
static IDef(*args)
  • 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 IDef : imin, imax : minimum or maximum integer value estart : starting number for enum ecount : count of enum values (starting from estart) ematch : exact match status eval val : case determined from a string
Parameters:
  • name (char *) –
  • part (char *) –
Return type:

int
static IVal(*args)
  • 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
Parameters:name (char *) –
Return type:int
static Init(*args)
  • 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
Parameters:
  • family (char *) –
  • name (char *) –
  • type (Interface_ParamType) –
  • init (char *) – default value is
Return type:

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
Parameters:
  • family (char *) –
  • name (char *) –
  • type (Standard_Character) –
  • init (char *) – default value is
Return type:

bool
static IsPresent(*args)
  • Returns True if a Static named <name> is present, False else
Parameters:name (char *) –
Return type:bool
static IsSet(*args)
  • Returns True if <name> is present AND set <proper> True (D) : considers this item only <proper> False : if not set and attached to a wild-card, considers this wild-card
Parameters:
  • name (char *) –
  • proper (bool) – default value is Standard_True
Return type:

bool
static IsUpdated(*args)
  • Returns the status ‘uptodate’ from a Static Returns False if <name> is not present
Parameters:name (char *) –
Return type:bool
static Items(*args)
  • Returns a list of names of statics : <mode> = 0 (D) : criter is for family <mode> = 1 : criter is regexp on names, takes final items (ignore wild cards) <mode> = 2 : idem but take only wilded, not final items <mode> = 3 : idem, take all items matching criter idem + 100 : takes only non-updated items idem + 200 : takes only updated items criter empty (D) : returns all names else returns names which match the given criter Remark : families 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
Parameters:
  • mode (int) – default value is 0
  • criter (char *) – default value is
Return type:

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
Parameters:S (Handle_Message_Messenger &) –
Return type:None
static RVal(*args)
  • Returns the value of a static translation parameter identified by the string name. Returns the value 0.0 if the parameter does not exist.
Parameters:name (char *) –
Return type:float
static SetCVal(*args)
  • 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.
Parameters:
  • name (char *) –
  • val (char *) –
Return type:

bool
static SetIVal(*args)
  • 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
Parameters:
  • name (char *) –
  • val (int) –
Return type:

bool
static SetRVal(*args)
  • 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.
Parameters:
  • name (char *) –
  • val (float) –
Return type:

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
Return type:None
SetWild()
  • Sets a ‘wild-card’ static : its value will be considered if <self> is not properly set. (reset by set a null one)
Parameters:wildcard (Handle_Interface_Static &) –
Return type:None
static Standards(*args)
  • 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
Return type:void
static Static(*args)
  • Returns a Static from its name. Null Handle if not present
Parameters:name (char *) –
Return type:Handle_Interface_Static
static Update(*args)
  • 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
Parameters:name (char *) –
Return type:bool
UpdatedStatus()
  • Returns the status ‘uptodate’
Return type:bool
Wild()
  • Returns the wildcard static, which can be (is most often) null
Return type:Handle_Interface_Static
thisown

The membership flag

Interface_Static_CDef(*args)
  • 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 CDef : family : the family type : the type (‘integer’,’real’,’text’,’enum’) label : the label satis : satisfy function name if any rmin : minimum real value rmax : maximum real value imin : minimum integer value imax : maximum integer value enum nn (nn : value of an integer) : enum value for nn unit : unit definition for a real
Parameters:
  • name (char *) –
  • part (char *) –
Return type:

char *
Interface_Static_CVal(*args)
  • 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’
Parameters:name (char *) –
Return type:char *
Interface_Static_IDef(*args)
  • 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 IDef : imin, imax : minimum or maximum integer value estart : starting number for enum ecount : count of enum values (starting from estart) ematch : exact match status eval val : case determined from a string
Parameters:
  • name (char *) –
  • part (char *) –
Return type:

int
Interface_Static_IVal(*args)
  • 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
Parameters:name (char *) –
Return type:int
Interface_Static_Init(*args)
  • 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
Parameters:
  • family (char *) –
  • name (char *) –
  • type (Interface_ParamType) –
  • init (char *) – default value is
Return type:

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
Parameters:
  • family (char *) –
  • name (char *) –
  • type (Standard_Character) –
  • init (char *) – default value is
Return type:

bool
Interface_Static_IsPresent(*args)
  • Returns True if a Static named <name> is present, False else
Parameters:name (char *) –
Return type:bool
Interface_Static_IsSet(*args)
  • Returns True if <name> is present AND set <proper> True (D) : considers this item only <proper> False : if not set and attached to a wild-card, considers this wild-card
Parameters:
  • name (char *) –
  • proper (bool) – default value is Standard_True
Return type:

bool
Interface_Static_IsUpdated(*args)
  • Returns the status ‘uptodate’ from a Static Returns False if <name> is not present
Parameters:name (char *) –
Return type:bool
Interface_Static_Items(*args)
  • Returns a list of names of statics : <mode> = 0 (D) : criter is for family <mode> = 1 : criter is regexp on names, takes final items (ignore wild cards) <mode> = 2 : idem but take only wilded, not final items <mode> = 3 : idem, take all items matching criter idem + 100 : takes only non-updated items idem + 200 : takes only updated items criter empty (D) : returns all names else returns names which match the given criter Remark : families 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
Parameters:
  • mode (int) – default value is 0
  • criter (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfHAsciiString
Interface_Static_RVal(*args)
  • Returns the value of a static translation parameter identified by the string name. Returns the value 0.0 if the parameter does not exist.
Parameters:name (char *) –
Return type:float
Interface_Static_SetCVal(*args)
  • 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.
Parameters:
  • name (char *) –
  • val (char *) –
Return type:

bool
Interface_Static_SetIVal(*args)
  • 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
Parameters:
  • name (char *) –
  • val (int) –
Return type:

bool
Interface_Static_SetRVal(*args)
  • 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.
Parameters:
  • name (char *) –
  • val (float) –
Return type:

bool
Interface_Static_Standards(*args)
  • 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
Return type:void
Interface_Static_Static(*args)
  • Returns a Static from its name. Null Handle if not present
Parameters:name (char *) –
Return type:Handle_Interface_Static
Interface_Static_Update(*args)
  • 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
Parameters:name (char *) –
Return type:bool
class Interface_TypedValue(*args)

Bases: object

  • Creates a TypedValue, with a name //! type gives the type of the parameter, default is free text Also available : Integer, 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
Parameters:
  • name (char *) –
  • type (Interface_ParamType) – default value is Interface_ParamText
  • init (char *) – default value is
Return type:

None
GetHandle()
static ParamTypeToValueType(*args)
  • Correspondance ParamType from Interface to ValueType from MoniTool
Parameters:typ (Interface_ParamType) –
Return type: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
Return type:Interface_ParamType
static ValueTypeToParamType(*args)
  • Correspondance ParamType from Interface to ValueType from MoniTool
Parameters:typ (MoniTool_ValueType) –
Return type:Interface_ParamType
thisown

The membership flag

Interface_TypedValue_ParamTypeToValueType(*args)
  • Correspondance ParamType from Interface to ValueType from MoniTool
Parameters:typ (Interface_ParamType) –
Return type:MoniTool_ValueType
Interface_TypedValue_ValueTypeToParamType(*args)
  • Correspondance ParamType from Interface to ValueType from MoniTool
Parameters:typ (MoniTool_ValueType) –
Return type:Interface_ParamType
class Interface_UndefinedContent(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Defines an empty UndefinedContent
Return type:None
AddEntity()
  • Adds a Parameter which references an Entity
Parameters:
  • ptype (Interface_ParamType) –
  • ent (Handle_Standard_Transient &) –
Return type:

None
AddLiteral()
  • Adds a literal Parameter to the list
Parameters:
  • ptype (Interface_ParamType) –
  • val (Handle_TCollection_HAsciiString &) –
Return type:

None
EntityList()
  • Returns globally the list of param entities. Note that it can be used as shared entity list for the UndefinedEntity
Return type: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)
Parameters:
  • other (Handle_Interface_UndefinedContent &) –
  • TC (Interface_CopyTool &) –
Return type:

None
GetHandle()
IsParamEntity()
  • Returns True if a Parameter is recorded as an entity Error if num is not between 1 and NbParams
Parameters:num (int) –
Return type:bool
NbLiterals()
  • Gives count of Literal Parameters
Return type:int
NbParams()
  • Gives count of recorded parameters
Return type:int
ParamData()
  • Returns data of a Parameter : its 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
Parameters:
  • num (int) –
  • ptype (Interface_ParamType &) –
  • ent (Handle_Standard_Transient &) –
  • val (Handle_TCollection_HAsciiString &) –
Return type:

bool
ParamEntity()
  • Returns Entity corresponding to a Param, given its rank
Parameters:num (int) –
Return type:Handle_Standard_Transient
ParamType()
  • Returns the ParamType of a Param, given its rank Error if num is not between 1 and NbParams
Parameters:num (int) –
Return type:Interface_ParamType
ParamValue()
  • Returns litteral value of a Parameter, given its rank
Parameters:num (int) –
Return type:Handle_TCollection_HAsciiString
RemoveParam()
  • Removes a Parameter given its rank
Parameters:num (int) –
Return type:None
Reservate()
  • Manages reservation for parameters (internal use) (nb : total count of parameters, nblit : count of literals)
Parameters:
  • nb (int) –
  • nblit (int) –
Return type:

None
SetEntity()
  • Sets a new value for the Parameter <num>, to reference an Entity. To simply change the Entity, see the variant below
Parameters:
  • num (int) –
  • ptype (Interface_ParamType) –
  • ent (Handle_Standard_Transient &) –
Return type:

None
  • Changes the Entity referenced by the Parameter <num> (with same ParamType)
Parameters:
  • num (int) –
  • ent (Handle_Standard_Transient &) –
Return type:

None
SetLiteral()
  • Sets a new value for the Parameter <num>, to a literal value (if it referenced formerly an Entity, this Entity is removed)
Parameters:
  • num (int) –
  • ptype (Interface_ParamType) –
  • val (Handle_TCollection_HAsciiString &) –
Return type:

None
thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()
copy()
decr()
distance()
equal()
incr()
next()
previous()
thisown

The membership flag

value()
register_handle(handle, base_object)

Inserts the handle into the base object to prevent memory corruption in certain cases