OCC.Core.Standard module

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

class Standard_ArrayStreamBuffer(*args)

Bases: object

  • Main constructor. Passed pointer is stored as is (memory is NOT copied nor released with destructor). @param theBegin pointer to the beggining of pre-allocated buffer @param theSize length of pre-allocated buffer
    param theBegin

    type theBegin

    char *

    param theSize

    type theSize

    size_t

    rtype

    None

Init()
  • (Re)-initialize the stream. Passed pointer is stored as is (memory is NOT copied nor released with destructor). @param theBegin pointer to the beggining of pre-allocated buffer @param theSize length of pre-allocated buffer
    param theBegin

    type theBegin

    char *

    param theSize

    type theSize

    size_t

    rtype

    void

property thisown

The membership flag

xsgetn()
  • Read a bunch of bytes at once.
    param thePtr

    type thePtr

    char *

    param theCount

    type theCount

    std::streamsize

    rtype

    std::streamsize

class Standard_Condition(*args)

Bases: object

  • Default constructor. @param theIsSet Initial flag state
    param theIsSet

    type theIsSet

    bool

    rtype

    None

Check()
  • Do not wait for signal - just test it state. returns true if get event
    rtype

    bool

CheckReset()
  • Method perform two steps at-once - reset the event object and returns true if it was in signaling state. returns true if event object was in signaling state.
    rtype

    bool

Reset()
  • Reset event (unset signaling state)
    rtype

    None

Set()
  • Set event into signaling state.
    rtype

    None

Wait()
  • Wait for Event (infinity).
    rtype

    None* Wait for signal requested time. @param theTimeMilliseconds wait limit in milliseconds returns true if get event

    param theTimeMilliseconds

    type theTimeMilliseconds

    int

    rtype

    bool

property thisown

The membership flag

class Standard_ErrorHandler(*args)

Bases: object

  • Create a ErrorHandler (to be used with try{}catch(){}). It uses the ‘setjmp’ and ‘longjmp’ routines.
    rtype

    None

Catches()
  • Returns ‘True’ if the caught exception has the same type or inherits from ‘aType’
    param aType

    type aType

    Standard_Type

    rtype

    bool

Destroy()
  • Unlinks and checks if there is a raised exception.
    rtype

    None

Error()
  • Returns the current Error.
    rtype

    opencascade::handle<Standard_Failure>

static IsInTryBlock()
  • Test if the code is currently running in a try block
    rtype

    bool

Label()
  • Returns label for jump
    rtype

    Standard_JmpBuf

static LastCaughtError()
  • Returns the caught exception.
    rtype

    opencascade::handle<Standard_Failure>

  • Removes handler from the handlers list
    rtype

    None

property thisown

The membership flag

class Standard_GUID(*args)

Bases: object

Return type

None* build a GUID from an ascii string with the following format: Length : 36 char ‘00000000-0000-0000-0000-000000000000’ :param aGuid: :type aGuid: char * :rtype: None* build a GUID from an unicode string with the following format: //! ‘00000000-0000-0000-0000-000000000000’ :param aGuid: :type aGuid: Standard_ExtString :rtype: None:param a32b: :type a32b: int :param a16b1: :type a16b1: Standard_ExtCharacter :param a16b2: :type a16b2: Standard_ExtCharacter :param a16b3: :type a16b3: Standard_ExtCharacter :param a8b1: :type a8b1: Standard_Byte :param a8b2: :type a8b2: Standard_Byte :param a8b3: :type a8b3: Standard_Byte :param a8b4: :type a8b4: Standard_Byte :param a8b5: :type a8b5: Standard_Byte :param a8b6: :type a8b6: Standard_Byte :rtype: None:param aGuid: :type aGuid: Standard_UUID :rtype: None:param aGuid: :type aGuid: Standard_GUID :rtype: None

Assign()
Parameters

uid –

type uid

Standard_GUID

rtype

None:param uid:

type uid

Standard_UUID

rtype

None

static CheckGUIDFormat()
  • Check the format of a GUID string. It checks the size, the position of the ‘-‘ and the correct size of fields.
    param aGuid

    type aGuid

    char *

    rtype

    bool

Hash()
  • Hash function for GUID.
    param Upper

    type Upper

    int

    rtype

    int

static HashCode()
  • Computes a hash code for the given GUID of the Standard_Integer type, in the range [1, theUpperBound] @param theGUID the GUID which hash code is to be computed @param theUpperBound the upper bound of the range a computing hash code must be within returns a computed hash code, in the range [1, theUpperBound]
    param theGUID

    type theGUID

    Standard_GUID

    param theUpperBound

    type theUpperBound

    int

    rtype

    int

static IsEqual()
  • Returns True when the two GUID are the same.
    param string1

    type string1

    Standard_GUID

    param string2

    type string2

    Standard_GUID

    rtype

    bool

IsNotSame()
Parameters

uid –

type uid

Standard_GUID

rtype

bool

IsSame()
Parameters

uid –

type uid

Standard_GUID

rtype

bool

Set()
Parameters

uid –

type uid

Standard_GUID

rtype

None:param uid:

type uid

Standard_UUID

rtype

None

ShallowDumpToString(Standard_GUID self) → std::string
ToCString()
  • translate the GUID into ascii string the aStrGuid is allocated by user. the guid have the following format: //! ‘00000000-0000-0000-0000-000000000000’
    param aStrGuid

    type aStrGuid

    Standard_PCharacter

    rtype

    None

ToExtString()
  • translate the GUID into unicode string the aStrGuid is allocated by user. the guid have the following format: //! ‘00000000-0000-0000-0000-000000000000’
    param aStrGuid

    type aStrGuid

    Standard_PExtCharacter

    rtype

    None

ToUUID()
Return type

Standard_UUID

property thisown

The membership flag

class Standard_MMgrOpt(*args)

Bases: OCC.Core.Standard.Standard_MMgrRoot

  • Constructor. If aClear is True, the allocated emmory will be nullified. For description of other parameters, see description of the class above.
    param aClear

    default value is Standard_True

    type aClear

    bool

    param aMMap

    default value is Standard_True

    type aMMap

    bool

    param aCellSize

    default value is 200

    type aCellSize

    Standard_Size

    param aNbPages

    default value is 10000

    type aNbPages

    int

    param aThreshold

    default value is 40000

    type aThreshold

    Standard_Size

    rtype

    None

property thisown

The membership flag

class Standard_MMgrRaw(*args)

Bases: OCC.Core.Standard.Standard_MMgrRoot

  • Constructor; if aClear is True, the memory will be nullified upon allocation.
    param aClear

    default value is Standard_False

    type aClear

    bool

    rtype

    None

property thisown

The membership flag

class Standard_MMgrRoot(*args, **kwargs)

Bases: object

Allocate()
  • Allocate specified number of bytes. The actually allocated space should be rounded up to double word size (4 bytes), as this is expected by implementation of some classes in OCC (e.g. TCollection_AsciiString)
    param theSize

    type theSize

    Standard_Size

    rtype

    Standard_Address

Free()
  • Frees previously allocated memory at specified address.
    param thePtr

    type thePtr

    Standard_Address

    rtype

    void

Purge()
  • Purge internally cached unused memory blocks (if any) by releasing them to the operating system. Must return non-zero if some memory has been actually released, or zero otherwise. If option isDestroyed is True, this means that memory manager is not expected to be used any more; note however that in general case it is still possible to have calls to that instance of memory manager after this (e.g. to free memory of static objects in OCC). Thus this option should command the memory manager to release any cached memory to the system and not cache any more, but still remain operable… //! Default implementation does nothing and returns 0.
    param isDestroyed

    default value is Standard_False

    type isDestroyed

    bool

    rtype

    int

Reallocate()
  • Reallocate previously allocated memory to contain at least theSize bytes. In case of success, new pointer is returned.
    param thePtr

    type thePtr

    Standard_Address

    param theSize

    type theSize

    Standard_Size

    rtype

    Standard_Address

property thisown

The membership flag

class Standard_MMgrTBBalloc(*args)

Bases: OCC.Core.Standard.Standard_MMgrRoot

  • Constructor; if aClear is True, the memory will be nullified upon allocation.
    param aClear

    default value is Standard_False

    type aClear

    bool

    rtype

    None

property thisown

The membership flag

class Standard_OutOfMemory(*args)

Bases: object

  • Constructor is kept public for backward compatibility
    param theMessage

    default value is 0

    type theMessage

    char *

    rtype

    None

static DownCast(t)
GetMessageString()
  • Returns error message
    rtype

    char *

static NewInstance()
  • Returns global instance of exception
    param theMessage

    default value is

    type theMessage

    char *

    rtype

    opencascade::handle<Standard_OutOfMemory>

static Raise()
  • Raises exception with specified message string
    param theMessage

    default value is

    type theMessage

    char *

    rtype

    void* Raises exception with specified message string

    param theMessage

    type theMessage

    Standard_SStream

    rtype

    void

SetMessageString()
  • Sets error message
    param aMessage

    type aMessage

    char *

    rtype

    None

property thisown

The membership flag

class Standard_Persistent(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None

static DownCast(t)
GetTypeNum(Standard_Persistent self) → Standard_Integer
SetTypeNum(Standard_Persistent self, Standard_Integer value)
property thisown

The membership flag

class Standard_Transient(*args)

Bases: object

  • Empty constructor
    rtype

    None* Copy constructor – does nothing

    param &

    type &

    Standard_Transient

    rtype

    None

DecrementRefCounter()
  • Decrements the reference counter of this object; returns the decremented value
    rtype

    int

Delete()
  • Memory deallocator for transient classes
    rtype

    void

static DownCast(t)
DynamicType()
  • Returns a type descriptor about this object.
    rtype

    opencascade::handle<Standard_Type>

GetRefCount()
  • //!@name Reference counting, for use by handle<> Get the reference counter of this object
    rtype

    int

IncrementRefCounter()
  • Increments the reference counter of this object
    rtype

    None

IsInstance()
  • Returns a true value if this is an instance of Type.
    param theType

    type theType

    Standard_Type

    rtype

    bool* Returns a true value if this is an instance of TypeName.

    param theTypeName

    type theTypeName

    char *

    rtype

    bool

IsKind()
  • Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    param theType

    type theType

    Standard_Type

    rtype

    bool* Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

    param theTypeName

    type theTypeName

    char *

    rtype

    bool

This()
  • Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    rtype

    Standard_Transient *

static get_type_descriptor()
  • Returns type descriptor of Standard_Transient class
    rtype

    opencascade::handle<Standard_Type>

static get_type_name()
Return type

char *

property thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

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

The membership flag

value()
class standard

Bases: object

static Allocate()
  • Allocates memory blocks aSize - bytes to allocate
    param aSize

    type aSize

    Standard_Size

    rtype

    Standard_Address

static AllocateAligned()
  • Allocates aligned memory blocks. Should be used with CPU instructions which require specific alignment. For example: SSE requires 16 bytes, AVX requires 32 bytes. @param theSize bytes to allocate @param theAlign alignment in bytes
    param theSize

    type theSize

    Standard_Size

    param theAlign

    type theAlign

    Standard_Size

    rtype

    Standard_Address

static Purge()
  • Deallocates the storage retained on the free list and clears the list. Returns non-zero if some memory has been actually freed.
    rtype

    int

static Reallocate()
  • Reallocates memory blocks aStorage - previously allocated memory block aNewSize - new size in bytes
    param aStorage

    type aStorage

    Standard_Address

    param aNewSize

    type aNewSize

    Standard_Size

    rtype

    Standard_Address

property thisown

The membership flag