MercuryMessaging.Task.MmTaskInfo Class Reference

MmTaskInfo contains basic information for tasks in the Mercury environment. More...

Inheritance diagram for MercuryMessaging.Task.MmTaskInfo:

Public Member Functions
	MmTaskInfo ()
	Default constructor, all members set to default values. More...
	MmTaskInfo (int recId, int userId, int seq, int taskId, bool doNotRecordData, string taskName)
	Create an MmTaskInfo by passing all parameters More...
	MmTaskInfo (IMmTaskInfo orig)
	Construct MmTaskInfo by duplicating another task. More...
virtual void	Parse (string str)
	Generate member values by parsing string. More...
virtual string	Headers ()
	Headers to use when writing task to file or stream. More...
override string	ToString ()
	To String generates string of task with following order: RecordID, UserID, SeqID, TaskID, DoNotRecord, TaskName More...
virtual IMmSerializable	Copy ()
	Duplicate the task info. More...
virtual void	Deserialize (NetworkReader reader)
	Deserialize the task info from serialized form. More...
virtual void	Serialize (NetworkWriter writer)
	Serialize the task info into serialized form. More...

Properties
int	RecordId [get, set]
	Record ID More...
int	UserId [get, set]
	User ID More...
int	UserSequence [get, set]
	Sequence ID, given a particular user More...
int	TaskId [get, set]
	TaskID, useful for blocking tasks. More...
string	TaskName [get, set]
	Name of task. More...
bool	DoNotRecordData [get, set]
	Indicate whether you want to (default) avoid recording a particular task. More...
Properties inherited from MercuryMessaging.Task.IMmTaskInfo
int	RecordId [get, set]
int	UserId [get, set]
int	UserSequence [get, set]
int	TaskId [get, set]
string	TaskName [get, set]
bool	DoNotRecordData [get, set]

Detailed Description

MmTaskInfo contains basic information for tasks in the Mercury environment.

Constructor & Destructor Documentation

MmTaskInfo() [1/3]

MercuryMessaging.Task.MmTaskInfo.MmTaskInfo

(

)

Default constructor, all members set to default values.

MmTaskInfo() [2/3]

MercuryMessaging.Task.MmTaskInfo.MmTaskInfo	(	int	recId,
		int	userId,
		int	seq,
		int	taskId,
		bool	doNotRecordData,
		string	taskName
	)

Create an MmTaskInfo by passing all parameters

Parameters

recId	Record ID
userId	User ID
seq	Sequence ID
taskId	Task ID
doNotRecordData	Do not record this task.
taskName	Name of the task

MmTaskInfo() [3/3]

MercuryMessaging.Task.MmTaskInfo.MmTaskInfo

(

IMmTaskInfo

orig

)

Construct MmTaskInfo by duplicating another task.

Parameters

orig	Original task

Member Function Documentation

Copy()

virtual IMmSerializable MercuryMessaging.Task.MmTaskInfo.Copy ( )

virtual

Duplicate the task info.

Returns

Copy of MmTaskInfo

Implements MercuryMessaging.Task.IMmSerializable.

Reimplemented in MercuryMessaging.Task.MmTransformationTaskInfo, and MercuryMessaging.Task.MmLookAtTaskInfo.

Deserialize()

virtual void MercuryMessaging.Task.MmTaskInfo.Deserialize ( NetworkReader  reader )

virtual

Deserialize the task info from serialized form.

Parameters

reader

UNET deserializer.

Implements MercuryMessaging.Task.IMmSerializable.

Reimplemented in MercuryMessaging.Task.MmTransformationTaskInfo, and MercuryMessaging.Task.MmLookAtTaskInfo.

Headers()

virtual string MercuryMessaging.Task.MmTaskInfo.Headers ( )

virtual

Headers to use when writing task to file or stream.

Returns

Implements MercuryMessaging.Task.IMmTaskInfo.

Reimplemented in MercuryMessaging.Task.MmTransformationTaskInfo, and MercuryMessaging.Task.MmLookAtTaskInfo.

Parse()

virtual void MercuryMessaging.Task.MmTaskInfo.Parse ( string  str )

virtual

Generate member values by parsing string.

Parameters

str

Implements MercuryMessaging.Task.IMmTaskInfo.

Reimplemented in MercuryMessaging.Task.MmTransformationTaskInfo, and MercuryMessaging.Task.MmLookAtTaskInfo.

Serialize()

virtual void MercuryMessaging.Task.MmTaskInfo.Serialize ( NetworkWriter  writer )

virtual

Serialize the task info into serialized form.

Parameters

writer

UNET serializer.

Implements MercuryMessaging.Task.IMmSerializable.

Reimplemented in MercuryMessaging.Task.MmTransformationTaskInfo, and MercuryMessaging.Task.MmLookAtTaskInfo.

ToString()

override string MercuryMessaging.Task.MmTaskInfo.ToString

(

)

To String generates string of task with following order: RecordID, UserID, SeqID, TaskID, DoNotRecord, TaskName

Returns

String containing base task info.

Implements MercuryMessaging.Task.IMmTaskInfo.

Property Documentation

DoNotRecordData

bool MercuryMessaging.Task.MmTaskInfo.DoNotRecordData

getset

Indicate whether you want to (default) avoid recording a particular task.

RecordId

int MercuryMessaging.Task.MmTaskInfo.RecordId

getset

Record ID

TaskId

int MercuryMessaging.Task.MmTaskInfo.TaskId

getset

TaskID, useful for blocking tasks.

TaskName

string MercuryMessaging.Task.MmTaskInfo.TaskName

getset

Name of task.

UserId

int MercuryMessaging.Task.MmTaskInfo.UserId

getset

User ID

UserSequence

int MercuryMessaging.Task.MmTaskInfo.UserSequence

getset

Sequence ID, given a particular user

---

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

• C:/Users/ce223/Documents/Projects/MercuryMessaging/Assets/MercuryMessaging/Task/MmTaskInfo.cs