📄 swarm.simtools.objectsaver.protocol.html
字号:
<HTML><HEAD><TITLE>ObjectSaver [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="ObjectLoader [Deprecated]"HREF="swarm.simtools.objectloader.protocol.html"><LINKREL="NEXT"TITLE="OutFile [Deprecated]"HREF="swarm.simtools.outfile.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.objectloader.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.outfile.protocol.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.SIMTOOLS.OBJECTSAVER.PROTOCOL">ObjectSaver [Deprecated]</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN16033"></A><H2>Name</H2>ObjectSaver -- A class to save an object's instance variables to a file.</DIV><DIVCLASS="REFSECT1"><ANAME="AEN16036"></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 write an object's variables to a specified file. If only a subset of the variables should be written out, the set is specified by a template ProbeMap (where the ProbeMap will contain Probes for those variables which should be saved). </P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN16041"></A><H2>Protocols adopted by ObjectSaver</H2><P> <AHREF="swarm.objectbase.swarmobject.protocol.html">SwarmObject</A> <AHREF="swarm.defobj.creatable.protocol.html">CREATABLE</A></P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN16046"></A><H2>Methods</H2><DIVCLASS="REFSECT2"><ANAME="AEN16048"></A><H3>Phase: Creating</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTSAVER.METHOD.PC.M65"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">save:</B> <VARCLASS="PDPARAM">anObject</VAR> <BCLASS="FUNCPROTOTYPE">to:</B> <VARCLASS="PDPARAM">aFileObject</VAR> <BR> The save:to: method saves the entire target object without actually returning an instance of ObjectSaver to the user.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTSAVER.METHOD.PC.M66"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">save:</B> <VARCLASS="PDPARAM">anObject</VAR> <BCLASS="FUNCPROTOTYPE">to:</B> <VARCLASS="PDPARAM">aFileObject</VAR> <BCLASS="FUNCPROTOTYPE">withTemplate:</B> (id <ProbeMap>)<VARCLASS="PDPARAM">aProbeMap</VAR> <BR> The save:to:withTemplate: method saves the subset of target object variables specified in a template from anObject without actually returning an instance of ObjectSaver to the user.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTSAVER.METHOD.PC.M67"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">save:</B> <VARCLASS="PDPARAM">anObject</VAR> <BCLASS="FUNCPROTOTYPE">toFileNamed:</B> (const char *)<VARCLASS="PDPARAM">aFileName</VAR> <BR> The save:toFileNamed: method saves the entire target object to the file aFileName.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTSAVER.METHOD.PC.M68"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">save:</B> <VARCLASS="PDPARAM">anObject</VAR> <BCLASS="FUNCPROTOTYPE">toFileNamed:</B> (const char *)<VARCLASS="PDPARAM">aFileName</VAR> <BCLASS="FUNCPROTOTYPE">withTemplate:</B> (id <ProbeMap>)<VARCLASS="PDPARAM">aProbeMap</VAR> <BR> The save:toFileNamed:withTemplate: method saves the subset of variables specified in a template from the target object to the file aFileName.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN16099"></A><H3>Phase: Setting</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTSAVER.METHOD.PS.M756"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setFileObject:</B> <VARCLASS="PDPARAM">aFileObject</VAR> <BR> The setFileObject: method sets the target fileObject which the instance of the ObjectSaver class should use.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTSAVER.METHOD.PS.M881"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setTemplateProbeMap:</B> (id <ProbeMap>)<VARCLASS="PDPARAM">aProbeMap</VAR> <BR> The setTemplateProbeMap: method is used to specify which variables of the source object(s) should be saved by the ObjectSaver instance to which this message was sent.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN16120"></A><H3>Phase: Using</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.SIMTOOLS.OBJECTSAVER.METHOD.PU.M654"></A><P></P>- <BCLASS="FUNCPROTOTYPE">saveObject:</B> <VARCLASS="PDPARAM">anObject</VAR> <BR> The saveObject: message tells an instance of the ObjectSaver class to save the state of the target object into the requested file.<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.objectloader.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.outfile.protocol.html">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">ObjectLoader [Deprecated]</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="swarm.simtools.sgml.reference.html">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">OutFile [Deprecated]</TD></TR></TABLE></DIV></BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -