# Core > Python API functions ### cloneEntity Clone an entity. ```python core.cloneEntity(entity) -> core.Entity ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | -------------------- | | [Entity](./core_types.md#entity) | entity | The entity to clone. | Returns | Type | Name | Description | | -------------------------------- | ------------ | ------------------ | | [Entity](./core_types.md#entity) | clonedEntity | The cloned entity. | ### configureFunctionLogger ```python core.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime) ``` Parameters | Type | Name | Description | | ---------------------------------- | ------------------- | ----------- | | [String](./core_types.md#string) | functionName | | | [Boolean](./core_types.md#boolean) | enableFunction | | | [Boolean](./core_types.md#boolean) | enableParameters | | | [Boolean](./core_types.md#boolean) | enableExecutionTime | | ### createEntity Create an entity. ```python core.createEntity(type) -> core.Entity ``` Parameters | Type | Name | Description | | ---------------------------------------- | ---- | ----------------------------- | | [EntityType](./core_types.md#entitytype) | type | The type of entity to create. | Returns | Type | Name | Description | | -------------------------------- | ------ | ---------------------- | | [Entity](./core_types.md#entity) | entity | The created entity id. | ### deleteEntities Delete a set of entities. ```python core.deleteEntities(entities) ``` Parameters | Type | Name | Description | | ---------------------------------------- | -------- | ------------------------- | | [EntityList](./core_types.md#entitylist) | entities | List of entity to delete. | ### getEntitiesByType Get all entities of a given type. ```python core.getEntitiesByType(type, includeUnsubscribed) -> core.EntityList ``` Parameters | Type | Name | Description | | ---------------------------------------- | ------------------- | --------------------------------- | | [EntityType](./core_types.md#entitytype) | type | The type of entities to retrieve. | | [Boolean](./core_types.md#boolean) | includeUnsubscribed | Include unsubscribed entities. | Returns | Type | Name | Description | | ---------------------------------------- | -------- | ------------------------- | | [EntityList](./core_types.md#entitylist) | entities | The returned entity list. | ### getRemainingSecondsBeforeLicenseTimeout Get the seconds left before the app force-closes after the license server is disconnected. ```python core.getRemainingSecondsBeforeLicenseTimeout() -> core.Double ``` Returns | Type | Name | Description | | -------------------------------- | ---- | ----------- | | [Double](./core_types.md#double) | time | | ### unsavedUserChanges Returns true if the user has made changes to the project. ```python core.unsavedUserChanges() -> core.Bool ``` Returns | Type | Name | Description | | ---------------------------- | ---------- | -------------------------------------------------- | | [Bool](./core_types.md#bool) | hasChanged | Boolean checking if the project has been modified. | ## DebugMessage ## Desc ### getEvent Get EventDesc of an event. ```python core.getEvent(moduleName, eventName) -> core.EventDesc ``` Parameters | Type | Name | Description | | -------------------------------- | ---------- | ------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | | [String](./core_types.md#string) | eventName | | Returns | Type | Name | Description | | -------------------------------------- | ----- | ----------- | | [EventDesc](./core_types.md#eventdesc) | event | | See also: * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getEvents Get events of a group. ```python core.getEvents(moduleName, groupName) -> core.EventDescList ``` Parameters | Type | Name | Description | | -------------------------------- | ---------- | ------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | | [String](./core_types.md#string) | groupName | Target group name. | Returns | Type | Name | Description | | ---------------------------------------------- | ------------- | ----------- | | [EventDescList](./core_types.md#eventdesclist) | eventDescList | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getFunction Get FunctionDesc of a function. ```python core.getFunction(moduleName, functionName) -> core.FunctionDesc ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | --------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | | [String](./core_types.md#string) | functionName | Target function name. | Returns | Type | Name | Description | | -------------------------------------------- | ------------ | ----------- | | [FunctionDesc](./core_types.md#functiondesc) | functionDesc | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getFunctions Get functions of a group. ```python core.getFunctions(moduleName, groupName) -> core.FunctionDescList ``` Parameters | Type | Name | Description | | -------------------------------- | ---------- | ------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | | [String](./core_types.md#string) | groupName | Target group name. | Returns | Type | Name | Description | | ---------------------------------------------------- | --------- | ----------- | | [FunctionDescList](./core_types.md#functiondesclist) | functions | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getGroup Get a group desc from a specific module. ```python core.getGroup(moduleName, groupName) -> core.GroupDesc ``` Parameters | Type | Name | Description | | -------------------------------- | ---------- | ------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | | [String](./core_types.md#string) | groupName | Target group name. | Returns | Type | Name | Description | | -------------------------------------- | ----- | ----------- | | [GroupDesc](./core_types.md#groupdesc) | group | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getGroups Get all group desc of a module. ```python core.getGroups(moduleName) -> core.GroupDescList ``` Parameters | Type | Name | Description | | -------------------------------- | ---------- | ------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | Returns | Type | Name | Description | | ---------------------------------------------- | ------ | ----------- | | [GroupDescList](./core_types.md#groupdesclist) | groups | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getModuleTypes Get TypeDescList from a module name. ```python core.getModuleTypes(moduleName) -> core.TypeDescList ``` Parameters | Type | Name | Description | | -------------------------------- | ---------- | ------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | Returns | Type | Name | Description | | -------------------------------------------- | ------------ | ----------- | | [TypeDescList](./core_types.md#typedesclist) | typeDescList | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getModules Get all modules desc. ```python core.getModules() -> core.ModuleDescList ``` Returns | Type | Name | Description | | ------------------------------------------------ | ------- | ----------- | | [ModuleDescList](./core_types.md#moduledesclist) | modules | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getModulesName Get all modules name. ```python core.getModulesName() -> core.StringList ``` Returns | Type | Name | Description | | ---------------------------------------- | ----------- | ----------- | | [StringList](./core_types.md#stringlist) | modulesName | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getType](./core_functions.md#gettype) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getType Get TypeDesc from a type name. ```python core.getType(moduleName, typeNameStr) -> core.TypeDesc ``` Parameters | Type | Name | Description | | -------------------------------- | ----------- | ------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | | [String](./core_types.md#string) | typeNameStr | Target type name. | Returns | Type | Name | Description | | ------------------------------------ | -------- | ----------- | | [TypeDesc](./core_types.md#typedesc) | typeDesc | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getTypeAttributes](./core_functions.md#gettypeattributes) ### getTypeAttributes Get attributes TypeDesc from a type name. ```python core.getTypeAttributes(moduleName, typeNameStr) -> core.StringPairList ``` Parameters | Type | Name | Description | | -------------------------------- | ----------- | ------------------- | | [String](./core_types.md#string) | moduleName | Target module name. | | [String](./core_types.md#string) | typeNameStr | Target type name. | Returns | Type | Name | Description | | ------------------------------------------------ | ---------- | ----------- | | [StringPairList](./core_types.md#stringpairlist) | attributes | | See also: * [core.getEvent](./core_functions.md#getevent) * [core.getEvents](./core_functions.md#getevents) * [core.getFunction](./core_functions.md#getfunction) * [core.getFunctions](./core_functions.md#getfunctions) * [core.getGroup](./core_functions.md#getgroup) * [core.getGroups](./core_functions.md#getgroups) * [core.getModuleTypes](./core_functions.md#getmoduletypes) * [core.getModules](./core_functions.md#getmodules) * [core.getModulesName](./core_functions.md#getmodulesname) * [core.getType](./core_functions.md#gettype) ## UI ### defineCaptchaCallback Define a callback function to customize the captha which unlock automated functions in interactive products. ```python core.defineCaptchaCallback(callback) ``` Parameters | Type | Name | Description | | -------------------------------------------------- | -------- | ---------------------- | | [CaptchaCallback](./core_types.md#captchacallback) | callback | The callback function. | ## database ### entityExists Returns true if the entity exists. ```python core.entityExists(entity) -> core.Boolean ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | ------------------ | | [Entity](./core_types.md#entity) | entity | The wanted entity. | Returns | Type | Name | Description | | ---------------------------------- | ------ | ------------------ | | [Boolean](./core_types.md#boolean) | exists | True if it exists. | See also: * [core.getAllEntities](./core_functions.md#getallentities) * [core.getCurrentPiXYZFile](./core_functions.md#getcurrentpixyzfile) * [core.getEntityType](./core_functions.md#getentitytype) * [core.getEntityTypeString](./core_functions.md#getentitytypestring) * [core.getTypeStats](./core_functions.md#gettypestats) * [core.isCurrentPiXYZFileModified](./core_functions.md#iscurrentpixyzfilemodified) * [core.lockEntityRegistration](./core_functions.md#lockentityregistration) * [core.unlockEntityRegistration](./core_functions.md#unlockentityregistration) ### getAllEntities Returns all the entities on the database. ```python core.getAllEntities() -> core.EntityList ``` Returns | Type | Name | Description | | ---------------------------------------- | -------- | ------------- | | [EntityList](./core_types.md#entitylist) | entities | All entities. | See also: * [core.entityExists](./core_functions.md#entityexists) * [core.getCurrentPiXYZFile](./core_functions.md#getcurrentpixyzfile) * [core.getEntityType](./core_functions.md#getentitytype) * [core.getEntityTypeString](./core_functions.md#getentitytypestring) * [core.getTypeStats](./core_functions.md#gettypestats) * [core.isCurrentPiXYZFileModified](./core_functions.md#iscurrentpixyzfilemodified) * [core.lockEntityRegistration](./core_functions.md#lockentityregistration) * [core.unlockEntityRegistration](./core_functions.md#unlockentityregistration) ### getCurrentPiXYZFile Get current (loaded) Pixyz file path. ```python core.getCurrentPiXYZFile() -> core.FilePath ``` Returns | Type | Name | Description | | ------------------------------------ | -------- | ----------------------- | | [FilePath](./core_types.md#filepath) | fileName | The current Pixyz file. | See also: * [core.entityExists](./core_functions.md#entityexists) * [core.getAllEntities](./core_functions.md#getallentities) * [core.getEntityType](./core_functions.md#getentitytype) * [core.getEntityTypeString](./core_functions.md#getentitytypestring) * [core.getTypeStats](./core_functions.md#gettypestats) * [core.isCurrentPiXYZFileModified](./core_functions.md#iscurrentpixyzfilemodified) * [core.lockEntityRegistration](./core_functions.md#lockentityregistration) * [core.unlockEntityRegistration](./core_functions.md#unlockentityregistration) ### getEntityType Returns the type id of the entity. ```python core.getEntityType(entity) -> core.EntityType ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | ------------------ | | [Entity](./core_types.md#entity) | entity | The wanted entity. | Returns | Type | Name | Description | | ---------------------------------------- | ---- | ------------------------ | | [EntityType](./core_types.md#entitytype) | type | Type type of the entity. | See also: * [core.entityExists](./core_functions.md#entityexists) * [core.getAllEntities](./core_functions.md#getallentities) * [core.getCurrentPiXYZFile](./core_functions.md#getcurrentpixyzfile) * [core.getEntityTypeString](./core_functions.md#getentitytypestring) * [core.getTypeStats](./core_functions.md#gettypestats) * [core.isCurrentPiXYZFileModified](./core_functions.md#iscurrentpixyzfilemodified) * [core.lockEntityRegistration](./core_functions.md#lockentityregistration) * [core.unlockEntityRegistration](./core_functions.md#unlockentityregistration) ### getEntityTypeString Returns the type name of the entity. ```python core.getEntityTypeString(entity) -> core.String ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | ------------------ | | [Entity](./core_types.md#entity) | entity | The wanted entity. | Returns | Type | Name | Description | | -------------------------------- | ---- | ------------------------ | | [String](./core_types.md#string) | type | Name of the entity type. | See also: * [core.entityExists](./core_functions.md#entityexists) * [core.getAllEntities](./core_functions.md#getallentities) * [core.getCurrentPiXYZFile](./core_functions.md#getcurrentpixyzfile) * [core.getEntityType](./core_functions.md#getentitytype) * [core.getTypeStats](./core_functions.md#gettypestats) * [core.isCurrentPiXYZFileModified](./core_functions.md#iscurrentpixyzfilemodified) * [core.lockEntityRegistration](./core_functions.md#lockentityregistration) * [core.unlockEntityRegistration](./core_functions.md#unlockentityregistration) ### getTypeStats Get the database stats. ```python core.getTypeStats() -> core.IntListList ``` Returns | Type | Name | Description | | ------------------------------------------ | ----- | ----------- | | [IntListList](./core_types.md#intlistlist) | stats | | See also: * [core.entityExists](./core_functions.md#entityexists) * [core.getAllEntities](./core_functions.md#getallentities) * [core.getCurrentPiXYZFile](./core_functions.md#getcurrentpixyzfile) * [core.getEntityType](./core_functions.md#getentitytype) * [core.getEntityTypeString](./core_functions.md#getentitytypestring) * [core.isCurrentPiXYZFileModified](./core_functions.md#iscurrentpixyzfilemodified) * [core.lockEntityRegistration](./core_functions.md#lockentityregistration) * [core.unlockEntityRegistration](./core_functions.md#unlockentityregistration) ### isCurrentPiXYZFileModified Return true, if the current (loaded) file has been modified since last load or save. ```python core.isCurrentPiXYZFileModified() -> core.Boolean ``` Returns | Type | Name | Description | | ---------------------------------- | -------- | ----------------------------- | | [Boolean](./core_types.md#boolean) | modified | True if the file is modified. | See also: * [core.entityExists](./core_functions.md#entityexists) * [core.getAllEntities](./core_functions.md#getallentities) * [core.getCurrentPiXYZFile](./core_functions.md#getcurrentpixyzfile) * [core.getEntityType](./core_functions.md#getentitytype) * [core.getEntityTypeString](./core_functions.md#getentitytypestring) * [core.getTypeStats](./core_functions.md#gettypestats) * [core.lockEntityRegistration](./core_functions.md#lockentityregistration) * [core.unlockEntityRegistration](./core_functions.md#unlockentityregistration) ### lockEntityRegistration Lock Entity registration, use with Caution. All entities created after this call will not be saved on .pxz file and will not be listed as existing entities on the Database. Be careful to not references these entities with other registered entities. ```python core.lockEntityRegistration() ``` See also: * [core.entityExists](./core_functions.md#entityexists) * [core.getAllEntities](./core_functions.md#getallentities) * [core.getCurrentPiXYZFile](./core_functions.md#getcurrentpixyzfile) * [core.getEntityType](./core_functions.md#getentitytype) * [core.getEntityTypeString](./core_functions.md#getentitytypestring) * [core.getTypeStats](./core_functions.md#gettypestats) * [core.isCurrentPiXYZFileModified](./core_functions.md#iscurrentpixyzfilemodified) * [core.unlockEntityRegistration](./core_functions.md#unlockentityregistration) ### unlockEntityRegistration Unlock Entity registration. ```python core.unlockEntityRegistration() ``` See also: * [core.entityExists](./core_functions.md#entityexists) * [core.getAllEntities](./core_functions.md#getallentities) * [core.getCurrentPiXYZFile](./core_functions.md#getcurrentpixyzfile) * [core.getEntityType](./core_functions.md#getentitytype) * [core.getEntityTypeString](./core_functions.md#getentitytypestring) * [core.getTypeStats](./core_functions.md#gettypestats) * [core.isCurrentPiXYZFileModified](./core_functions.md#iscurrentpixyzfilemodified) * [core.lockEntityRegistration](./core_functions.md#lockentityregistration) ## license ### addWantedToken Add a license token to the list of wanted tokens. The wanted tokens list is saved on disk in program data and is used at initialization. Prefer using 'core.needToken' instead. ```python core.addWantedToken(tokenName) ``` Parameters | Type | Name | Description | | -------------------------------- | --------- | ------------- | | [String](./core_types.md#string) | tokenName | Wanted token. | See also: * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### checkLicense Verifies the validity of the current installed license to ensure compliance and access control. ```python core.checkLicense() -> core.Boolean ``` Returns | Type | Name | Description | | ---------------------------------- | ----- | ---------------------------------------------------------------------------------------------------- | | [Boolean](./core_types.md#boolean) | valid | A Boolean value indicating whether the current installed license is valid (true) or invalid (false). | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### checkWebLogin Check if authentification on the Web license API is sucessfull. ```python core.checkWebLogin(login, password) -> core.Boolean ``` Parameters | Type | Name | Description | | ------------------------------------ | -------- | --------------------- | | [String](./core_types.md#string) | login | WEB account login. | | [Password](./core_types.md#password) | password | WEB account password. | Returns | Type | Name | Description | | ---------------------------------- | ----- | ----------- | | [Boolean](./core_types.md#boolean) | valid | | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### configureLicenseServer Configure the license server to use to get floating licenses. For a UNITY server, the address can be a bare host (the server URL is composed as `http://address:port`) or a full http(s):// URL (port is then ignored); the setting only applies when the SDK launches its own bundled Unity licensing client (in a Unity Editor or Hub environment the already-running licensing client owns its own server configuration). ```python core.configureLicenseServer(address, port, serverType=1, toolset="") ``` Parameters | Type | Name | Description | | ------------------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------- | | [String](./core_types.md#string) | address | Server address. | | [UShort](./core_types.md#ushort) | port | Server port. | | [LicenseServerType](./core_types.md#licenseservertype) | serverType | Type of license server (PIXYZ, FLEXLM or UNITY). | | [String](./core_types.md#string) | toolset | UNITY server only: name of the license pool (toolset) to acquire the floating license from; empty selects the server default pool. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### generateActivationCode Create an activation code to generate an offline license. ```python core.generateActivationCode(filePath) ``` Parameters | Type | Name | Description | | ------------------------------------------------ | -------- | ---------------------------------- | | [OutputFilePath](./core_types.md#outputfilepath) | filePath | Path to write the activation code. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### generateDeactivationCode Create an deactivation code to release the license from this machine. ```python core.generateDeactivationCode(filePath) ``` Parameters | Type | Name | Description | | ------------------------------------------------ | -------- | ------------------------------------ | | [OutputFilePath](./core_types.md#outputfilepath) | filePath | Path to write the deactivation code. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### getCurrentLicenseInfos Get information on current installed license. ```python core.getCurrentLicenseInfos() -> core.LicenseInfos ``` Returns | Type | Name | Description | | -------------------------------------------- | ------------ | ----------- | | [LicenseInfos](./core_types.md#licenseinfos) | licenseInfos | | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### getLicenseError Get errors from license check. ```python core.getLicenseError() -> core.Boolean, core.String ``` Returns | Type | Name | Description | | ---------------------------------- | ------- | ----------- | | [Boolean](./core_types.md#boolean) | valid | | | [String](./core_types.md#string) | reasons | | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### getLicenseServer Get current license server. ```python core.getLicenseServer() -> core.String, core.UShort, core.LicenseServerType, core.String ``` Returns | Type | Name | Description | | ------------------------------------------------------ | ---------- | ------------------------------------------------------------------------------- | | [String](./core_types.md#string) | serverHost | Server host name or IP. | | [UShort](./core_types.md#ushort) | serverPort | Server port. | | [LicenseServerType](./core_types.md#licenseservertype) | serverType | Type of license server (PIXYZ, FLEXLM or UNITY). | | [String](./core_types.md#string) | toolset | UNITY server only: name of the license pool (toolset), empty if server default. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### installLicense Add a new license. You can use either an activation .bin file from the website or a .lic file. ```python core.installLicense(licensePath, user=False) ``` Parameters | Type | Name | Description | | ------------------------------------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [FilePath](./core_types.md#filepath) | licensePath | License file path (.bin or .lic). | | [Boolean](./core_types.md#boolean) | user | Decide if the .lic license is installed only for this user or for all users. If false, Pixyz must be configured by running 'PiXYZFinishInstall' utility first (only once). | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### listOwnedTokens Get the list of actually owned license tokens. ```python core.listOwnedTokens() -> core.StringList ``` Returns | Type | Name | Description | | ---------------------------------------- | ----------- | ----------------- | | [StringList](./core_types.md#stringlist) | ownedTokens | Owned token list. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### listTokens Get the list of license tokens for this product. ```python core.listTokens(onlyMandatory=False) -> core.StringList ``` Parameters | Type | Name | Description | | ---------------------------- | ------------- | ---------------------------------------------- | | [Bool](./core_types.md#bool) | onlyMandatory | If True, optional tokens will not be returned. | Returns | Type | Name | Description | | ---------------------------------------- | ------ | ----------- | | [StringList](./core_types.md#stringlist) | tokens | Token list. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### listWantedTokens Get the list of license token configured to be requested at initialization. ```python core.listWantedTokens() -> core.StringList ``` Returns | Type | Name | Description | | ---------------------------------------- | ------ | ----------- | | [StringList](./core_types.md#stringlist) | tokens | Token list. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### needToken Requests a license token for the current session. This step should be done after configuring license server. Throws an exception if the token is not available. ```python core.needToken(tokenName) ``` Parameters | Type | Name | Description | | -------------------------------- | --------- | ----------- | | [String](./core_types.md#string) | tokenName | Token name. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### ownToken Returns True if we own a token, without requesting it. ```python core.ownToken(tokenName) -> core.Boolean ``` Parameters | Type | Name | Description | | -------------------------------- | --------- | ----------- | | [String](./core_types.md#string) | tokenName | Token name. | Returns | Type | Name | Description | | ---------------------------------- | ----- | --------------------------- | | [Boolean](./core_types.md#boolean) | owned | True if the token is owned. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### releaseToken Release an optional license token. ```python core.releaseToken(tokenName) ``` Parameters | Type | Name | Description | | -------------------------------- | --------- | ----------- | | [String](./core_types.md#string) | tokenName | Token name. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### releaseWebLicense Release License owned by user WEB account. ```python core.releaseWebLicense(login, password, id) ``` Parameters | Type | Name | Description | | ------------------------------------ | -------- | --------------------- | | [String](./core_types.md#string) | login | WEB account login. | | [Password](./core_types.md#password) | password | WEB account password. | | [Ident](./core_types.md#ident) | id | WEB license id. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### removeWantedToken Remove a license token from the list of wanted optional tokens. ```python core.removeWantedToken(tokenName) ``` Parameters | Type | Name | Description | | -------------------------------- | --------- | --------------- | | [String](./core_types.md#string) | tokenName | Unwanted token. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### requestWebLicense Request License owned by user WEB account. ```python core.requestWebLicense(login, password, id) ``` Parameters | Type | Name | Description | | ------------------------------------ | -------- | --------------------- | | [String](./core_types.md#string) | login | WEB account login. | | [Password](./core_types.md#password) | password | WEB account password. | | [Ident](./core_types.md#ident) | id | WEB license id. | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) * [core.tokenValid](./core_functions.md#tokenvalid) ### retrieveWebLicenses Retrieves License owned by user WEB account. ```python core.retrieveWebLicenses(login, password) -> core.WebLicenseInfoList ``` Parameters | Type | Name | Description | | ------------------------------------ | -------- | --------------------- | | [String](./core_types.md#string) | login | WEB account login. | | [Password](./core_types.md#password) | password | WEB account password. | Returns | Type | Name | Description | | -------------------------------------------------------- | -------- | ----------- | | [WebLicenseInfoList](./core_types.md#weblicenseinfolist) | licenses | | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.tokenValid](./core_functions.md#tokenvalid) ### tokenValid Returns True if a token is owned by the product, request will be done if missing. ```python core.tokenValid(tokenName) -> core.Bool ``` Parameters | Type | Name | Description | | -------------------------------- | --------- | ----------- | | [String](./core_types.md#string) | tokenName | Token name. | Returns | Type | Name | Description | | ---------------------------- | ----- | ----------- | | [Bool](./core_types.md#bool) | valid | | See also: * [core.addWantedToken](./core_functions.md#addwantedtoken) * [core.checkLicense](./core_functions.md#checklicense) * [core.checkWebLogin](./core_functions.md#checkweblogin) * [core.configureLicenseServer](./core_functions.md#configurelicenseserver) * [core.generateActivationCode](./core_functions.md#generateactivationcode) * [core.generateDeactivationCode](./core_functions.md#generatedeactivationcode) * [core.getCurrentLicenseInfos](./core_functions.md#getcurrentlicenseinfos) * [core.getLicenseError](./core_functions.md#getlicenseerror) * [core.getLicenseServer](./core_functions.md#getlicenseserver) * [core.installLicense](./core_functions.md#installlicense) * [core.listOwnedTokens](./core_functions.md#listownedtokens) * [core.listTokens](./core_functions.md#listtokens) * [core.listWantedTokens](./core_functions.md#listwantedtokens) * [core.needToken](./core_functions.md#needtoken) * [core.ownToken](./core_functions.md#owntoken) * [core.releaseToken](./core_functions.md#releasetoken) * [core.releaseWebLicense](./core_functions.md#releaseweblicense) * [core.removeWantedToken](./core_functions.md#removewantedtoken) * [core.requestWebLicense](./core_functions.md#requestweblicense) * [core.retrieveWebLicenses](./core_functions.md#retrieveweblicenses) ## parallel ### parallelAddJob Add a job to a parallel session. ```python core.parallelAddJob(session, jobCallback, dataPtr) ``` Parameters | Type | Name | Description | | ---------------------------------------------------- | ----------- | ----------- | | [ParallelSession](./core_types.md#parallelsession) | session | | | [ParallelCallback](./core_types.md#parallelcallback) | jobCallback | | | [Ptr](./core_types.md#ptr) | dataPtr | | See also: * [core.parallelFinish](./core_functions.md#parallelfinish) * [core.parallelStart](./core_functions.md#parallelstart) ### parallelFinish Ends a parallel session after waiting for all jobs to finish. ```python core.parallelFinish(session) ``` Parameters | Type | Name | Description | | -------------------------------------------------- | ------- | ----------- | | [ParallelSession](./core_types.md#parallelsession) | session | | See also: * [core.parallelAddJob](./core_functions.md#paralleladdjob) * [core.parallelStart](./core_functions.md#parallelstart) ### parallelStart Starts a new parallel session. ```python core.parallelStart(progression=False, name="Parallel session", jobCount=-1) -> core.ParallelSession ``` Parameters | Type | Name | Description | | ---------------------------------- | ----------- | -------------------------------------------------- | | [Boolean](./core_types.md#boolean) | progression | Enable progression for the parallel session. | | [String](./core_types.md#string) | name | Name of the parallel session. | | [Int](./core_types.md#int) | jobCount | Count of parallel jobs if known (for progression). | Returns | Type | Name | Description | | -------------------------------------------------- | ------- | ----------- | | [ParallelSession](./core_types.md#parallelsession) | session | | See also: * [core.parallelAddJob](./core_functions.md#paralleladdjob) * [core.parallelFinish](./core_functions.md#parallelfinish) ## plugins ### getModuleDescFromXML Generate a ModuleDesc from an .xml description. ```python core.getModuleDescFromXML(xmlPath, addToModules=True) -> core.ModuleDesc ``` Parameters | Type | Name | Description | | ------------------------------------ | ------------ | --------------- | | [FilePath](./core_types.md#filepath) | xmlPath | .xml file path. | | [Boolean](./core_types.md#boolean) | addToModules | | Returns | Type | Name | Description | | ---------------------------------------- | ----------- | ----------- | | [ModuleDesc](./core_types.md#moduledesc) | description | | See also: * [core.removeModule](./core_functions.md#removemodule) ### removeModule Remove a module added via getModuleDescFromXML. ```python core.removeModule(module) ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | ------------ | | [String](./core_types.md#string) | module | Module name. | See also: * [core.getModuleDescFromXML](./core_functions.md#getmoduledescfromxml) ## progress ### popProgression Leave current progression level. ```python core.popProgression() ``` See also: * [core.pushProgression](./core_functions.md#pushprogression) * [core.stepProgression](./core_functions.md#stepprogression) ### pushProgression Create a new progression level. ```python core.pushProgression(stepCount, progressName="") ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | ----------------------------- | | [Int](./core_types.md#int) | stepCount | Step count. | | [String](./core_types.md#string) | progressName | Name of the progression step. | See also: * [core.popProgression](./core_functions.md#popprogression) * [core.stepProgression](./core_functions.md#stepprogression) ### stepProgression Add a step to current progression level. ```python core.stepProgression(stepCount=1) ``` Parameters | Type | Name | Description | | -------------------------- | --------- | ----------- | | [Int](./core_types.md#int) | stepCount | Step count. | See also: * [core.popProgression](./core_functions.md#popprogression) * [core.pushProgression](./core_functions.md#pushprogression) ## properties ### addCustomProperties Add multiple custom property to entities that support custom properties. ```python core.addCustomProperties(entities, names, values=None, types=None) ``` Parameters | Type | Name | Description | | ---------------------------------------------------- | -------- | --------------------------------------------- | | [EntityList](./core_types.md#entitylist) | entities | Entities that support custom properties. | | [StringList](./core_types.md#stringlist) | names | Name of the custom property for each entity. | | [StringList](./core_types.md#stringlist) | values | Value of the custom property for each entity. | | [PropertyTypeList](./core_types.md#propertytypelist) | types | Type of the custom property for each entity. | See also: * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### addCustomProperty Add a custom property to an entity that support custom properties. ```python core.addCustomProperty(entity, name, value="", type=0) ``` Parameters | Type | Name | Description | | -------------------------------------------- | ------ | ----------------------------------------- | | [Entity](./core_types.md#entity) | entity | An entity that support custom properties. | | [String](./core_types.md#string) | name | Name of the custom property. | | [String](./core_types.md#string) | value | Value of the custom property. | | [PropertyType](./core_types.md#propertytype) | type | Type of the custom property. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### getModuleProperty Returns the value of a module property. ```python core.getModuleProperty(module, propertyName) -> core.String ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | ------------------- | | [String](./core_types.md#string) | module | Name of the module. | | [String](./core_types.md#string) | propertyName | The property name. | Returns | Type | Name | Description | | -------------------------------- | ------------- | ------------------- | | [String](./core_types.md#string) | propertyValue | The property value. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### getModulePropertyInfo Returns the value of a module property. ```python core.getModulePropertyInfo(module, propertyName) -> core.PropertyInfo ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | ------------------- | | [String](./core_types.md#string) | module | Name of the module. | | [String](./core_types.md#string) | propertyName | The property name. | Returns | Type | Name | Description | | -------------------------------------------- | ------------ | ------------------ | | [PropertyInfo](./core_types.md#propertyinfo) | propertyInfo | The property info. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### getProperties Get the property value on entities (if the property is not set on an entity, defaultValue is returned). ```python core.getProperties(entities, propertyName, defaultValue="") -> core.StringList ``` Parameters | Type | Name | Description | | ---------------------------------------- | ------------ | -------------------------------------------------------------------- | | [EntityList](./core_types.md#entitylist) | entities | List of entities. | | [String](./core_types.md#string) | propertyName | The property name. | | [String](./core_types.md#string) | defaultValue | Default value to return if the property does not exist on an entity. | Returns | Type | Name | Description | | ---------------------------------------- | ------ | ------------------------------ | | [StringList](./core_types.md#stringlist) | values | Property value on each entity. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### getProperty Get a property value as String on an entity (error if the property does not exist on the entity). ```python core.getProperty(entity, propertyName) -> core.String ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | ------------------ | | [Entity](./core_types.md#entity) | entity | The entity. | | [String](./core_types.md#string) | propertyName | The property name. | Returns | Type | Name | Description | | -------------------------------- | ----- | ----------------------------- | | [String](./core_types.md#string) | value | The property value as String. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### getPropertyInfo Get a property info on an entity (error if the property does not exist on the entity). ```python core.getPropertyInfo(entity, propertyName) -> core.PropertyInfo ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | ------------------ | | [Entity](./core_types.md#entity) | entity | The entity. | | [String](./core_types.md#string) | propertyName | The property name. | Returns | Type | Name | Description | | -------------------------------------------- | ------------ | ------------------ | | [PropertyInfo](./core_types.md#propertyinfo) | propertyInfo | The property info. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### hasCustomProperty Return true if the custom property was found on the occurrence. ```python core.hasCustomProperty(entityId, customPropertyName) -> core.Boolean ``` Parameters | Type | Name | Description | | -------------------------------- | ------------------ | ---------------------------------- | | [Entity](./core_types.md#entity) | entityId | An entity that support properties. | | [String](./core_types.md#string) | customPropertyName | Name of the custom property. | Returns | Type | Name | Description | | ---------------------------------- | ------------- | ----------------------------------------------------- | | [Boolean](./core_types.md#boolean) | propertyFound | True if the enity has the custom propery, else False. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### hasProperty Return true if the property was found on the occurrence, will not throw any exception except if the entity does not exist. ```python core.hasProperty(entity, propertyName) -> core.Boolean ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | ---------------------------------- | | [Entity](./core_types.md#entity) | entity | An entity that support properties. | | [String](./core_types.md#string) | propertyName | Name of the property. | Returns | Type | Name | Description | | ---------------------------------- | ------------- | ------------------------------------------------------ | | [Boolean](./core_types.md#boolean) | propertyFound | True if the entity has the property asked, else False. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### listEnumLabels Returns the informations of a module property. ```python core.listEnumLabels(enumType) -> core.EnumPropertyInfo ``` Parameters | Type | Name | Description | | -------------------------- | -------- | -------------------------------------------------------------------------- | | [Int](./core_types.md#int) | enumType | The real enum type number (ie. The one return in subtype of PropertyInfo). | Returns | Type | Name | Description | | ---------------------------------------------------- | ---------------- | ----------------------- | | [EnumPropertyInfo](./core_types.md#enumpropertyinfo) | enumPropertyInfo | The enum property info. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### listModuleProperties Returns all the properties in the given module. ```python core.listModuleProperties(module) -> core.PropertyInfoList ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | ------------------- | | [String](./core_types.md#string) | module | Name of the module. | Returns | Type | Name | Description | | ---------------------------------------------------- | ---------- | ------------------------------- | | [PropertyInfoList](./core_types.md#propertyinfolist) | properties | List of module properties info. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### listProperties Returns the names and values of the properties available on an entity. ```python core.listProperties(entity) -> core.PropertyInfoList ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | --------------- | | [Entity](./core_types.md#entity) | entity | Entity to list. | Returns | Type | Name | Description | | ---------------------------------------------------- | ---------- | ---------------------------------- | | [PropertyInfoList](./core_types.md#propertyinfolist) | properties | List of available properties info. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### listPropertiesBatch Returns the names and values of the properties available on multiple entities. ```python core.listPropertiesBatch(entities) -> core.PropertyInfoListList ``` Parameters | Type | Name | Description | | ---------------------------------------- | -------- | ----------------- | | [EntityList](./core_types.md#entitylist) | entities | Entities to list. | Returns | Type | Name | Description | | ------------------------------------------------------------ | ---------- | ---------------------------------- | | [PropertyInfoListList](./core_types.md#propertyinfolistlist) | properties | List of available properties info. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### removeCustomProperty Remove a custom property from an entity that support custom properties. ```python core.removeCustomProperty(entity, name) ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | ----------------------------------------- | | [Entity](./core_types.md#entity) | entity | An entity that support custom properties. | | [String](./core_types.md#string) | name | Name of the custom property. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### restoreModulePropertyDefaultValue Restore the default value of a module property. ```python core.restoreModulePropertyDefaultValue(module, propertyName) -> core.String ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | ------------------- | | [String](./core_types.md#string) | module | Name of the module. | | [String](./core_types.md#string) | propertyName | The property name. | Returns | Type | Name | Description | | -------------------------------- | ----- | ----------------------------- | | [String](./core_types.md#string) | value | The property value as String. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### setModuleProperty Set the value of a module property. ```python core.setModuleProperty(module, propertyName, propertyValue) -> core.String ``` Parameters | Type | Name | Description | | -------------------------------- | ------------- | ------------------- | | [String](./core_types.md#string) | module | Name of the module. | | [String](./core_types.md#string) | propertyName | The property name. | | [String](./core_types.md#string) | propertyValue | The property value. | Returns | Type | Name | Description | | -------------------------------- | ----- | ----------------------------- | | [String](./core_types.md#string) | value | The property value as String. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### setProperties Set multiple properties values on entities. ```python core.setProperties(entities, propertyNames, propertyValues) ``` Parameters | Type | Name | Description | | ---------------------------------------- | -------------- | ----------------------------------- | | [EntityList](./core_types.md#entitylist) | entities | List of entities. | | [StringList](./core_types.md#stringlist) | propertyNames | The property name for each entity. | | [StringList](./core_types.md#stringlist) | propertyValues | The property value for each entity. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### setProperty Set a property value on an entity. ```python core.setProperty(entity, propertyName, propertyValue) -> core.String ``` Parameters | Type | Name | Description | | -------------------------------- | ------------- | ------------------- | | [Entity](./core_types.md#entity) | entity | The entity. | | [String](./core_types.md#string) | propertyName | The property name. | | [String](./core_types.md#string) | propertyValue | The property value. | Returns | Type | Name | Description | | -------------------------------- | ----- | ----------------------------- | | [String](./core_types.md#string) | value | The property value as String. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) * [core.unsetProperty](./core_functions.md#unsetproperty) ### supportCustomProperties Return true if an entity support custom properties. ```python core.supportCustomProperties(entity) -> core.Boolean ``` Parameters | Type | Name | Description | | -------------------------------- | ------ | ----------- | | [Entity](./core_types.md#entity) | entity | An entity. | Returns | Type | Name | Description | | ---------------------------------- | ------- | --------------------------------------------------------- | | [Boolean](./core_types.md#boolean) | support | True if the entity support custom properties, else False. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.unsetProperty](./core_functions.md#unsetproperty) ### unsetProperty Unset an entity's property. ```python core.unsetProperty(entity, propertyName) ``` Parameters | Type | Name | Description | | -------------------------------- | ------------ | ------------------ | | [Entity](./core_types.md#entity) | entity | The entity. | | [String](./core_types.md#string) | propertyName | The property name. | See also: * [core.addCustomProperties](./core_functions.md#addcustomproperties) * [core.addCustomProperty](./core_functions.md#addcustomproperty) * [core.getModuleProperty](./core_functions.md#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions.md#getmodulepropertyinfo) * [core.getProperties](./core_functions.md#getproperties) * [core.getProperty](./core_functions.md#getproperty) * [core.getPropertyInfo](./core_functions.md#getpropertyinfo) * [core.hasCustomProperty](./core_functions.md#hascustomproperty) * [core.hasProperty](./core_functions.md#hasproperty) * [core.listEnumLabels](./core_functions.md#listenumlabels) * [core.listModuleProperties](./core_functions.md#listmoduleproperties) * [core.listProperties](./core_functions.md#listproperties) * [core.listPropertiesBatch](./core_functions.md#listpropertiesbatch) * [core.removeCustomProperty](./core_functions.md#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions.md#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions.md#setmoduleproperty) * [core.setProperties](./core_functions.md#setproperties) * [core.setProperty](./core_functions.md#setproperty) * [core.supportCustomProperties](./core_functions.md#supportcustomproperties) ## system ### availableMemory Returns available memory. ```python core.availableMemory() -> core.Long, core.Long, core.Long, core.Long ``` Returns | Type | Name | Description | | ---------------------------- | --------- | ----------------------------------- | | [Long](./core_types.md#long) | availVirt | Available virtual memory in bytes. | | [Long](./core_types.md#long) | totalVirt | Total virtual memory in bytes. | | [Long](./core_types.md#long) | availPhys | Available physical memory in bytes. | | [Long](./core_types.md#long) | totalPhys | Total physical memory in bytes. | See also: * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getProductName](./core_functions.md#getproductname) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.getVersion](./core_functions.md#getversion) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### checkForUpdates Check for software update. ```python core.checkForUpdates() -> core.Bool, core.String, core.String, core.String ``` Returns | Type | Name | Description | | -------------------------------- | ------------------- | --------------------------------------------------------- | | [Bool](./core_types.md#bool) | newVersionAvailable | True if there is a new version available of this product. | | [String](./core_types.md#string) | newVersion | New version value. | | [String](./core_types.md#string) | newVersionLink | Link to download the new version. | | [String](./core_types.md#string) | htmlInfo | Html info associated with the new version. | See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getProductName](./core_functions.md#getproductname) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.getVersion](./core_functions.md#getversion) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### clearOtherTemporaryDirectories Remove all other session temporary directories (warning: make sure that no other instance of pixyz is running. ```python core.clearOtherTemporaryDirectories() ``` See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getProductName](./core_functions.md#getproductname) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.getVersion](./core_functions.md#getversion) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### getCustomVersionTag Get the Pixyz custom version tag. ```python core.getCustomVersionTag() -> core.String ``` Returns | Type | Name | Description | | -------------------------------- | ---------------- | ----------- | | [String](./core_types.md#string) | customVersionTag | | See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getProductName](./core_functions.md#getproductname) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.getVersion](./core_functions.md#getversion) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### getMemoryUsagePeak Returns the memory usage peak of the current process in MB ( only available on windows yet ). ```python core.getMemoryUsagePeak() -> core.Long ``` Returns | Type | Name | Description | | ---------------------------- | -------------- | -------------------------------------------------------------- | | [Long](./core_types.md#long) | peakWorkingSet | Maximum physical memory used by the process until now (in MB). | See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getProductName](./core_functions.md#getproductname) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.getVersion](./core_functions.md#getversion) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### getPixyzWebsiteURL Get the Pixyz website URL. ```python core.getPixyzWebsiteURL() -> core.String ``` Returns | Type | Name | Description | | -------------------------------- | ---- | ----------- | | [String](./core_types.md#string) | url | | See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getProductName](./core_functions.md#getproductname) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.getVersion](./core_functions.md#getversion) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### getProductName Get the Pixyz product name. ```python core.getProductName() -> core.String ``` Returns | Type | Name | Description | | -------------------------------- | ----------- | ----------- | | [String](./core_types.md#string) | productName | | See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.getVersion](./core_functions.md#getversion) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### getTempDirectory Get the Pixyz temp directory (server side directory in case of remote access). ```python core.getTempDirectory() -> core.String ``` Returns | Type | Name | Description | | -------------------------------- | ------ | ----------- | | [String](./core_types.md#string) | tmpDir | | See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getProductName](./core_functions.md#getproductname) * [core.getVersion](./core_functions.md#getversion) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### getVersion Get the Pixyz product version. ```python core.getVersion() -> core.String ``` Returns | Type | Name | Description | | -------------------------------- | ------- | ----------- | | [String](./core_types.md#string) | version | | See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getProductName](./core_functions.md#getproductname) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.setCurrentThreadAsProcessThread](./core_functions.md#setcurrentthreadasprocessthread) ### setCurrentThreadAsProcessThread Set the process thread. Use this function when you want to get progress changed callbacks from another thread as the one you initialized Pixyz on. ```python core.setCurrentThreadAsProcessThread() ``` See also: * [core.availableMemory](./core_functions.md#availablememory) * [core.checkForUpdates](./core_functions.md#checkforupdates) * [core.clearOtherTemporaryDirectories](./core_functions.md#clearothertemporarydirectories) * [core.getCustomVersionTag](./core_functions.md#getcustomversiontag) * [core.getMemoryUsagePeak](./core_functions.md#getmemoryusagepeak) * [core.getPixyzWebsiteURL](./core_functions.md#getpixyzwebsiteurl) * [core.getProductName](./core_functions.md#getproductname) * [core.getTempDirectory](./core_functions.md#gettempdirectory) * [core.getVersion](./core_functions.md#getversion) ## undo/redo ### clearUndoRedo Clear undo/redo history. ```python core.clearUndoRedo() ``` See also: * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### endUndoRedoStep End current undo/redo step. ```python core.endUndoRedoStep(deleteIfEmpty=True) ``` Parameters | Type | Name | Description | | ---------------------------------- | ------------- | ----------------------------------------------------------------------------------- | | [Boolean](./core_types.md#boolean) | deleteIfEmpty | If True, empty step with no modification will be deleted from the stack at the end. | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### getRedoStack Get the history of actions stack. ```python core.getRedoStack() -> core.StringList ``` Returns | Type | Name | Description | | ---------------------------------------- | --------- | ----------- | | [StringList](./core_types.md#stringlist) | redoStack | | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### getRedoStepUserData Get user data for undo step #index. ```python core.getRedoStepUserData(index) -> core.String ``` Parameters | Type | Name | Description | | ---------------------------- | ----- | ----------- | | [UInt](./core_types.md#uint) | index | | Returns | Type | Name | Description | | -------------------------------- | -------- | ----------- | | [String](./core_types.md#string) | userData | | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### getUndoStack Get the history of actions stack. ```python core.getUndoStack() -> core.StringList ``` Returns | Type | Name | Description | | ---------------------------------------- | --------- | ----------- | | [StringList](./core_types.md#stringlist) | undoStack | | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### getUndoStepUserData Get user data for undo step #index. ```python core.getUndoStepUserData(index) -> core.String ``` Parameters | Type | Name | Description | | ---------------------------- | ----- | ----------- | | [UInt](./core_types.md#uint) | index | | Returns | Type | Name | Description | | -------------------------------- | -------- | ----------- | | [String](./core_types.md#string) | userData | | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### hasRecordingStep Has recording step. ```python core.hasRecordingStep() -> core.Boolean ``` Returns | Type | Name | Description | | ---------------------------------- | ---------------- | ------------------------------------------- | | [Boolean](./core_types.md#boolean) | hasRecordingStep | True if there is recoding step, else False. | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### redo Redo some steps. ```python core.redo(count=1) ``` Parameters | Type | Name | Description | | ---------------------------- | ----- | ----------- | | [UInt](./core_types.md#uint) | count | | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### startUndoRedoStep Start a new undo/redo step. ```python core.startUndoRedoStep(stepName, userData="") ``` Parameters | Type | Name | Description | | -------------------------------- | -------- | ----------- | | [String](./core_types.md#string) | stepName | | | [String](./core_types.md#string) | userData | | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### stopProcess Stop process (works if there is recording step). ```python core.stopProcess() ``` See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) * [core.undo](./core_functions.md#undo) ### toggleUndoRedo Toggle undo/redo. ```python core.toggleUndoRedo() ``` See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.undo](./core_functions.md#undo) ### undo Undo some steps. ```python core.undo(count=1) ``` Parameters | Type | Name | Description | | ---------------------------- | ----- | ----------- | | [UInt](./core_types.md#uint) | count | | See also: * [core.clearUndoRedo](./core_functions.md#clearundoredo) * [core.endUndoRedoStep](./core_functions.md#endundoredostep) * [core.getRedoStack](./core_functions.md#getredostack) * [core.getRedoStepUserData](./core_functions.md#getredostepuserdata) * [core.getUndoStack](./core_functions.md#getundostack) * [core.getUndoStepUserData](./core_functions.md#getundostepuserdata) * [core.hasRecordingStep](./core_functions.md#hasrecordingstep) * [core.redo](./core_functions.md#redo) * [core.startUndoRedoStep](./core_functions.md#startundoredostep) * [core.stopProcess](./core_functions.md#stopprocess) * [core.toggleUndoRedo](./core_functions.md#toggleundoredo) ## verbose ### addConsoleVerbose Add a console verbose level. ```python core.addConsoleVerbose(level) ``` Parameters | Type | Name | Description | | ---------------------------------- | ----- | -------------- | | [Verbose](./core_types.md#verbose) | level | Verbose level. | See also: * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### addLogFileVerbose Add a log file verbose level. ```python core.addLogFileVerbose(level) ``` Parameters | Type | Name | Description | | ---------------------------------- | ----- | -------------- | | [Verbose](./core_types.md#verbose) | level | Verbose level. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### addSessionLogFileVerbose Add a session log file (lastSession\{Id}.log) verbose level. ```python core.addSessionLogFileVerbose(level) ``` Parameters | Type | Name | Description | | ---------------------------------- | ----- | -------------- | | [Verbose](./core_types.md#verbose) | level | Verbose level. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### configureInterfaceLogger Set new configuration for the Interface Logger. ```python core.configureInterfaceLogger(enableFunction=True, enableParameters=True, enableExecutionTime=True) ``` Parameters | Type | Name | Description | | ---------------------------------- | ------------------- | ---------------------------------------------------------------------------------------- | | [Boolean](./core_types.md#boolean) | enableFunction | If true, the called function names will be print. | | [Boolean](./core_types.md#boolean) | enableParameters | If true, the called function parameters will be print (only if enableFunction=true too). | | [Boolean](./core_types.md#boolean) | enableExecutionTime | If true, the called functions execution times will be print. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### getInterfaceLoggerConfiguration Get the current Interface Logger configuration. ```python core.getInterfaceLoggerConfiguration() -> core.Boolean, core.Boolean, core.Boolean ``` Returns | Type | Name | Description | | ---------------------------------- | -------------------- | --------------------------------------------------------- | | [Boolean](./core_types.md#boolean) | functionEnabled | True if the called function names are printed. | | [Boolean](./core_types.md#boolean) | parametersEnabled | True if the called function parameters are printed. | | [Boolean](./core_types.md#boolean) | executionTimeEnabled | True if the called functions execution times are printed. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### getLogFile Get the path of the log file. ```python core.getLogFile() -> core.OutputFilePath ``` Returns | Type | Name | Description | | ------------------------------------------------ | ---- | --------------------- | | [OutputFilePath](./core_types.md#outputfilepath) | path | Path of the log file. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### hasConsoleVerbose Returns whether a console verbose level is present. ```python core.hasConsoleVerbose(level) -> core.Bool ``` Parameters | Type | Name | Description | | ---------------------------------- | ----- | -------------- | | [Verbose](./core_types.md#verbose) | level | Verbose level. | Returns | Type | Name | Description | | ---------------------------- | ------- | --------------------------------------------- | | [Bool](./core_types.md#bool) | enabled | Whether the console verbose level is present. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### log Log a message to Pixyz output. ```python core.log(message, level) ``` Parameters | Type | Name | Description | | ---------------------------------- | ------- | --------------- | | [String](./core_types.md#string) | message | Message to log. | | [Verbose](./core_types.md#verbose) | level | Verbose level. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### removeConsoleVerbose Remove a console verbose level. ```python core.removeConsoleVerbose(level) ``` Parameters | Type | Name | Description | | ---------------------------------- | ----- | -------------- | | [Verbose](./core_types.md#verbose) | level | Verbose level. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### removeLogFileVerbose Remove a log file verbose level. ```python core.removeLogFileVerbose(level) ``` Parameters | Type | Name | Description | | ---------------------------------- | ----- | -------------- | | [Verbose](./core_types.md#verbose) | level | Verbose level. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### removeSessionLogFileVerbose Remove a session log file (lastSession\{Id}.log) verbose level. ```python core.removeSessionLogFileVerbose(level) ``` Parameters | Type | Name | Description | | ---------------------------------- | ----- | -------------- | | [Verbose](./core_types.md#verbose) | level | Verbose level. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile) * [core.setLogFile](./core_functions.md#setlogfile) ### setCoreDumpFile > **Important:** > > This function is tagged as experimental. Set the path of the core dump file that will be written when a crash occurs (default=none). ```python core.setCoreDumpFile(path) ``` Parameters | Type | Name | Description | | ------------------------------------------------ | ---- | --------------------------- | | [OutputFilePath](./core_types.md#outputfilepath) | path | Path of the core dump file. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setLogFile](./core_functions.md#setlogfile) ### setLogFile Set the path of the log file. ```python core.setLogFile(path, keepHistory=False) ``` Parameters | Type | Name | Description | | ------------------------------------------------ | ----------- | ----------------------------------------- | | [OutputFilePath](./core_types.md#outputfilepath) | path | Path of the log file. | | [Boolean](./core_types.md#boolean) | keepHistory | Keep session log history in new log file. | See also: * [core.addConsoleVerbose](./core_functions.md#addconsoleverbose) * [core.addLogFileVerbose](./core_functions.md#addlogfileverbose) * [core.addSessionLogFileVerbose](./core_functions.md#addsessionlogfileverbose) * [core.configureInterfaceLogger](./core_functions.md#configureinterfacelogger) * [core.getInterfaceLoggerConfiguration](./core_functions.md#getinterfaceloggerconfiguration) * [core.getLogFile](./core_functions.md#getlogfile) * [core.hasConsoleVerbose](./core_functions.md#hasconsoleverbose) * [core.log](./core_functions.md#log) * [core.removeConsoleVerbose](./core_functions.md#removeconsoleverbose) * [core.removeLogFileVerbose](./core_functions.md#removelogfileverbose) * [core.removeSessionLogFileVerbose](./core_functions.md#removesessionlogfileverbose) * [core.setCoreDumpFile](./core_functions.md#setcoredumpfile)