Apama API Reference for .NET  10.7.2.0
Apama.Event.Parser.Field< T > Class Template Reference

Represents the name and type of a field in an EventType. More...

Inherits Field.

Public Member Functions

 Field (string name, FieldType< T > type)
 Creates a new field. More...
 
 Field (string name, FieldType type)
 Creates a new field. More...
 
override string ToString ()
 Returns a string representation of the event type. Note that this More...
 

Properties

virtual string Name [get]
 Method to return the name of the field object More...
 
virtual FieldType Type [get]
 Method to return the FieldType of the field object More...
 
new FieldType< T > Type [get]
 Get the generic FieldType of this field object. More...
 

Detailed Description

Represents the name and type of a field in an EventType.

Non-generic class holding the name and type of a field in an EventType (with reduced compile-time type safety compared to generic Field<T> class).

Note that the easiest way to create instances of this generic Field object is to use FieldTypes to get a FieldType object then call the FieldType<T>.NewField(string) helper method to create the Field.

Almost all new applications are recommended to use this class, instead of the legacy non-generic Field class.

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

Field<Int64> myField = FieldTypes.Sequence(FieldTypes.Integer).NewField("myField");
Template Parameters
TThe .NET type used to represent values of this field.

For most applications, it is better to use the generic Field<T> class instead of this one, unless there is a specific requirement to process fields from Event objects without access to the corresponding generic FieldType<T> object.

Constructor & Destructor Documentation

◆ Field() [1/2]

Apama.Event.Parser.Field< T >.Field ( string  name,
FieldType< T >  type 
)

Creates a new field.

Consider using FieldType<T>.NewField(string) instead of calling this method.

Parameters
nameThe field name
typethe field type

◆ Field() [2/2]

Apama.Event.Parser.Field< T >.Field ( string  name,
FieldType  type 
)

Creates a new field.

Parameters
nameThe field name
typethe field type

Member Function Documentation

◆ ToString()

override string Apama.Event.Parser.Field< T >.ToString ( )

Returns a string representation of the event type. Note that this

representation will use the .NET ToString() method to format the results, and is not valid monitorscript.

Property Documentation

◆ Name

virtual string Apama.Event.Parser.Field< T >.Name
get

Method to return the name of the field object

Returns
Name of the Field

◆ Type [1/2]

virtual FieldType Apama.Event.Parser.Field< T >.Type
get

Method to return the FieldType of the field object

Returns
Type of the field

◆ Type [2/2]

new FieldType<T> Apama.Event.Parser.Field< T >.Type
get

Get the generic FieldType of this field object.

Returns
Type of the field
Submit a bug or feature
Copyright (c) 2013-2021 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.