Limb Range Analyzer
Cross-platform application for human limb range analysis.
Client Class Reference

Class Client is designed for Limb Range Analyzer application patient data representation. More...

#include <client.hpp>

Inheritance diagram for Client:

Public Member Functions

 Client ()
 Default constructor for class Client. More...
 
 Client (QString id, QString firstName, QString lastName, QString email, QList< QSharedPointer< Session > > sessionList)
 Parametric constructor designed for Client class. More...
 
 ~Client ()
 Class destructor in its base form. More...
 
QString & Client_GetID ()
 Getter function for mID obtaining. More...
 
QString & Client_GetFirstName ()
 Member getter function that returns mFirstName member attribute. More...
 
QString & Client_GetLastName ()
 Getter function that retrieves mLastName. More...
 
QString & Client_GetEmail ()
 Function that returns patient's e-mail address. More...
 
QList< QSharedPointer< Session > > & Client_GetSessionList ()
 Getter function that allows the possibility of private member mSessionList reading. More...
 
QStringList Client_GetAllFormatted ()
 Public getter function that returns patient's attributes in a text form. More...
 
void Client_AddSession (QSharedPointer< Session > session)
 Setter function responsible for new Session adding. More...
 

Private Attributes

QString mID
 QString member variable that holds the unique Client identifier constructed by Hasher module.
 
QString mFirstName
 QString member that keeps patient's first name.
 
QString mLastName
 QString text variable introduced for last name keeping.
 
QString mEmail
 QString private member variable containing a unique e-mail address of a patient.
 
QList< QSharedPointer< Session > > mSessionList
 QList<QSharedPointer<Session>> member composed of Client's Session records.
 

Detailed Description

Class Client is designed for Limb Range Analyzer application patient data representation.

Client encapsulates necessary member variables and functions that (along with Session lists and their respective Exercise records) depict a patient data model, which is used by the application for measurement range advancement monitoring. Each Client record is unique. Measurement records are saved via XmlParser module, while Hasher class provides unique identifier creation.

See also
Session, Exercise, XmlParser, Hasher

Constructor & Destructor Documentation

◆ Client() [1/2]

Client::Client ( )

Default constructor for class Client.

Non-parametric Client class constructor.

See also
~Client()

◆ Client() [2/2]

Client::Client ( QString  id,
QString  firstName,
QString  lastName,
QString  email,
QList< QSharedPointer< Session > >  sessionList 
)

Parametric constructor designed for Client class.

Constructor that allows instance creation with defined Client attributes. These include patient's ID, first name, last name, e-mail and a list of sessions.

See also
~Client()

◆ ~Client()

Client::~Client ( )

Class destructor in its base form.

Class destructor function responsible for previously allocated memory cleaning.

See also
Client(), Client(QString id, QString firstName, QString lastName, QString email, QList<QSharedPointer<Session>> sessionList)

Member Function Documentation

◆ Client_AddSession()

void Client::Client_AddSession ( QSharedPointer< Session session)

Setter function responsible for new Session adding.

This function introduces the possibility of new Session adding.

Parameters
session- a new Session record that may or may not include a list of Exercise measurement data

◆ Client_GetAllFormatted()

QStringList Client::Client_GetAllFormatted ( )

Public getter function that returns patient's attributes in a text form.

Member function designed for client's ID, first name, last name and e-mail address reading.

Returns
QStringList - a list of client's attributes (without session list retrieval)

◆ Client_GetEmail()

QString & Client::Client_GetEmail ( )

Function that returns patient's e-mail address.

This function returns a client's e-mail address. Such address is unique for each Client.

Returns
QString - unique e-mail address of a client

◆ Client_GetFirstName()

QString & Client::Client_GetFirstName ( )

Member getter function that returns mFirstName member attribute.

Function designed for mFirstName string retrieving.

Returns
QString - text string with the first name of a patient

◆ Client_GetID()

QString & Client::Client_GetID ( )

Getter function for mID obtaining.

Member function that returns member variable mID .

Returns
QString - Client specific hashed string identifier

◆ Client_GetLastName()

QString & Client::Client_GetLastName ( )

Getter function that retrieves mLastName.

The sole purpose of this function is to return Client's last name.

Returns
QString - text string containing last name of a person

◆ Client_GetSessionList()

QList< QSharedPointer< Session > > & Client::Client_GetSessionList ( )

Getter function that allows the possibility of private member mSessionList reading.

This function returns mSessionList - a client specific list of sessions, which may also be empty.

Returns
QList<QSharedPointer<Session>> - a list of Session records

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