AMPS.Client.Fields.CommandField Class Reference

Field data for a Message which consists of a Command. This Command tells AMPS how to interpret the Message. More...

Inheritance diagram for AMPS.Client.Fields.CommandField:

Public Member Functions
Message.Commands	getValue ()
	This method gets the enum representation of the Command. More...
void	setValue (Message.Commands v)
	Sets the value of the Command. More...
Public Member Functions inherited from AMPS.Client.Fields.Field
	Field ()
	Default construntotor. More...
	Field (string value)
	Constructs an instance with the bytes of the specified string value. The string is interpreted as the UTF-8 representation. More...
	Field (byte[] buffer, int position, int length)
	Constructs an instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance. More...
void	set (byte[] buffer, int position, int length)
	Sets the value of this instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance. More...
void	set (byte[] buffer)
	Sets the value of this instance with the specified buffer. Note: the bytes are not copied from the buffer. The buffer is referenced by this instance. More...
bool	isNull ()
	Indicates whether this instance's value is null. More...
void	reset ()
	Resets the value of this instance to null. More...
byte	byteAt (int i)
	Returns the byte at position plus index i. More...
override bool	Equals (Object obj)
	Default implementation for Object#equals for a Field. For two Fields to be considered equal, their values must have the same length and all bytes in the value must be equal. More...
override int	GetHashCode ()
	Gets the hash code for the Field. More...
Field	copy ()
	Constructs a new Field and sets its value to a deep copy of this instance. More...
virtual void	copyFrom (Field f)
	Provides a way to make this object a duplicate of f. More...

Static Public Member Functions
static String	encodeCommand (Message.Commands command)
	This method encodes the Command. This method takes the enum Command and finds the corresponding string. More...

Static Protected Attributes
static string	LATIN1 = "ISO-8859-1"
static byte	LATIN1_ZERO = 48

Additional Inherited Members
Public Attributes inherited from AMPS.Client.Fields.Field
byte[]	buffer = null
int	position = 0
int	length = 0

Detailed Description

Field data for a Message which consists of a Command. This Command tells AMPS how to interpret the Message.

Member Function Documentation

encodeCommand()

static String AMPS.Client.Fields.CommandField.encodeCommand ( Message.Commands  command )

inlinestatic

This method encodes the Command. This method takes the enum Command and finds the corresponding string.

Parameters

command

The message command to encode.

Returns

The encoded command string.

getValue()

Message.Commands AMPS.Client.Fields.CommandField.getValue ( )

inline

This method gets the enum representation of the Command.

Returns

The Message.Commands enum value.

setValue()

void AMPS.Client.Fields.CommandField.setValue ( Message.Commands  v )

inline

Sets the value of the Command.

Parameters

v	The Command value to set.

---

The documentation for this class was generated from the following file:

• AMPS.Client/Fields/CommandField.cs