Difference between revisions of "ARDUINO MEGA Functions Miscellaneous"

From ROBOTC API Guide
Jump to: navigation, search
(memcmp)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<yambe:breadcrumb>ARDUINO_MEGA_Functions_and_Variables|Functions and Variables</yambe:breadcrumb>
+
{{DISPLAYTITLE:2560 (MEGA) Miscellaneous Functions}}
 +
<yambe:breadcrumb self="2560 (MEGA) Miscellaneous">ARDUINO_MEGA_Functions_and_Variables|Functions and Variables</yambe:breadcrumb>
 
<br />
 
<br />
  
Line 91: Line 92:
 
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
|-
| class="functionType"| <span class="bigKeywordBI">intrinsic short </span><span class="bigKeywordB">memcmp</span><span class="bigCodePunc">(</span><span class="bigKeywordBI">void </span><span class="bigCodeBasic">&pToBuffer</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const short</span><span class="bigCodeBasic">nValue</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const short </span><span class="bigCodeBasic">nNumbOfBytes</span><span class="bigCodePunc">)</span>
+
| class="functionType"| <span class="bigKeywordBI">intrinsic short </span><span class="bigKeywordB">memcmp</span><span class="bigCodePunc">(</span><span class="bigKeywordBI">void </span><span class="bigCodeBasic">&pToBuffer</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">void </span><span class="bigCodeBasic">&pFromBuffer</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const short </span><span class="bigCodeBasic">nNumbOfBytes</span><span class="bigCodePunc">)</span>
 
|-
 
|-
 
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Compares the first set bytes of the block of memory referenced by "pToBuffer" to the first number of bytes referenced by "pFromBuffer". The function will return zero if they all match or a value different from zero representing which is greater if they do not.
 
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Compares the first set bytes of the block of memory referenced by "pToBuffer" to the first number of bytes referenced by "pFromBuffer". The function will return zero if they all match or a value different from zero representing which is greater if they do not.
Line 129: Line 130:
 
<br />
 
<br />
  
== memset ==
+
== memmove ==
 
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
|-
| class="functionType"| <span class="bigKeywordBI">void </span><span class="bigKeywordB">memset</span><span class="bigCodePunc">(</span><span class="bigKeywordBI">void </span><span class="bigCodeBasic">&pToBuffer</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const short </span><span class="bigCodeBasic">nValue</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const short </span><span class="bigCodeBasic">nNumbOfBytes</span><span class="bigCodePunc">)</span>
+
| class="functionType"| <span class="bigKeywordBI">void </span><span class="bigKeywordB">memmove</span><span class="bigCodePunc">(</span><span class="bigKeywordBI">void </span><span class="bigCodeBasic">&pToBuffer</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const void </span><span class="bigCodeBasic">&pFromBuffer</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const short </span><span class="bigCodeBasic">nNumbOfBytes</span><span class="bigCodePunc">)</span>
 
|-
 
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]])  Sets a block of memory at <span class="codeBasic">pToBuffer</span> to the value <span class="codeBasic">nValue</span>. <span class="codeBasic">nNumbOfBytes</span> is the number of bytes to set. This is a useful function for initializing the value of an array to all zeros. Identical to the function found in conventional C 'string.h' library.
+
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]])  Function copies characters from <span class="codeBasic">pFromBuffer</span> to <span class="codeBasic">pToBuffer</span>. <span class="codeBasic">nBytesToCopy</span> is the number of bytes to copy. Identical to the function found in conventional C 'string.h' library.
 +
 
 +
The advantage of "memmove" is that the buffers can overlap in memory space - the "memcpy" function they cannot overlap.
 
|-
 
|-
 
|
 
|
Line 143: Line 146:
 
   |-
 
   |-
 
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|''pToBuffer''  
 
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|''pToBuffer''  
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|buffer to set
+
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|buffer to copy to
 
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|[[Data_Types#dataType_void|void]]
 
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|[[Data_Types#dataType_void|void]]
 
   |-
 
   |-
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|''nValue''  
+
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|''pFromBuffer''  
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|value to set buffer to
+
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|buffer to copy from
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|[[Data_Types#dataType_short|short]]
+
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|[[Data_Types#dataType_void|void]]
 
   |-
 
   |-
 
   | style="border-style: solid; border-width: 0px 0px 0px 0px"|''nNumbOfBytes''  
 
   | style="border-style: solid; border-width: 0px 0px 0px 0px"|''nNumbOfBytes''  
   | style="border-style: solid; border-width: 0px 0px 0px 0px"|number of bytes to set
+
   | style="border-style: solid; border-width: 0px 0px 0px 0px"|number of bytes to copy
 
   | style="border-style: solid; border-width: 0px 0px 0px 0px"|[[Data_Types#dataType_short|short]]
 
   | style="border-style: solid; border-width: 0px 0px 0px 0px"|[[Data_Types#dataType_short|short]]
 
   |-
 
   |-
Line 160: Line 163:
 
   |-
 
   |-
 
   |<syntaxhighlight lang="robotc">
 
   |<syntaxhighlight lang="robotc">
int kSendSize = 1;                                   // we will be sending 1 byte
+
task main()
ubyte BytesToSend[kSendSize];                       // create a ubyte array of size 1
+
{
short nMsgXmit = 0;                                 // we will be setting them to 0
+
  string source = "ROBOTC is cool!...."; // create string variable 'source' and set it to "ROBOTC is cool!...."
memset(BytesToSend, nMsgXmit, sizeof(BytesToSend)); // set the Byte Array to 0
+
  string destination = "";               // create string variable 'destination' and set it equal to ""
 +
  int length = 15;                       // create int variable 'length' and set it equal to 15
 +
 
 +
  memmove(destination, source, length);  // copy 'length' number of bytes (15) from 'source' to 'destination'
 +
 
 +
  while(true);                           // infinite loop to keep the debugger alive to see output
 +
  // after running:
 +
  // source      = "ROBOTC is cool!...."
 +
  // destination  = "ROBOTC is cool!"
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 
   |-
 
   |-

Latest revision as of 20:52, 11 May 2012

ARDUINOFunctions and Variables → 2560 (MEGA) Miscellaneous


Color Key
Function:
Variable:


memcpy

void memcpy(void &pToBuffer, const void &pFromBuffer, const short nNumbOfBytes)
(void) Function copies characters from pFromBuffer to pToBuffer. nBytesToCopy is the number of bytes to copy. Identical to the function found in conventional C 'string.h' library.
Parameter Explanation Data Type
pToBuffer buffer to copy to void
pFromBuffer buffer to copy from void
nNumbOfBytes number of bytes to copy short
string sTemp = "ROBOTC";               // create a string, 'sTemp' to be "ROBOTC"
char sArray[20];                       // create a char array, 'sArray' of size 20
memcpy(sArray, sTemp, sizeof(sTemp));  // copy characters from 'sTemp' to 'sArray'


memset

void memset(void &pToBuffer, const short nValue, const short nNumbOfBytes)
(void) Sets a block of memory at pToBuffer to the value nValue. nNumbOfBytes is the number of bytes to set. This is a useful function for initializing the value of an array to all zeros. Identical to the function found in conventional C 'string.h' library.
Parameter Explanation Data Type
pToBuffer buffer to set void
nValue value to set buffer to short
nNumbOfBytes number of bytes to set short
int kSendSize = 1;                                   // we will be sending 1 byte
ubyte BytesToSend[kSendSize];                        // create a ubyte array of size 1
short nMsgXmit = 0;                                  // we will be setting them to 0
memset(BytesToSend, nMsgXmit, sizeof(BytesToSend));  // set the Byte Array to 0


memcmp

intrinsic short memcmp(void &pToBuffer, void &pFromBuffer, const short nNumbOfBytes)
(void) Compares the first set bytes of the block of memory referenced by "pToBuffer" to the first number of bytes referenced by "pFromBuffer". The function will return zero if they all match or a value different from zero representing which is greater if they do not.
Parameter Explanation Data Type
pToBuffer First buffer to compare. void
pFromBuffer Second buffer to compare. void
nNumbOfBytes Number of bytes to compare short
  char temp1[5] = {'A', 'B', 'C', 'D', 'E'};  //Create an Array
  short result = 0;                           //Variable to store result
  result = memcmp(temp1[0], temp1[2], 2);     //Perform the memory compare


memmove

void memmove(void &pToBuffer, const void &pFromBuffer, const short nNumbOfBytes)
(void) Function copies characters from pFromBuffer to pToBuffer. nBytesToCopy is the number of bytes to copy. Identical to the function found in conventional C 'string.h' library.

The advantage of "memmove" is that the buffers can overlap in memory space - the "memcpy" function they cannot overlap.

Parameter Explanation Data Type
pToBuffer buffer to copy to void
pFromBuffer buffer to copy from void
nNumbOfBytes number of bytes to copy short
task main()
{
  string source = "ROBOTC is cool!....";  // create string variable 'source' and set it to "ROBOTC is cool!...."
  string destination = "";                // create string variable 'destination' and set it equal to ""
  int length = 15;                        // create int variable 'length' and set it equal to 15
 
  memmove(destination, source, length);   // copy 'length' number of bytes (15) from 'source' to 'destination'
 
  while(true);                            // infinite loop to keep the debugger alive to see output
  // after running:
  // source       = "ROBOTC is cool!...."
  // destination  = "ROBOTC is cool!"
}