Class Pzl

=Purpose= The destination of the class Pzl is to support the use of pzl-components and to get information regarding the status of the pzl-system. The class Pzl must be included into any project, which deals with pzl-components. Such a project may be both the pzl-container and the project generating the executable application.

The implementation of the class Pzl contained: where YY and XX - appropriate license levels.
 * if to pzl-container (DLL-container) - at the pzlContainer_YY.lib static library
 * if to main executable application - at pzlPort_XX.lib static library

Any class, which included into the project and which uses the pzl-technology may use the predicates of the class Pzl.

=The list of domains used by the class=

=The list of predicates of the class Pzl= The list of predicates of the class Pzl is divided on sublists:


 * Container Information
 * This group is not for use in the ordinary programming. It serves to get the information regardng the container, such as the level of the license, information regarding components etc..


 * Component handling
 * This group of predicates gives the possibility to create instances of components using their identifiers and nicnames.This group also contains the predicate to assign the standard output flow. If you use the standard style of VIP programming, then you use this set of predicates rare.


 * Object registration
 * This group of predicates is frequently used one. It serves to register active objects and to get information regarding currently active objects. The object registry is accessible from the any part of the application based on the pzl-technology.


 * Special predicates
 * The special predicates used by special tools. Not for use by end users.

=Other resources used =
 * The class Pzl uses the pzlPort_XX.lib library, if the target is executable application (.EXE). Class Pzl uses pzlContainer_XX library, if the target is Dll-contaner (DLL). Actually these libraries contain the class Pzl implementation.
 * It is necessary to have the package pzlConfig.

=Domain details=

pzlDomains::pzlComponentsRegisterFileName_D
The status of the component registry file pzlComponentsRegisterFileName_D= pzlRegistryFileName(string FileName); pzlRegistryFileNameWronglyDefined; pzlRegistryFileNameNotInUse. The domain pzlComponentsRegisterFileName_D defines one of the statuses of the component registry file for the given applicaion. pzlRegistryFileName(string FileName) The file FileName assigned as the component registry file. pzlRegistryFileNameWronglyDefined The component registry file wrongly defined. Possibly the file not existed, when assignment was done. pzlRegistryFileNameNotInUse There was no component registry file assignment.

pzlDomains::entityUID_D
The domain entityUID_D helps to identify different entities. It may have two variants:
 * simple form str(string)
 * complex form uid(...), which corresponds to the nativeGuid of the Visual Prolog, which in turn corresponds to the GUID of the Microsoft company.

The simple form doesn’t provide the uniqueness of the identifiers. It is recommended to use in examples and in the exercises.

The complex form provides the uniqueness of the identifiers. It is not convenient to remember and to manipulate. domains entityUID_D = str(string StringIdentifier); uid(      core::unsigned32 Unsigned,       core::unsigned16 Short1,       core::unsigned16 Short2,       core::unsigned8 Byte1,       core::unsigned8 Byte2,       core::unsigned8 Byte3,       core::unsigned8 Byte4,       core::unsigned8 Byte5,       core::unsigned8 Byte6,       core::unsigned8 Byte7,       core::unsigned8 Byte8       ).

pzlDomains::pzlContainerContentInfo_D, pzlDomains::pzlComponentInfo_D
The Domain pzlContainerContentInfo_D used to describe the content of the pzl-containers. It is represented as the list of descriptions of components. pzlContainerContentInfo_D = pzlComponentInfo_D*. Each element of the list is the term of the domain pzlComponentInfo_D pzlComponentInfo_D=pzlComponentInfo ( string Alias,  entityUID_D ComponentID,  booleanInt Runable,  core::namedValue_List UserDefinedInfo  )

Here
 * Alias – the string name of the component,
 * ComponentID – component identifier
 * Runable – Boolean flag, which shows whether the component can be called and can run independently.
 * UserDefinedInfo – the list of parameters interpreted by the developer of the component.

=Predicate details=

pzl::unRegisterAll/0
=References=