A command received from CmdMessenger
More...
A command received from CmdMessenger
CommandMessenger.ReceivedCommand.ReceivedCommand |
( |
| ) |
|
|
inline |
CommandMessenger.ReceivedCommand.ReceivedCommand |
( |
string[] |
arguments | ) |
|
|
inline |
Constructor.
- Parameters
-
arguments | All command arguments, first one is command ID |
46 _arguments = arguments;
bool CommandMessenger.ReceivedCommand.Available |
( |
| ) |
|
|
inline |
returns if a next command is available
- Returns
- true if it succeeds, false if it fails.
References CommandMessenger.ReceivedCommand.Next().
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
bool CommandMessenger.ReceivedCommand.Next |
( |
| ) |
|
|
inline |
Fetches the next argument.
- Returns
- true if it succeeds, false if it fails.
Referenced by CommandMessenger.ReceivedCommand.Available(), CommandMessenger.ReceivedCommand.ReadBinBoolArg(), CommandMessenger.ReceivedCommand.ReadBinDoubleArg(), CommandMessenger.ReceivedCommand.ReadBinFloatArg(), CommandMessenger.ReceivedCommand.ReadBinInt16Arg(), CommandMessenger.ReceivedCommand.ReadBinInt32Arg(), CommandMessenger.ReceivedCommand.ReadBinStringArg(), CommandMessenger.ReceivedCommand.ReadBinUInt16Arg(), CommandMessenger.ReceivedCommand.ReadBinUInt32Arg(), CommandMessenger.ReceivedCommand.ReadDoubleArg(), CommandMessenger.ReceivedCommand.ReadFloatArg(), CommandMessenger.ReceivedCommand.ReadInt16Arg(), CommandMessenger.ReceivedCommand.ReadInt32Arg(), CommandMessenger.ReceivedCommand.ReadStringArg(), CommandMessenger.ReceivedCommand.ReadUInt16Arg(), and CommandMessenger.ReceivedCommand.ReadUInt32Arg().
86 if (_parameter < _arguments.Length - 1)
bool CommandMessenger.ReceivedCommand.ReadBinBoolArg |
( |
| ) |
|
|
inline |
Reads the current binary argument as a boolean value.
- Returns
- The boolean value.
References CommandMessenger.ReceivedCommand.Next().
346 var current = BinaryConverter.ToByte(_arguments[_parameter]);
350 return (current != 0);
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
Double CommandMessenger.ReceivedCommand.ReadBinDoubleArg |
( |
| ) |
|
|
inline |
Reads the current binary argument as a double value.
- Returns
- The double value.
References CommandMessenger.ReceivedCommand.Next().
251 var current = BinaryConverter.ToDouble(_arguments[_parameter]);
255 return (
double) current;
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
Single CommandMessenger.ReceivedCommand.ReadBinFloatArg |
( |
| ) |
|
|
inline |
Reads the current binary argument as a float value.
- Returns
- The float value.
References CommandMessenger.ReceivedCommand.Next().
235 var current = BinaryConverter.ToFloat(_arguments[_parameter]);
239 return (
float) current;
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
Int16 CommandMessenger.ReceivedCommand.ReadBinInt16Arg |
( |
| ) |
|
|
inline |
Reads the current binary argument as a short value.
- Returns
- The short value.
References CommandMessenger.ReceivedCommand.Next().
267 var current = BinaryConverter.ToInt16(_arguments[_parameter]);
271 return (Int16) current;
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
Int32 CommandMessenger.ReceivedCommand.ReadBinInt32Arg |
( |
| ) |
|
|
inline |
Reads the current binary argument as a int value.
- Returns
- The int value.
References CommandMessenger.ReceivedCommand.Next().
299 var current = BinaryConverter.ToInt32(_arguments[_parameter]);
303 return (Int32) current;
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
String CommandMessenger.ReceivedCommand.ReadBinStringArg |
( |
| ) |
|
|
inline |
Reads the current binary argument as a string value.
- Returns
- The string value.
References CommandMessenger.ReceivedCommand.Next().
331 if (_arguments[_parameter] != null)
334 return Escaping.Unescape(_arguments[_parameter]);
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
UInt16 CommandMessenger.ReceivedCommand.ReadBinUInt16Arg |
( |
| ) |
|
|
inline |
Reads the current binary argument as a unsigned short value.
- Returns
- The unsigned short value.
References CommandMessenger.ReceivedCommand.Next().
283 var current = BinaryConverter.ToUInt16(_arguments[_parameter]);
287 return (UInt16) current;
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
UInt32 CommandMessenger.ReceivedCommand.ReadBinUInt32Arg |
( |
| ) |
|
|
inline |
Reads the current binary argument as a unsigned int value.
- Returns
- The unsigned int value.
References CommandMessenger.ReceivedCommand.Next().
315 var current = BinaryConverter.ToUInt32(_arguments[_parameter]);
319 return (UInt32) current;
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
bool CommandMessenger.ReceivedCommand.ReadBoolArg |
( |
| ) |
|
|
inline |
Single CommandMessenger.ReceivedCommand.ReadDoubleArg |
( |
| ) |
|
|
inline |
Reads the current argument as a double value.
- Returns
- The unsigned double value.
References CommandMessenger.ReceivedCommand.Next().
203 if (Single.TryParse(_arguments[_parameter], out current))
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
Single CommandMessenger.ReceivedCommand.ReadFloatArg |
( |
| ) |
|
|
inline |
Reads the current argument as a float value.
- Returns
- The float value.
References CommandMessenger.ReceivedCommand.Next().
187 if (Single.TryParse(_arguments[_parameter], out current))
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
Int16 CommandMessenger.ReceivedCommand.ReadInt16Arg |
( |
| ) |
|
|
inline |
Reads the current argument as short value.
- Returns
- The short value.
References CommandMessenger.ReceivedCommand.Next().
116 if (Int16.TryParse(_arguments[_parameter], out current))
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
Int32 CommandMessenger.ReceivedCommand.ReadInt32Arg |
( |
| ) |
|
|
inline |
String CommandMessenger.ReceivedCommand.ReadStringArg |
( |
| ) |
|
|
inline |
Reads the current argument as a string value.
- Returns
- The string value.
References CommandMessenger.ReceivedCommand.Next().
218 if (_arguments[_parameter] != null)
221 return _arguments[_parameter];
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
UInt16 CommandMessenger.ReceivedCommand.ReadUInt16Arg |
( |
| ) |
|
|
inline |
Reads the current argument as unsigned short value.
- Returns
- The unsigned short value.
References CommandMessenger.ReceivedCommand.Next().
132 if (UInt16.TryParse(_arguments[_parameter], out current))
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
UInt32 CommandMessenger.ReceivedCommand.ReadUInt32Arg |
( |
| ) |
|
|
inline |
Reads the current argument as unsigned int value.
- Returns
- The unsigned int value.
References CommandMessenger.ReceivedCommand.Next().
171 if (UInt32.TryParse(_arguments[_parameter], out current))
bool Next()
Fetches the next argument.
Definition: ReceivedCommand.cs:81
int CommandMessenger.ReceivedCommand.CommandId |
|
get |
bool CommandMessenger.ReceivedCommand.Ok |
|
get |
string CommandMessenger.ReceivedCommand.this[int index] |
|
get |
Indexer to get arguments directly.
The indexed item.
long CommandMessenger.ReceivedCommand.TimeStamp |
|
getset |
Gets or sets the time stamp.
The time stamp.
The documentation for this class was generated from the following file:
- D:/My Documents/Github/Arduino-Code-and-Libraries/Libraries/CmdMessenger/CSharp/CommandMessenger/ReceivedCommand.cs