Apama.Event.Parser.FieldType< T > Class Template Reference

Represents an Apama type. Used to define the type of fields in an EventType, and also for type parameters in complex types such as FieldTypes.Sequence<T>(FieldType<T>). Get field type objects using FieldTypes. More...

Inherits Apama.Event.Parser.FieldType.

Inherited by Apama.Event.Parser.BooleanFieldType, Apama.Event.Parser.ChannelFieldType, Apama.Event.Parser.ContextFieldType, Apama.Event.Parser.DecimalFieldType, Apama.Event.Parser.DictionaryFieldType< TKey, TValue >, Apama.Event.Parser.EventType, Apama.Event.Parser.FloatFieldType, Apama.Event.Parser.IntegerFieldType, Apama.Event.Parser.LocationFieldType, Apama.Event.Parser.SequenceFieldType< E >, and Apama.Event.Parser.StringFieldType.

Public Member Functions
abstract T	DefaultValue ()
	Returns default value of this field type. It is used when returning value of a field not explicitly set. More...
Field< T >	NewField (string name)
	Creates a new Field object with the specified name, using this field type. More...
abstract T	Parse (String value)
	Parse a token according to syntax rules of this type. More...
Public Member Functions inherited from Apama.Event.Parser.FieldType
virtual string	Format (Object value)
	Format the given value in MonitorScript representation. More...
abstract object	GetDefaultValue ()
	Get the default value for this field type. More...
abstract object	ParseObject (String value)
	Parse a value from this type's Apama event string representation into the .NET object representation of the value. More...
override string	ToString ()
	For Internal use only More...

Additional Inherited Members
Protected Member Functions inherited from Apama.Event.Parser.FieldType
	FieldType (string typeName, Type clazz)
	Create a new FieldType. More...
Properties inherited from Apama.Event.Parser.FieldType
string	Name [get]
	Return the name of this type. More...
Type	TypeClass [get]
	Return the .NET type used to express values of this Apama field type. More...

Detailed Description

Represents an Apama type. Used to define the type of fields in an EventType, and also for type parameters in complex types such as FieldTypes.Sequence<T>(FieldType<T>). Get field type objects using FieldTypes.

Almost all new applications should use this class instead of the legacy non-generic FieldType class.

To get FieldType objects, use FieldTypes.

The following example shows how it is possible to create a field object whose type is an Apama sequence of integers:

var myField = FieldTypes.Sequence(FieldTypes.Integer).NewField("myField");

Template Parameters

T	The .NET type used to represent values of this field type.

Member Function Documentation

abstract T Apama.Event.Parser.FieldType< T >.DefaultValue ( )

pure virtual

Returns default value of this field type. It is used when returning value of a field not explicitly set.

Returns

Implemented in Apama.Event.Parser.EventType, Apama.Event.Parser.DictionaryFieldType< TKey, TValue >, Apama.Event.Parser.SequenceFieldType< E >, Apama.Event.Parser.ContextFieldType, Apama.Event.Parser.ChannelFieldType, Apama.Event.Parser.StringFieldType, Apama.Event.Parser.LocationFieldType, Apama.Event.Parser.DecimalFieldType, Apama.Event.Parser.IntegerFieldType, Apama.Event.Parser.FloatFieldType, and Apama.Event.Parser.BooleanFieldType.

Field<T> Apama.Event.Parser.FieldType< T >.NewField

(

string

name

)

Creates a new Field object with the specified name, using this field type.

This is exactly the same as calling the Field constructor, but involves less typing because the generic type parameter can be inferred automatically

Parameters

name

Returns

abstract T Apama.Event.Parser.FieldType< T >.Parse ( String  value )

pure virtual

Parse a token according to syntax rules of this type.

Parameters

value

The value to parse

Returns

An object of the correct type