Defines the type of an instance of ITopicData. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Content.TopicDataType:

Public Types
enum	TopicDataTypeEnum { TopicDataTypeEnum.NONE, TopicDataTypeEnum.SINGLE_VALUE, TopicDataTypeEnum.RECORD, TopicDataTypeEnum.PROTOCOL_BUFFER, TopicDataTypeEnum.CUSTOM, TopicDataTypeEnum.SLAVE, TopicDataTypeEnum.SERVICE, TopicDataTypeEnum.PAGED_STRING, TopicDataTypeEnum.PAGED_RECORD, TopicDataTypeEnum.TOPIC_NOTIFY, TopicDataTypeEnum.ROUTING, TopicDataTypeEnum.CHILD_LIST, TopicDataTypeEnum.REMOTE_CONTROL, TopicDataTypeEnum.REMOTE_SERVICE, TopicDataTypeEnum.REMOTE_CONTROL_RELAY, TopicDataTypeEnum.REMOTE_SERVICE_RELAY }
	Describes the type of an instance of TopicData. More...

Static Public Member Functions
static TopicDataType	GetByTypeCode (string typeCode)
	Map type code string to MetadataTopicDataType object. More...

Static Public Attributes
static readonly TopicDataType	NONE = new TopicDataType(TopicDataTypeEnum.NONE, "N", "None")
	No topic data. More...

static readonly TopicDataType	SINGLE_VALUE
	Single value format. More...

static readonly TopicDataType	RECORD = new TopicDataType(TopicDataTypeEnum.RECORD, "R", "Record")
	Diffusion Record format. More...

static readonly TopicDataType	PROTOCOL_BUFFER
	Protocol Buffers (Google). More...

static readonly TopicDataType	CUSTOM = new TopicDataType(TopicDataTypeEnum.CUSTOM, "U", "Custom")
	Custom format. More...

static readonly TopicDataType	SLAVE = new TopicDataType(TopicDataTypeEnum.SLAVE, "SD", "Slave")
	Slave topic data format. More...

static readonly TopicDataType	SERVICE = new TopicDataType(TopicDataTypeEnum.SERVICE, "SV", "Service")
	Service topic data format. More...

static readonly TopicDataType	PAGED_STRING
	Paged string value topic data format. More...

static readonly TopicDataType	PAGED_RECORD
	Paged record topic data format. More...

static readonly TopicDataType	TOPIC_NOTIFY
	Topic notify topic data format. More...

static readonly TopicDataType	ROUTING = new TopicDataType(TopicDataTypeEnum.ROUTING, "RO", "Routing")
	Routing topic data format. More...

static readonly TopicDataType	CHILD_LIST = new TopicDataType(TopicDataTypeEnum.CHILD_LIST, "C", "Child")
	Child topics list format. More...

Properties
string	TypeCode `[get, set]`
	Get/set a one or two-character code representing the type. More...

string	Description `[get, set]`
	Get/set a description of this topic data-type enumeration. More...

Detailed Description

Defines the type of an instance of ITopicData.

Member Enumeration Documentation

enum PushTechnology.ClientInterface.Client.Content.TopicDataType.TopicDataTypeEnum

Describes the type of an instance of TopicData.

Enumerator
NONE	No topic data. This special type is used to represent a topic that has no topic data.
SINGLE_VALUE	Single value format. Publishing topic data of type SingleValueTopicData.
RECORD	Diffusion Record format. Publishing topic data of type RecordTopicData.
PROTOCOL_BUFFER	Protocol Buffers (Google). Publishing topic data of type PBTopicData.
CUSTOM	Custom format. Publishing topic data of type CustomTopicData.
SLAVE	Slave topic data format. Publishing topic data of type SlaveTopicData.
SERVICE	Service topic data format. Functional command topic data of type ServiceTopicData.
PAGED_STRING	Paged string value topic data format. Functional command topic data of type PagedStringTopicData.
PAGED_RECORD	Paged record topic data format. Functional command topic data of type PagedRecordTopicData.
TOPIC_NOTIFY	Topic notify topic data format. Functional command topic data of type TopicNotifyTopicData.
ROUTING	Routing topic data format. Functional topic data of type RoutingTopicData.
CHILD_LIST	Child topics list format. Functional topic data of type ChildListTopicData.
REMOTE_CONTROL	Remote Control topic data format. Functional topic data of type RemoteControlTopicDataEdge.
REMOTE_SERVICE	Remote Service topic data format. Functional topic data of type RemoteServiceTopicData in an 'edge' role.
REMOTE_CONTROL_RELAY	Remote Control topic data in the relay tier format. Functional topic data of type RemoteControlTopicDataRelay.
REMOTE_SERVICE_RELAY	Remote Service topic data in the relay tier format. Functional topic data of type RemoteServiceTopicData in a 'relay' role.

Member Function Documentation

static TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.GetByTypeCode ( string typeCode )

static

Map type code string to MetadataTopicDataType object.

Parameters

typeCode The code.

Returns: The matching MetadataTopicDataType object or null if not found.

Member Data Documentation

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.CHILD_LIST = new TopicDataType(TopicDataTypeEnum.CHILD_LIST, "C", "Child")

static

Child topics list format.

Functional topic data of type ChildListTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.CUSTOM = new TopicDataType(TopicDataTypeEnum.CUSTOM, "U", "Custom")

static

Custom format.

Publishing topic data of type CustomTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.NONE = new TopicDataType(TopicDataTypeEnum.NONE, "N", "None")

static

No topic data.

This special type is used to represent a topic that has no topic data.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.PAGED_RECORD

static

Initial value:

= new TopicDataType(TopicDataTypeEnum.PAGED_RECORD, "PR",

"Paged record")

Paged record topic data format.

Functional command topic data of type PagedRecordTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.PAGED_STRING

static

Initial value:

= new TopicDataType(TopicDataTypeEnum.PAGED_STRING, "PS",

"Paged string")

Paged string value topic data format.

Functional command topic data of type PagedStringTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.PROTOCOL_BUFFER

static

Initial value:

= new TopicDataType(TopicDataTypeEnum.PROTOCOL_BUFFER, "G",

"Google protocol buffer")

Protocol Buffers (Google).

Publishing topic data of type PBTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.RECORD = new TopicDataType(TopicDataTypeEnum.RECORD, "R", "Record")

static

Diffusion Record format.

Publishing topic data of type RecordTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.ROUTING = new TopicDataType(TopicDataTypeEnum.ROUTING, "RO", "Routing")

static

Routing topic data format.

Functional topic data of type RoutingTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.SERVICE = new TopicDataType(TopicDataTypeEnum.SERVICE, "SV", "Service")

static

Service topic data format.

Functional command topic data of type ServiceTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.SINGLE_VALUE

static

Initial value:

= new TopicDataType(TopicDataTypeEnum.SINGLE_VALUE, "S",

"Single")

Single value format.

Publishing topic data of type SingleValueTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.SLAVE = new TopicDataType(TopicDataTypeEnum.SLAVE, "SD", "Slave")

static

Slave topic data format.

Publishing topic data of type SlaveTopicData.

readonly TopicDataType PushTechnology.ClientInterface.Client.Content.TopicDataType.TOPIC_NOTIFY

static

Initial value:

= new TopicDataType(TopicDataTypeEnum.TOPIC_NOTIFY, "TN",

"Topic Notify")

Topic notify topic data format.

Functional command topic data of type TopicNotifyTopicData.

Property Documentation

string PushTechnology.ClientInterface.Client.Content.TopicDataType.Description

getset

Get/set a description of this topic data-type enumeration.

string PushTechnology.ClientInterface.Client.Content.TopicDataType.TypeCode

getset

Get/set a one or two-character code representing the type.

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

UCIStack/Client/Content/TopicDataType.cs

Public Types

Static Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

Property Documentation