NativeBinaryValue Class

Represents a binary data sample stored as a byte array ordered in the endianness of the OS, but implicitly castable to most common native types.

Inheritance Hierarchy

SystemObject
GSFBinaryValueBaseNativeEndianOrder
GSFNativeBinaryValue

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.257-beta+00aa2366fbb9ec75f636ebc7cfa610e3826a727c

Syntax

C++

JavaScript

Copy

public class NativeBinaryValue : BinaryValueBase<NativeEndianOrder>

Public Class NativeBinaryValue
	Inherits BinaryValueBase(Of NativeEndianOrder)

public ref class NativeBinaryValue : public BinaryValueBase<NativeEndianOrder^>

type NativeBinaryValue = 
    class
        inherit BinaryValueBase<NativeEndianOrder>
    end

GSF.NativeBinaryValue = function();

Type.createClass(
	'GSF.NativeBinaryValue',
	GSF.BinaryValueBase`1);

View Source

The NativeBinaryValue type exposes the following members.

Constructors

	Name	Description
	NativeBinaryValue(Byte)	Creates a new binary value, ordered in the endianness of the OS, from the given byte array.
	NativeBinaryValue(TypeCode, Byte)	Creates a new binary value, ordered in the endianness of the OS, from the given byte array.
	NativeBinaryValue(Byte, Int32, Int32)	Creates a new binary value, ordered in the endianness of the OS, from the given byte array.
	NativeBinaryValue(TypeCode, Byte, Int32, Int32)	Creates a new binary value, ordered in the endianness of the OS, from the given byte array.

Top

Properties

	Name	Description
	Buffer	Gets or sets the binary representation of this data sample. (Inherited from BinaryValueBaseTEndianOrder)
	TypeCode	Gets or sets TypeCode that this binary data sample represents. (Inherited from BinaryValueBaseTEndianOrder)

Top

Methods

	Name	Description
	ConvertToType	Returns a NativeBinaryValue representation of source value converted to specified TypeCode.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToByte	Returns a byte from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToDouble	Returns a double-precision floating point number, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToInt16	Returns a 16-bit signed integer, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToInt24	Returns a 24-bit signed integer, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToInt32	Returns a 32-bit signed integer, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToInt64	Returns a 64-bit signed integer, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToSingle	Returns a single-precision floating point number, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToString	Returns a String that represents the current NativeBinaryValue. (Overrides ObjectToString)
	ToUInt16	Returns a 16-bit unsigned integer, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToUInt24	Returns a 24-bit unsigned integer, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToUInt32	Returns a 32-bit unsigned integer, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)
	ToUInt64	Returns a 64-bit unsigned integer, accounting for EndianOrder, converted from the Buffer. (Inherited from BinaryValueBaseTEndianOrder)

Top

Operators

	Name	Description
	(Byte to NativeBinaryValue)	Implicitly converts Byte to NativeBinaryValue.
	(Double to NativeBinaryValue)	Implicitly converts Double to NativeBinaryValue.
	(Int16 to NativeBinaryValue)	Implicitly converts Int16 to NativeBinaryValue.
	(Int24 to NativeBinaryValue)	Implicitly converts Int24 to NativeBinaryValue.
	(Int32 to NativeBinaryValue)	Implicitly converts Int32 to NativeBinaryValue.
	(Int64 to NativeBinaryValue)	Implicitly converts Int64 to NativeBinaryValue.
	(NativeBinaryValue to Int24)	Implicitly converts NativeBinaryValue to Int24.
	(NativeBinaryValue to UInt24)	Implicitly converts NativeBinaryValue to UInt24.
	(NativeBinaryValue to Byte)	Implicitly converts NativeBinaryValue to Byte.
	(NativeBinaryValue to Double)	Implicitly converts NativeBinaryValue to Double.
	(NativeBinaryValue to Int16)	Implicitly converts NativeBinaryValue to Int16.
	(NativeBinaryValue to Int32)	Implicitly converts NativeBinaryValue to Int32.
	(NativeBinaryValue to Int64)	Implicitly converts NativeBinaryValue to Int64.
	(NativeBinaryValue to Single)	Implicitly converts NativeBinaryValue to Single.
	(NativeBinaryValue to UInt16)	Implicitly converts NativeBinaryValue to UInt16.
	(NativeBinaryValue to UInt32)	Implicitly converts NativeBinaryValue to UInt32.
	(NativeBinaryValue to UInt64)	Implicitly converts NativeBinaryValue to UInt64.
	(Single to NativeBinaryValue)	Implicitly converts Single to NativeBinaryValue.
	(UInt16 to NativeBinaryValue)	Implicitly converts UInt16 to NativeBinaryValue.
	(UInt24 to NativeBinaryValue)	Implicitly converts UInt24 to NativeBinaryValue.
	(UInt32 to NativeBinaryValue)	Implicitly converts UInt32 to NativeBinaryValue.
	(UInt64 to NativeBinaryValue)	Implicitly converts UInt64 to NativeBinaryValue.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF Namespace