TAParam

List of ancestors:
TObj
Files:
params.h, params.cpp

Abstract	Virtual	Overridden
Key, Important	Constructor	Destructor
Methods beginning with Get or Set (get/set) are usually intended to access Attributes of same name (exceptions will be marked).

Description

This class represents a single parameter from the parametric file.

Warnings

All output strings (char *) should be used as constants. Don't change them from outside the object. On the other hand all incoming strings are copied into the object. So the source strings can change or be deleted.
Params inserted into TGroup or TParamFile are really inserted not copied.

Methods

Public:

	BOOL AsBool(void)
	char AsChar(void)
	TFit AsFit(void)
	double AsFloat(void)
	int AsInt(void)
	TProb AsProb(void)
	char * AsString(void)
	void Delete()
	char * GetCaption(void)
	TChange GetChange(void)
	TGroup * GetGrp(void)
	char * GetName(void)
	TAParam * GetNext(void)
	TParamFile *GetParent()
	TAParam * GetPrior()
	TStrList *GetRemarks()
	uint GetSerSize(BOOL subclass=FALSE)
	TPFileID *GetSourceFile()
	TTypes GetType(void)
	void PutAfter(TAParam *Who)
	void PutBefore(TAParam *Who)
	void SetCaption(char *aCaption)
	void SetChange(TChange aChange)
	TGroup * SetGrp(TGroup *aGrp)
	void SetName(char *aName)
	uint Serialize(BYTE **rawbytes,BOOL subclass=FALSE)
	void SetSourceFile(TPFileID *val)
	void SetType(TTypes aType)
	void SetValue(BOOL)
	void SetValue(char)
	void SetValue(char *)
	void SetValue(double)
	void SetValue(int)
	TAParam(char *aName=NULL, TPFileID *aSourceFile=NULL)
	TAParam(TAParam &picture)
	void Unchain()
	~TAParam(void)

Protected:

TAParam(BYTE** raw,uint length,BOOL subclass,char *GroupName,TParamFile *Into)

Private:

type Astype(void)

The parameters value is returned in a format specified by type. i.g  some conversions can be made. Use the string value as a pattern, don't change it directly.

Returns

The parameters value in a required format.

TParamFile.Readtype

void Delete()

Simply just calls the destructor.

~TAParam

char * GetCaption(void)

Returns

Returns the caption of the parameter. If it is NULL string Name is returned instead.

TParamFile *GetParent()

Returns

Returns the TParamFile structure which the parameter belongs to.

void PutAfter(TAParam *Who)

Puts the parameter behind the specified one (if it is not NULL). Parent  can change (GetParent).

Arguments

Who...the parameter in the chain.

void PutBefore(TAParam *Who)

Puts the parameter before the specified one (if it is not NULL). Parent  can change (GetParent). Also TParamFile.FirstParam can be affected.

Arguments

Who...the parameter in the chain.

TGroup * SetGrp(TGroup *aGrp)

Quite a complex function. Among others parent can be changed (GetParent). If there is no FileID of the same filename as in the current parent TParamFile the old one is copied.

Arguments

aGrp...the new group

Returns

The group the parameter belongs to now.

TGroup.InjectParam, TGroup.InsertParam, TGroup.EjectParam

void SetValue(type)

Set the value of the parameter. The type is converted into the type of parameter.

Arguments

the new value

void SetSourceFile(TPFileID *val)

Quite a complex function. Among others parent can be changed (GetParent). If a Group of the same name as the parental is does not exist in new TParamFile it is created (empty).

Arguments

val...the new FileID.

TAParam(char *aName=NULL, TPFileID *aSourceFile=NULL)

Constructor that creates a new parameter. The parameter doesn't belong to any group. And its type must be set.

Arguments

aName...name of the new parameter
aSourceFile...file the parameter belongs to

TAParam(TAParam &picture)

Copy constructor. Warning: the new parameter is in no group nor chain even the SourceFile is NULL.

Arguments

picture...parameter that should be copied

TAParam(BYTE** raw,uint length,BOOL subclass,char *GroupName,TParamFile *Into)

Deserialization constructor. Don't use separately.

void Unchain()

Takes out the parameter from the chain. The TParamFile.FristParam is maintained.

~TAParam(void)

Destructor. Frees also the string values.

Attributes

Public:

Protected:

	char * Caption
	TChange Change
	TMultiType Data
	TGroup * Grp
	char * Name
	TAParam *Next
	TAParam *Prior
	TStrList *Remarks
	TPFileID *SourceFile
	char *strbuf
	TTypes Type

Private:

---

char * Caption

Caption of the parameter that should be used by the parameter setting utility. If it is NULL (The GetCaption function returns  a same pointer  as function GetName) the setting utility should not show this parameter.

TChange Change

The changeability status of the parameter.

TMultiType Data

A union type attribute, that contains the value of the parameter.

TGroup * Grp

The parent group.

SetGrp

char * Name

Name of the parameter.

TAParam *Next

Next parameter in the structure chain.

TAParam *Prior

Prior parameter in the structure chain.

TStrList *Remarks

Remarks connected with the parameter.

TPFileID *SourceFile

The FileID of the file the parameter was loaded from. (or which the parameter was added into.).

SetSourceFile

char *strbuf

Points to a buffer for values converted to string from other types.

TTypes Type

Type of the parameters data.

Operators

Public:

Protected:

Private:

Specials

Use the string values as patterns don't change them directly.

Conversions:
    BOOL->string      "FALSE" or "TRUE"
    BOOL->ordinal    0 or 1
    BOOL->char        'T' (macro TRUECHAR) or 'F' (macro FALSECHAR)
    string->BOOL       TRUE if the string is "TRUE" otherwise FALSE
    char->BOOL        'T' (TRUECHAR) to TRUE otherwise FALSE
Other conversions are obvious.