In file /home/eternity/Source/Common/GMessage/H/msgField.h:

class MsgField : public Field

Message field

Inheritance:

MsgField < Field < Debugable

Public Methods

Void* MsgField::CreateCopyOfValue ()
Creates a copy of "size" bytes starting from the position "value" points to
Int MsgField::EqualTo (MsgField *aMsgField)
Returns 1 if this field's content equals to the content of the given field
Err MsgField::GetAsID ( ID *t)
Kratky_komentar_s_teckou_na_konci
Char* MsgField::GetAsString ()
Returns a copy of the stored information as a NULL-terminated string
MsgField::MsgField (Char *aFieldName, LogFile *aLogFile)
MsgField constructor
MsgField* MsgField::NewMsgField (Size aSize, Char *aFieldName, LogFile *aLogFile)
According to "aSize" creates Bytes/ or FileMsgField
Err MsgField::SetAsString (Char *aString)
Gets (and stores) the information from a NULL-terminated string
Err MsgField::SetValue (Void *aBuffer, Size aSize)
Sets "value" and "size" according to "aBuffer" and "aSize"
MsgField::~MsgField ()
Destructor for MsgField

Public

methods
methods
MsgField (Char *aFieldName = NULL, LogFile *aLogFile = NULL)
constructor
virtual ~MsgField ()
destructor
virtual Int EqualTo (MsgField *)
Comparison

Store value

Get and set value

Protected

attributes
Void* value
Stored value
Size size
Stored value size

value and size manipulation

Inherited from Field:

Public Methods

Field::Field(Char *aName, LogFile *aLogFile)
Char* Field::GetName()
Int Field::NameEqualTo(Char *aName)
Void Field::SetName(Char *aName)
Field::~Field()

Inherited from Debugable:

Public Methods

string* Debugable::CreateString(char *firstStr, int firstInt, int secondInt)
Debugable::Debugable(LogFile * debugLogFile)
int Debugable::SetDebugOptions(int newLogOptions)
void Debugable::SetLogFile(LogFile *aLogFile)
void Debugable::WriteString(LogLevel debugLevel, char * format, ...)
Debugable::~Debugable()

Documentation

Message field. An abstract base class for storing field information in GMessage. Descendants must be able to set its value getting it either as a byte stream or as a file (file name, respectively).

Description: This file contains the MsgField class and its descendants BytesMsgField and FileMsgField. The descendants are used to store information kept in fields of GMessage. BytesMsgField stores the information as a byte stream in memory, FileMsgField stores only a name of a (temporary) file that keeps the information.

NOTE: All constructors and Set../Get.. methods COPY given data.

attributes

Void* value
Stored value

Size size
Stored value size

value and size manipulation

methods

methods

MsgField(Char *aFieldName = NULL, LogFile *aLogFile = NULL)
constructor

virtual ~MsgField()
destructor

virtual Int EqualTo(MsgField *)
Comparison

Store value

Get and set value

Void* MsgField::CreateCopyOfValue()
Creates a copy of "size" bytes starting from the position "value" points to. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Int MsgField::EqualTo(MsgField *aMsgField)
Returns 1 if this field's content equals to the content of the given field. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err MsgField::GetAsID( ID *t)
Kratky_komentar_s_teckou_na_konci. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Char* MsgField::GetAsString()
Returns a copy of the stored information as a NULL-terminated string. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

MsgField::MsgField(Char *aFieldName, LogFile *aLogFile)
MsgField constructor. This file contains the MsgField class and its descendants BytesMsgField and FileMsgField. The descendants are used to store information kept in fields of GMessage. BytesMsgField stores the information as a byte stream in memory, FileMsgField stores only a name of a (temporary) file that keeps the information.
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

MsgField* MsgField::NewMsgField(Size aSize, Char *aFieldName, LogFile *aLogFile)
According to "aSize" creates Bytes/ or FileMsgField. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err MsgField::SetAsString(Char *aString)
Gets (and stores) the information from a NULL-terminated string. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err MsgField::SetValue(Void *aBuffer, Size aSize)
Sets "value" and "size" according to "aBuffer" and "aSize". Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

MsgField::~MsgField()
Destructor for MsgField. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Direct child classes:
FileMsgField
BytesMsgField
Author:
Pavel
See Also:
co_se_toho_tyka

alphabetic index hierarchy of classes

generated by doc++