1. class
  2. App
  3. \
  4. G6K
  5. \
  6. Model
  7. \
  8. DatasetChild

DatasetChild

abstract class DatasetChild

This class allows the storage and retrieval of common attributes of a dataset child.

A dataset child is either a data or a data group. This class is therefore the base class of the Data class and the DataGroup class.

Properties

protected Simulator $simulator
protected int $id
protected string $name
protected string $label
protected RichText $description
protected bool $error
protected array $errorMessages
protected bool $warning
protected array $warningMessages
protected bool $used

Methods

void
__construct(Simulator $simulator, int $id, string $name)

Constructor of class DatasetChild

Simulator
getSimulator()

Returns the Simulator object that uses this dataset child

int
getId()

Returns the ID of this dataset child.

void
setId(int $id)

Sets the ID of this dataset child.

string
getName()

Returns the name of this dataset child.

void
setName(string $name)

Sets the name of this dataset child.

string
getLabel()

Returns the label of this dataset child.

void
setLabel(string $label)

Sets the label of this dataset child.

RichText
getDescription()

Returns the description of this dataset child.

void
setDescription(RichText $description)

Sets the description of this dataset child.

bool
isUsed()

Returns the state of use of this dataset child by the current simulation step

bool
getUsed()

Returns the state of use of this dataset child by the current simulation step

void
setUsed(bool $used)

Sets the state of use of this dataset child by the current simulation step

bool
isError()

Returns the error attribute of this dataset child

bool
getError()

Returns the error attribute of this dataset child

void
setError(bool $error)

Determines whether this dataset child has a issued error or not

array
getErrorMessages()

Returns the list of error messages.

void
setErrorMessages(array $errorMessages)

Sets the list of error messages.

void
addErrorMessage(string $errorMessage)

Adds a message to the list of error messages.

void
removeErrorMessage(int $index)

Removes a message from the list of error messages.

bool
isWarning()

Returns the warning attribute of this dataset child

bool
getWarning()

Returns the warning attribute of this dataset child

void
setWarning(bool $warning)

Determines whether this dataset child has a issued warning or not

array
getWarningMessages()

Returns the list of warning messages.

void
setWarningMessages(array $warningMessages)

Sets the list of warning messages.

void
addWarningMessage(string $warningMessage)

Adds a message to the list of warning messages.

void
removeWarningMessage(int $index)

Removes a message from the list of warning messages.

string
getClass()

Returns the class name of this dataset child. It's either "Data" or "DataGroup".

Details

at line 131
void __construct(Simulator $simulator, int $id, string $name)

Constructor of class DatasetChild

Parameters

Simulator $simulator The Simulator object that uses this dataset child.
int $id The ID of this dataset child.
string $name The name of this dataset child.

Return Value

void

at line 144
Simulator getSimulator()

Returns the Simulator object that uses this dataset child

Return Value

Simulator The Simulator object

at line 155
int getId()

Returns the ID of this dataset child.

Return Value

int The ID of this dataset child.

at line 167
void setId(int $id)

Sets the ID of this dataset child.

Parameters

int $id The ID of this dataset child.

Return Value

void

at line 178
string getName()

Returns the name of this dataset child.

Return Value

string The name of this dataset child.

at line 190
void setName(string $name)

Sets the name of this dataset child.

Parameters

string $name The name of this dataset child.

Return Value

void

at line 201
string getLabel()

Returns the label of this dataset child.

Return Value

string The label of this dataset child.

at line 213
void setLabel(string $label)

Sets the label of this dataset child.

Parameters

string $label The label of this dataset child.

Return Value

void

at line 224
RichText getDescription()

Returns the description of this dataset child.

Return Value

RichText The description of this dataset child.

at line 236
void setDescription(RichText $description)

Sets the description of this dataset child.

Parameters

RichText $description The description of this dataset child.

Return Value

void

at line 247
bool isUsed()

Returns the state of use of this dataset child by the current simulation step

Return Value

bool true if this dataset child is used (displayed) by the current simulation step, false otherwise

at line 258
bool getUsed()

Returns the state of use of this dataset child by the current simulation step

Return Value

bool true if this dataset child is used (displayed) by the current simulation step, false otherwise

at line 270
void setUsed(bool $used)

Sets the state of use of this dataset child by the current simulation step

Parameters

bool $used true if this dataset child is used (displayed) by the current simulation step, false otherwise

Return Value

void

at line 281
bool isError()

Returns the error attribute of this dataset child

Return Value

bool true if an error was occured, false if not

at line 292
bool getError()

Returns the error attribute of this dataset child

Return Value

bool true if an error was occured, false if not

at line 304
void setError(bool $error)

Determines whether this dataset child has a issued error or not

Parameters

bool $error true if this dataset child has a issued error, false otherwise

Return Value

void

at line 315
array getErrorMessages()

Returns the list of error messages.

Return Value

array The list of error messages

at line 327
void setErrorMessages(array $errorMessages)

Sets the list of error messages.

Parameters

array $errorMessages The list of error messages

Return Value

void

at line 339
void addErrorMessage(string $errorMessage)

Adds a message to the list of error messages.

Parameters

string $errorMessage The message to add

Return Value

void

at line 353
void removeErrorMessage(int $index)

Removes a message from the list of error messages.

Parameters

int $index The index of the message in the list of error messages

Return Value

void

at line 364
bool isWarning()

Returns the warning attribute of this dataset child

Return Value

bool true if an warning was issued, false if not

at line 375
bool getWarning()

Returns the warning attribute of this dataset child

Return Value

bool true if an warning was issued, false if not

at line 387
void setWarning(bool $warning)

Determines whether this dataset child has a issued warning or not

Parameters

bool $warning true if this dataset child has a issued warning, false otherwise

Return Value

void

at line 398
array getWarningMessages()

Returns the list of warning messages.

Return Value

array The list of warning messages.

at line 410
void setWarningMessages(array $warningMessages)

Sets the list of warning messages.

Parameters

array $warningMessages The list of warning messages.

Return Value

void

at line 422
void addWarningMessage(string $warningMessage)

Adds a message to the list of warning messages.

Parameters

string $warningMessage The message to add.

Return Value

void

at line 436
void removeWarningMessage(int $index)

Removes a message from the list of warning messages.

Parameters

int $index The index of the message in the list of warning messages

Return Value

void

at line 447
string getClass()

Returns the class name of this dataset child. It's either "Data" or "DataGroup".

Return Value

string The class name