Class PzlPort - Revision history

Thomas Linder Puls: classInfo

2013-05-06T13:51:59Z

classInfo

← Older revision		Revision as of 15:51, 6 May 2013
Line 9:		Line 9:
	=Predicate summary=		=Predicate summary=
	{\|cellspacing="0" border="1" style="float:center;background:#F9F9F9;color:black;"		{\|cellspacing="0" border="1" style="float:center;background:#F9F9F9;color:black;"
	\|-		\|- \|[[#pzlPort::init/0\|init:()]].
	~~\|[[#core::classInfo/0\|classInfo]].~~
	~~get the information regarding the class~~
	\|-
	\|[[#pzlPort::init/0\|init:()]].
	Initialization of the VpPuZzle system		Initialization of the VpPuZzle system
	\|-		\|-

Thomas Linder Puls: classInfo

2013-05-06T13:51:34Z

classInfo

← Older revision		Revision as of 15:51, 6 May 2013
Line 29:		Line 29:

	=Predicate details=		=Predicate details=
	~~==core::classInfo/0==~~
	~~{{predicate~~
	~~\|decl=~~
	~~<vip>classInfo:().</vip>~~
	~~\|short=~~
	~~get the information regarding the class~~
	~~\|full=~~
	~~The predicate is the tipical predicate, which is generated when any class generated automatically by the IDE of the Visual Prolog System~~
	}}
	==pzlPort::init/0==		==pzlPort::init/0==
	{{predicate		{{predicate

Kari Rastas: spelling errors corrected

2009-11-28T08:53:35Z

spelling errors corrected

← Older revision		Revision as of 10:53, 28 November 2009
Line 3:		Line 3:
	'''package PzlPort'''		'''package PzlPort'''

	The class pzlPort is the core of the VpPuzzle system and supports the use of pzl-components. This class must be included to the project, which generates the main executable ~~applicaion~~(.EXE).		The class pzlPort is the core of the VpPuzzle system and supports the use of pzl-components. This class must be included to the project, which generates the main executable application(.EXE).

	The calls of the predicates of the class PzlPort are possible only from the classes of the main executable ~~applicaion~~ project. Components placed to the dll-containers can not make a calls of the predicats of the class PzlPort.		The calls of the predicates of the class PzlPort are possible only from the classes of the main executable application project. Components placed to the dll-containers can not make a calls of the predicats of the class PzlPort.

	=Predicate summary=		=Predicate summary=
Line 47:		Line 47:
	The predicate must be the first predicate, which is used while the accessing to the Pzl-system. It must be called only once. After initialization the calls to other classes of the Pzl system become possible.		The predicate must be the first predicate, which is used while the accessing to the Pzl-system. It must be called only once. After initialization the calls to other classes of the Pzl system become possible.

	The initialization of the pzl-system may be performed ~~immidiately~~ after the main ~~applicaion~~ start. It also may be performed at any moment when the pzl-system is expected to be used.		The initialization of the pzl-system may be performed immediately after the main application start. It also may be performed at any moment when the pzl-system is expected to be used.
	The ~~deinitialization~~ of the pzl-system is impossible.		The de-initialization of the pzl-system is impossible.

	The repetitions of the initialization are ignored.		The repetitions of the initialization are ignored.
Line 82:		Line 82:
	It is possible to get the name of the component registration file, assigned at the pzl-system by the use of the predicate call <vip>RegistryFileStatus=pzl::getComponentRegisterFileName()</vip> The predicate pzl::getComponentRegisterFileName() returns the term, which reflects the status of the assignment of the file. If the file name has been assigned successfully, then the name will be returned as the parameter of the term.		It is possible to get the name of the component registration file, assigned at the pzl-system by the use of the predicate call <vip>RegistryFileStatus=pzl::getComponentRegisterFileName()</vip> The predicate pzl::getComponentRegisterFileName() returns the term, which reflects the status of the assignment of the file. If the file name has been assigned successfully, then the name will be returned as the parameter of the term.
	\|except=		\|except=
	If there is no file with the given name ''ComponentRegisterFileName'', then the exception is ~~genereated~~ with the text		If there is no file with the given name ''ComponentRegisterFileName'', then the exception is generated with the text
	<vip>"The file <ComponentRegisterFileName> can not be found"</vip>		<vip>"The file <ComponentRegisterFileName> can not be found"</vip>
	While checking the file existence the system exception are possible and they are stored with the message <vip>"System Error while checking the file <ComponentRegisterFileName> existence"</vip>		While checking the file existence the system exception are possible and they are stored with the message <vip>"System Error while checking the file <ComponentRegisterFileName> existence"</vip>

Kari Rastas: /* pzlPort::setComponentRegisterFileName/1 */ some spelling errors corrected

2009-11-28T08:49:57Z

pzlPort::setComponentRegisterFileName/1: some spelling errors corrected

← Older revision		Revision as of 10:49, 28 November 2009
Line 67:		Line 67:
	Set the name of the component registry file		Set the name of the component registry file
	\|full=		\|full=
	The file ComponentRegisterFileName is one of the places, where the information regarding the pzl-components at the given computer is stored. The other place of store is the Windows registry. When the ~~siarching~~ process runs the component registry file is used first. If the file ~~dosn~~'t exist or the component is not registered there, then the search process continued in the Windows registry.		The file ComponentRegisterFileName is one of the places, where the information regarding the pzl-components at the given computer is stored. The other place of store is the Windows registry. When the searching process runs the component registry file is used first. If the file doesn't exist or the component is not registered there, then the search process continued in the Windows registry.

	The information in the component registry file is stored in the Visual Prolog term format (save-consult data format). Before the component may be used at the given computer, it must be registered at this computer. The ~~applicaion~~, which uses the pzl-technology may avoid the use of the component registry file or the ~~applicaion~~ may assign the use of the file by using the predicate setComponentRegisterFileName/1.		The information in the component registry file is stored in the Visual Prolog term format (save-consult data format). Before the component may be used at the given computer, it must be registered at this computer. The application, which uses the pzl-technology may avoid the use of the component registry file or the application may assign the use of the file by using the predicate setComponentRegisterFileName/1.

	The parameter ''ComponentRegisterFileName'' must be the full path to the file, or it may be relative to the directory, where the main ~~applicaion~~ is placed.		The parameter ''ComponentRegisterFileName'' must be the full path to the file, or it may be relative to the directory, where the main application is placed.
	The file extension is not strongly defined in the pzl-system. The recommended file extension is - '''.PZR'''.		The file extension is not strongly defined in the pzl-system. The recommended file extension is - '''.PZR'''.

	The component registration file of the ~~applicaion~~ may be assigned only once. While the repetitive ~~assignement~~ the existence of the previous assignment is not checked.		The component registration file of the application may be assigned only once. While the repetitive assignment the existence of the previous assignment is not checked.

	The component registration data is load only once while the first access to an any pzl-component. Thus the second (and further) file assignment is not make influence on the component registration.		The component registration data is load only once while the first access to an any pzl-component. Thus the second (and further) file assignment is not make influence on the component registration.

Victor Yukhtenko: New page: {{spbCopyright}} '''package PzlPort''' The class pzlPort is the core of the VpPuzzle system and supports the use of pzl-components. This class must be included to the project, which gene...

2009-11-26T21:17:25Z

New page: {{spbCopyright}} '''package PzlPort''' The class pzlPort is the core of the VpPuzzle system and supports the use of pzl-components. This class must be included to the project, which gene...

New page

{{spbCopyright}}

'''package PzlPort'''

The class pzlPort is the core of the VpPuzzle system and supports the use of pzl-components. This class must be included to the project, which generates the main executable applicaion(.EXE).

The calls of the predicates of the class PzlPort are possible only from the classes of the main executable applicaion project. Components placed to the dll-containers can not make a calls of the predicats of the class PzlPort.

=Predicate summary=
{|cellspacing="0" border="1" style="float:center;background:#F9F9F9;color:black;"
|-
|[[#core::classInfo/0|classInfo]].
get the information regarding the class
|-
|[[#pzlPort::init/0|init:()]].
Initialization of the VpPuZzle system
|-
|[[#pzlPort::setComponentRegisterFileName/1|setComponentRegisterFileName:(string ComponentRegisterFileName)]].
Set the name of the component registry file
|-
|[[#pzlPort::isInitialized/0|isInitialized:() determ]].
Checking of the initialization status of the VpPuZzle system
|}

=Additionally used resources=
The mandatory use:
*the pzlPort_XX.lib library must be used, where XX - license qualifier. The library in fact contains the implementation of the class PzlPort and also the library includes the implementation of the handling of the pzl-container of the main executable application.
*the package pzlConfig must be used. The package PzlConfig participates in the initialization procedure.

=Predicate details=
==core::classInfo/0==
{{predicate
|decl=
<vip>classInfo:().</vip>
|short=
get the information regarding the class
|full=
The predicate is the tipical predicate, which is generated when any class generated automatically by the IDE of the Visual Prolog System
}}
==pzlPort::init/0==
{{predicate
|decl=
<vip>init:().</vip>
|short=
Initialization of the VpPuZzle system
|full=
The predicate must be the first predicate, which is used while the accessing to the Pzl-system. It must be called only once. After initialization the calls to other classes of the Pzl system become possible.

The initialization of the pzl-system may be performed immidiately after the main applicaion start. It also may be performed at any moment when the pzl-system is expected to be used.
The deinitialization of the pzl-system is impossible.

The repetitions of the initialization are ignored.
|example=
<vip>
clauses
run():-
pzlPort::init(),
TaskWindow = taskWindow::new(),
...
</vip>
}}
==pzlPort::setComponentRegisterFileName/1==
{{predicate
|decl=
<vip>setComponentRegisterFileName:(string ComponentRegisterFileName).</vip>
|short=
Set the name of the component registry file
|full=
The file ComponentRegisterFileName is one of the places, where the information regarding the pzl-components at the given computer is stored. The other place of store is the Windows registry. When the siarching process runs the component registry file is used first. If the file dosn't exist or the component is not registered there, then the search process continued in the Windows registry.

The information in the component registry file is stored in the Visual Prolog term format (save-consult data format). Before the component may be used at the given computer, it must be registered at this computer. The applicaion, which uses the pzl-technology may avoid the use of the component registry file or the applicaion may assign the use of the file by using the predicate setComponentRegisterFileName/1.

The parameter ''ComponentRegisterFileName'' must be the full path to the file, or it may be relative to the directory, where the main applicaion is placed.
The file extension is not strongly defined in the pzl-system. The recommended file extension is - '''.PZR'''.

The component registration file of the applicaion may be assigned only once. While the repetitive assignement the existence of the previous assignment is not checked.

The component registration data is load only once while the first access to an any pzl-component. Thus the second (and further) file assignment is not make influence on the component registration.

The content validation of the file ''ComponentRegisterFileName'' while the predicate '''''setComponentRegisterFileName''''' performing is not used. But the file must exist.

It is possible to get the name of the component registration file, assigned at the pzl-system by the use of the predicate call <vip>RegistryFileStatus=pzl::getComponentRegisterFileName()</vip> The predicate pzl::getComponentRegisterFileName() returns the term, which reflects the status of the assignment of the file. If the file name has been assigned successfully, then the name will be returned as the parameter of the term.
|except=
If there is no file with the given name ''ComponentRegisterFileName'', then the exception is genereated with the text
<vip>"The file <ComponentRegisterFileName> can not be found"</vip>
While checking the file existence the system exception are possible and they are stored with the message <vip>"System Error while checking the file <ComponentRegisterFileName> existence"</vip>
The error code will be stored also.
|example=
<vip>
class predicates
runProfile:(window TaskWindow,string RegistryFileName,string InitialComponent).
clauses
runProfile(_TaskWindow,RegistryFileName,_InitialComponent):-
not(RegistryFileName=""),
trap(pzlPort::setComponentRegisterFileName(RegistryFileName),_Err,fail()),
fail.
runProfile(TaskWindow,RegistryFileName,InitialComponent):-
RegistryFileStatus=pzl::getComponentRegisterFileName(),
notifyUser(TaskWindow,RegistryFileStatus,RegistryFileName),
runStudioStarter(TaskWindow,InitialComponent).
</vip>
}}

==pzlPort::isInitialized/0==
{{predicate
|decl=
<vip>isInitialized:() determ.</vip>
|short=
Checking of the initialization status of the VpPuZzle system
|full=
Makes it possible to check whether the initialization of the pzl-system was performed. If the result of the check is positive, then predicate succeeds.
|example=
<vip>
clauses
run():-
not(isInitialazed()),
pzlPort::init(),
fail.
run():-
TaskWindow = taskWindow::new(),
...
</vip>
}}
=References=
[[Category:VpPuZzle]]