📄 swarm.objectbase.messageprobe.protocol.html
字号:
<HTML><HEAD><TITLE>MessageProbe</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="Objectbase Library"HREF="swarm.objectbase.sgml.reference.html"><LINKREL="PREVIOUS"TITLE="EmptyProbeMap"HREF="swarm.objectbase.emptyprobemap.protocol.html"><LINKREL="NEXT"TITLE="Probe"HREF="swarm.objectbase.probe.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.objectbase.emptyprobemap.protocol.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom">Reference IV. Objectbase Library</TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="swarm.objectbase.probe.protocol.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.PROTOCOL">MessageProbe</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN11778"></A><H2>Name</H2>MessageProbe -- A class that allows the user to call a given message on any candidate that is an instance of, or inherits from, a given class.</DIV><DIVCLASS="REFSECT1"><ANAME="AEN11781"></A><H2>Description</H2><P> This is a specialized subclass of the abstract class Probe. It completes the specification of a probe that refers to a message element of an object. </P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN11784"></A><H2>Protocols adopted by MessageProbe</H2><P> <AHREF="swarm.objectbase.probe.protocol.html">Probe</A> <AHREF="swarm.defobj.creatable.protocol.html">CREATABLE</A></P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN11789"></A><H2>Methods</H2><DIVCLASS="REFSECT2"><ANAME="AEN11791"></A><H3>Phase: Creating</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PC.M834"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setProbedSelector:</B> (SEL)<VARCLASS="PDPARAM">aSel</VAR> <BR> The setProbedSelector: method sets the message to be probed given the selector. <P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PC.M38"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">create:</B> (id <Zone>)<VARCLASS="PDPARAM">aZone</VAR> <BCLASS="FUNCPROTOTYPE">setProbedSelector:</B> (SEL)<VARCLASS="PDPARAM">aSel</VAR> <BR> Convenience factory method for common case.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN11814"></A><H3>Phase: Setting</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PS.M769"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setHideResult:</B> (BOOL)<VARCLASS="PDPARAM">val</VAR> <BR> The setHideResult: method is used to set the visibility of the result field. When set to 1, the user is indicating that the result field in a graphical representation of the message probe should not be shown.<P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN11826"></A><H3>Phase: Using</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M554"></A><P></P>- (BOOL)<BCLASS="FUNCPROTOTYPE">isResultId</B><BR> The isResultId method returns 1 if the return value of the message is of type object, and returns 0 otherwise.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M552"></A><P></P>- (BOOL)<BCLASS="FUNCPROTOTYPE">isArgumentId:</B> (int)<VARCLASS="PDPARAM">which</VAR> <BR> The isArgumentId: method returns 1 if a given argument of the message is of type object, and returns 0 otherwise.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M464"></A><P></P>- (const char *)<BCLASS="FUNCPROTOTYPE">getProbedMessage</B><BR> The getProbedMessage method returns the string matching the identifier of the message being probed.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M310"></A><P></P>- (int)<BCLASS="FUNCPROTOTYPE">getArgCount</B><BR><P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M309"></A><P></P>- (val_t)<BCLASS="FUNCPROTOTYPE">getArg:</B> (int)<VARCLASS="PDPARAM">which</VAR> <BR> The getArg: method returns the argument type for a given index.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M311"></A><P></P>- (const char *)<BCLASS="FUNCPROTOTYPE">getArgName:</B> (int)<VARCLASS="PDPARAM">which</VAR> <BR> The getArgName: method returns a string representation of the argument key with the given index.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M392"></A><P></P>- (BOOL)<BCLASS="FUNCPROTOTYPE">getHideResult</B><BR> The getHideResult method returns 1 if the result field is "hidden".<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M672"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setArg:</B> (int)<VARCLASS="PDPARAM">which</VAR> <BCLASS="FUNCPROTOTYPE">ToString:</B> (const char *)<VARCLASS="PDPARAM">what</VAR> <BR> The setArg:ToString: method sets the nth argument of the message. The argument must be provided in string form.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M270"></A><P></P>- (val_t)<BCLASS="FUNCPROTOTYPE">dynamicCallOn:</B> <VARCLASS="PDPARAM">target</VAR> <BR> The dynamicCallOn: method generates a dynamic message call on the target object. <P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M255"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">doubleDynamicCallOn:</B> <VARCLASS="PDPARAM">target</VAR> <BR> The doubleDynamicCallOn: method generates a dynamic message call on the target object. This method assumes the user knows the type to be numeric and would like a direct translation into type double.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M576"></A><P></P>- (long)<BCLASS="FUNCPROTOTYPE">longDynamicCallOn:</B> <VARCLASS="PDPARAM">target</VAR> <BR> The longDynamicCallOn: method generates a dynamic message call on the target object. This method assumes the user knows the return type to be numeric and would like a direct translation into type logn.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M927"></A><P></P>- (const char *)<BCLASS="FUNCPROTOTYPE">stringDynamicCallOn:</B> <VARCLASS="PDPARAM">target</VAR> <BR> The stringDynamicCallOn: method generates a dynamic message call on the target object. This method assumes the user knows the return type to be const char *.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.OBJECTBASE.MESSAGEPROBE.METHOD.PU.M588"></A><P></P>- <BCLASS="FUNCPROTOTYPE">objectDynamicCallOn:</B> <VARCLASS="PDPARAM">target</VAR> <BR> The objectDynamicCallOn: method generates a dynamic message call on the target object. This method assumes the user knows the return type to be id.<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.objectbase.emptyprobemap.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.objectbase.probe.protocol.html">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">EmptyProbeMap</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="swarm.objectbase.sgml.reference.html">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">Probe</TD></TR></TABLE></DIV></BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -