Centrafuse Logo Flux Logo


Tag Class Reference

Represent one tag attribute that can be present in a header of a file. There are defined explicit convertion operator for every possible data type represented with this structure. More...

List of all members.

Public Member Functions

 Tag (ushort index, string name, WMT_ATTR_DATATYPE type, object val)
 Initialize the Tag structure with proper values.
override string ToString ()
 ToString is overrided to provide the string representation in "name=value" format.

Static Public Member Functions

static operator string (Tag tag)
 Convertion Operators.
static operator bool (Tag tag)
 Convertion Operators.
static operator Guid (Tag tag)
 Convertion Operators.
static operator byte[] (Tag tag)
 Convertion Operators.
static operator ulong (Tag tag)
 Convertion Operators.
static operator long (Tag tag)
 Convertion Operators.
static operator int (Tag tag)
 Convertion Operators.
static operator uint (Tag tag)
 Convertion Operators.
static operator ushort (Tag tag)
 Convertion Operators.

Properties

ushort Index [get]
 Index of the attribute.
string Name [get]
 Name of the attribute.
WMT_ATTR_DATATYPE DataType [get]
 Data type of the attribute.
object Value [get, set]
 Read/Write object representing the value of the attribute. When writing this property the object must match to the DataType.
string ValueAsString [get]
 Gets a string representing the value of the attribute.


Detailed Description

Represent one tag attribute that can be present in a header of a file. There are defined explicit convertion operator for every possible data type represented with this structure.


Constructor & Destructor Documentation

Tag.Tag ( ushort  index,
string  name,
WMT_ATTR_DATATYPE  type,
object  val 
)

Initialize the Tag structure with proper values.

Parameters:
index the index of the attribute
name Name of the attribute
type WMT_ATTR_DATATYPE enum describing the type of the attribute.
val The atrtibute value. This param is an obcjet and must match the param type, ex. If type is WMT_ATTR_DATATYPE.WMT_TYPE_BOOL val param must be a valid
bool
and so on.


Member Function Documentation

override string Tag.ToString (  ) 

ToString is overrided to provide the string representation in "name=value" format.

Returns:
String represantation of this struct in "name=value" format.

static Tag.operator string ( Tag  tag  )  [explicit, static]

Convertion Operators.

static Tag.operator bool ( Tag  tag  )  [explicit, static]

Convertion Operators.

static Tag.operator Guid ( Tag  tag  )  [explicit, static]

Convertion Operators.

static Tag.operator byte[] ( Tag  tag  )  [explicit, static]

Convertion Operators.

static Tag.operator ulong ( Tag  tag  )  [explicit, static]

Convertion Operators.

static Tag.operator long ( Tag  tag  )  [explicit, static]

Convertion Operators.

static Tag.operator int ( Tag  tag  )  [explicit, static]

Convertion Operators.

static Tag.operator uint ( Tag  tag  )  [explicit, static]

Convertion Operators.

static Tag.operator ushort ( Tag  tag  )  [explicit, static]

Convertion Operators.


Property Documentation

ushort Tag.Index [get]

Index of the attribute.

string Tag.Name [get]

Name of the attribute.

WMT_ATTR_DATATYPE Tag.DataType [get]

Data type of the attribute.

object Tag.Value [get, set]

Read/Write object representing the value of the attribute. When writing this property the object must match to the DataType.

string Tag.ValueAsString [get]

Gets a string representing the value of the attribute.


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




Copyright © 2008 Flux Media, Inc. (U.S. Copyright Registration Number: TXu-1-239-794) Flux Logo