📄 swarm.simtools.objectloader.protocol.html
字号:
<HTML><HEAD><TITLE>ObjectLoader [Deprecated]</TITLE><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.53"><LINKREL="HOME"TITLE="Documentation Set for Swarm 2.1.1"HREF="set.html"><LINKREL="UP"TITLE="Simtools Library"HREF="swarm.simtools.sgml.reference.html"><LINKREL="PREVIOUS"TITLE="NSelect"HREF="swarm.simtools.nselect.protocol.html"><LINKREL="NEXT"TITLE="ObjectSaver [Deprecated]"HREF="swarm.simtools.objectsaver.protocol.html"></HEAD><BODYCLASS="REFENTRY"BGCOLOR="#FFFFFF"TEXT="#000000"LINK="#0000FF"VLINK="#840084"ALINK="#0000FF"><DIVCLASS="NAVHEADER"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><THCOLSPAN="3"ALIGN="center">Documentation Set for Swarm 2.1.1</TH></TR><TR><TDWIDTH="10%"ALIGN="left"VALIGN="bottom"><AHREF="swarm.simtools.nselect.protocol.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom">Reference VI. Simtools Library</TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="swarm.simtools.objectsaver.protocol.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.PROTOCOL">ObjectLoader [Deprecated]</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN15925"></A><H2>Name</H2>ObjectLoader -- A class to load an object's instance variables from a file.</DIV><DIVCLASS="REFSECT1"><ANAME="AEN15928"></A><H2>Description</H2><P><ICLASS="EMPHASIS">Deprecated: Use the Archiver protocol in the defobj library as a replacement for this ad-hoc format</I></P><P> This class is used to initialize the variables of a target object from a data file. The data file is required to have a very simple format.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN15933"></A><H2>Protocols adopted by ObjectLoader</H2><P> <AHREF="swarm.objectbase.swarmobject.protocol.html">SwarmObject</A> <AHREF="swarm.defobj.creatable.protocol.html">CREATABLE</A></P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN15938"></A><H2>Methods</H2><DIVCLASS="REFSECT2"><ANAME="AEN15940"></A><H3>Phase: Creating</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.METHOD.PC.M60"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">load:</B> <VARCLASS="PDPARAM">anObject</VAR> <BCLASS="FUNCPROTOTYPE">from:</B> <VARCLASS="PDPARAM">aFileObject</VAR> <BR> The load:from: method loads anObject from the previously opened aFileObject without returning an actual instance of the ObjectLoader class. The FileObject remains open after the method has been called. <P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.METHOD.PC.M63"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">load:</B> <VARCLASS="PDPARAM">anObject</VAR> <BCLASS="FUNCPROTOTYPE">fromFileNamed:</B> (const char *)<VARCLASS="PDPARAM">aFileName</VAR> <BR> The load:fromFileNamed: method loads anObject from the file named aFileName. The ObjectLoader class will open the file, initialize the object with its contents and then close the file.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.METHOD.PC.M61"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">load:</B> <VARCLASS="PDPARAM">anObject</VAR> <BCLASS="FUNCPROTOTYPE">fromAppConfigFileNamed:</B> (const char *)<VARCLASS="PDPARAM">aFileName</VAR> <BR> The load:fromAppConfigFileNamed: method loads anObject from th application-specific configuration file named aFileName. The ObjectLoader class will open the file, initialize the object with its contents and then close the file.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.METHOD.PC.M62"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">load:</B> <VARCLASS="PDPARAM">anObject</VAR> <BCLASS="FUNCPROTOTYPE">fromAppDataFileNamed:</B> (const char *)<VARCLASS="PDPARAM">aFileName</VAR> <BR> The load:fromAppConfigFileNamed: method loads anObject from th application-specific data file named aFileName. The ObjectLoader class will open the file, initialize the object with its contents and then close the file.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN15987"></A><H3>Phase: Setting</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.METHOD.PS.M756"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setFileObject:</B> <VARCLASS="PDPARAM">aFileObject</VAR> <BR> The setFileObject: method sets the source fileObject which the instance of the ObjectLoader class should use by sending it this message.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.METHOD.PS.M881"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setTemplateProbeMap:</B> (id <ProbeMap>)<VARCLASS="PDPARAM">probeMap</VAR> <BR> The setTemplateProbeMap: method is used to specify which variables of the target object(s) should be loaded by the ObjectLoader instance to which this message was sent.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN16008"></A><H3>Phase: Using</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.METHOD.PU.M574"></A><P></P>- <BCLASS="FUNCPROTOTYPE">loadObject:</B> <VARCLASS="PDPARAM">anObject</VAR> <BR> The loadObject: message must be sent to an instance of the ObjectLoader class in order to initialize the target object from the requested file.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTLOADER.METHOD.PU.M937"></A><P></P>- <BCLASS="FUNCPROTOTYPE">updateCache:</B> <VARCLASS="PDPARAM">exampleTarget</VAR> <BR> The updateCache: method should be called if an ObjectLoader instance is going to initialize a large number of objects from the same class.<P></P></DIV></LI></UL></DIV></DIV><DIVCLASS="NAVFOOTER"><HRALIGN="LEFT"WIDTH="100%"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top"><AHREF="swarm.simtools.nselect.protocol.html">Prev</A></TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="set.html">Home</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top"><AHREF="swarm.simtools.objectsaver.protocol.html">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">NSelect</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="swarm.simtools.sgml.reference.html">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">ObjectSaver [Deprecated]</TD></TR></TABLE></DIV></BODY></HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -