C# Class GSF.PQDIF.Physical.ScalarElement

Represents an Element which is a single value in a PQDIF file. Scalar elements are part of the physical structure of a PQDIF file. They exist within the body of a Record (contained by a CollectionElement).

Inheritance: GSF.PQDIF.Physical.Element

显示文件 Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Methods

Method	Description
Get ( ) : object	Gets the value of the scalar as the physical type defined by Element.TypeOfValue and returns it as a generic object.
GetBool4 ( ) : bool	Gets the value of this scalar as a 4-byte boolean.
GetComplex16 ( ) : ComplexNumber	Gets the value of this scalar as a 16-byte complex number.
GetComplex8 ( ) : ComplexNumber	Gets the value of this scalar as an 8-byte complex number.
GetGuid ( ) : System.Guid	Gets the value of this scalar as a globally unique identifier.
GetInt1 ( ) : short	Gets the value of this scalar as an 8-bit signed integer.
GetInt2 ( ) : short	Gets the value of this scalar as a 16-bit signed integer.
GetInt4 ( ) : int	Gets the value of this scalar as a 32-bit signed integer.
GetReal4 ( ) : float	Gets the value of this scalar as a 32-bit floating point number.
GetReal8 ( ) : double	Gets the value of this scalar as a 64-bit floating point number.
GetTimestamp ( ) : System.DateTime	Gets the value of this scalar as DateTime.
GetUInt1 ( ) : ushort	Gets the value of this scalar as an 8-bit unsigned integer.
GetUInt2 ( ) : ushort	Gets the value of this scalar as a 16-bit unsigned integer.
GetUInt4 ( ) : uint	Gets the value of this scalar as a 32-bit unsigned integer.
GetValue ( ) : byte[]	Gets the raw bytes of the value that this scalar represents.
ScalarElement ( ) : System	Creates a new instance of the ScalarElement class.
Set ( object value ) : void	Sets the value at the given index as the physical type defined by Element.TypeOfValue.
SetBool4 ( bool value ) : void	Sets the value of this scalar as a 4-byte boolean.
SetComplex16 ( ComplexNumber value ) : void	Sets the value of this scalar as a 16-byte complex number.
SetComplex8 ( ComplexNumber value ) : void	Sets the value of this scalar as an 8-byte complex number.
SetGuid ( System.Guid value ) : void	Sets the value of this scalar as a globally unique identifier.
SetInt1 ( sbyte value ) : void	Sets the value of this scalar as an 8-bit signed integer.
SetInt2 ( short value ) : void	Sets the value of this scalar as a 16-bit signed integer.
SetInt4 ( int value ) : void	Sets the value of this scalar as a 32-bit signed integer.
SetReal4 ( float value ) : void	Sets the value of this scalar as a 32-bit floating point number.
SetReal8 ( double value ) : void	Sets the value of this scalar as a 64-bit floating point number.
SetTimestamp ( System.DateTime value ) : void	Sets the value of this scalar as a DateTime.
SetUInt1 ( byte value ) : void	Sets the value of this scalar as an 8-bit unsigned integer.
SetUInt2 ( ushort value ) : void	Sets the value of this scalar as a 16-bit unsigned integer.
SetUInt4 ( uint value ) : void	Sets the value of this scalar as a 32-bit unsigned integer.
SetValue ( byte value, int offset ) : void	Sets the raw bytes of the value that this scalar represents.
ToString ( ) : string	Returns a string representation of the scalar.

Method Details

Get() public method

Gets the value of the scalar as the physical type defined by Element.TypeOfValue and returns it as a generic object.

public Get ( ) : object
return	object

GetBool4() public method

Gets the value of this scalar as a 4-byte boolean.

public GetBool4 ( ) : bool
return	bool

GetComplex16() public method

Gets the value of this scalar as a 16-byte complex number.

public GetComplex16 ( ) : ComplexNumber
return	ComplexNumber

GetComplex8() public method

Gets the value of this scalar as an 8-byte complex number.

public GetComplex8 ( ) : ComplexNumber
return	ComplexNumber

GetGuid() public method

Gets the value of this scalar as a globally unique identifier.

public GetGuid ( ) : System.Guid
return	System.Guid

GetInt1() public method

Gets the value of this scalar as an 8-bit signed integer.

public GetInt1 ( ) : short
return	short

GetInt2() public method

Gets the value of this scalar as a 16-bit signed integer.

public GetInt2 ( ) : short
return	short

GetInt4() public method

Gets the value of this scalar as a 32-bit signed integer.

public GetInt4 ( ) : int
return	int

GetReal4() public method

Gets the value of this scalar as a 32-bit floating point number.

public GetReal4 ( ) : float
return	float

GetReal8() public method

Gets the value of this scalar as a 64-bit floating point number.

public GetReal8 ( ) : double
return	double

GetTimestamp() public method

Gets the value of this scalar as DateTime.

public GetTimestamp ( ) : System.DateTime
return	System.DateTime

GetUInt1() public method

Gets the value of this scalar as an 8-bit unsigned integer.

public GetUInt1 ( ) : ushort
return	ushort

GetUInt2() public method

Gets the value of this scalar as a 16-bit unsigned integer.

public GetUInt2 ( ) : ushort
return	ushort

GetUInt4() public method

Gets the value of this scalar as a 32-bit unsigned integer.

public GetUInt4 ( ) : uint
return	uint

GetValue() public method

Gets the raw bytes of the value that this scalar represents.

public GetValue ( ) : byte[]
return	byte[]

ScalarElement() public method

Creates a new instance of the ScalarElement class.

public ScalarElement ( ) : System
return	System

Set() public method

Sets the value at the given index as the physical type defined by Element.TypeOfValue.

public Set ( object value ) : void
value	object	The new value to be stored.
return	void

SetBool4() public method

Sets the value of this scalar as a 4-byte boolean.

public SetBool4 ( bool value ) : void
value	bool	The new value as a 4-byte boolean.
return	void

SetComplex16() public method

Sets the value of this scalar as a 16-byte complex number.

public SetComplex16 ( ComplexNumber value ) : void
value	ComplexNumber	The new value as a 16-byte complex number.
return	void

SetComplex8() public method

Sets the value of this scalar as an 8-byte complex number.

public SetComplex8 ( ComplexNumber value ) : void
value	ComplexNumber	The new value as an 8-byte complex number.
return	void

SetGuid() public method

Sets the value of this scalar as a globally unique identifier.

public SetGuid ( System.Guid value ) : void
value	System.Guid	The new value as a globally unique identifier.
return	void

SetInt1() public method

Sets the value of this scalar as an 8-bit signed integer.

public SetInt1 ( sbyte value ) : void
value	sbyte	The new value as an 8-bit signed integer.
return	void

SetInt2() public method

Sets the value of this scalar as a 16-bit signed integer.

public SetInt2 ( short value ) : void
value	short	The new value as a 16-bit signed integer.
return	void

SetInt4() public method

Sets the value of this scalar as a 32-bit signed integer.

public SetInt4 ( int value ) : void
value	int	The new value as a 32-bit signed integer.
return	void

SetReal4() public method

Sets the value of this scalar as a 32-bit floating point number.

public SetReal4 ( float value ) : void
value	float	The new value as a 32-bit floating point number.
return	void

SetReal8() public method

Sets the value of this scalar as a 64-bit floating point number.

public SetReal8 ( double value ) : void
value	double	The new value as a 64-bit floating point number.
return	void

SetTimestamp() public method

Sets the value of this scalar as a DateTime.

public SetTimestamp ( System.DateTime value ) : void
value	System.DateTime	The new value of this scalar as a .
return	void

SetUInt1() public method

Sets the value of this scalar as an 8-bit unsigned integer.

public SetUInt1 ( byte value ) : void
value	byte	The new value as an 8-bit unsigned integer.
return	void

SetUInt2() public method

Sets the value of this scalar as a 16-bit unsigned integer.

public SetUInt2 ( ushort value ) : void
value	ushort	The new value as a 16-bit unsigned integer.
return	void

SetUInt4() public method

Sets the value of this scalar as a 32-bit unsigned integer.

public SetUInt4 ( uint value ) : void
value	uint	The new value as a 32-bit unsigned integer.
return	void

SetValue() public method

Sets the raw bytes of the value that this scalar represents.

public SetValue ( byte value, int offset ) : void
value	byte	The array containing the bytes.
offset	int	The offset into the array at which the value starts.
return	void

ToString() public method

Returns a string representation of the scalar.

public ToString ( ) : string
return	string