Class SBCContainerUserPlan

ClassList > SBCContainerUserPlan

This class describes a user plan. More...

• #include <SBCContainerUserPlan.hpp>

Public Types

Type	Name
enum	Type The type of the user plan.

Public Functions

Type	Name
	SBCContainerUserPlan () noexcept Constructs the None user plan.
	SBCContainerUserPlan (Type type) noexcept Constructs a user plan.
	SBCContainerUserPlan (const std::string & typeString) Constructs a user plan.
	SBCContainerUserPlan (const SBCContainerUserPlan & userPlan) Constructs a user plan.
Type	getType () noexcept const Returns the user plan type.
bool	operator!= (const SBCContainerUserPlan & userPlan) const Non-equality operator.
std::string	operator() () const Returns the user plan as a string.
bool	operator< (const SBCContainerUserPlan & userPlan) const Comparison with another user plan.
bool	operator<= (const SBCContainerUserPlan & userPlan) const Comparison with another user plan.
SBCContainerUserPlan &	operator= (const SBCContainerUserPlan & userPlan) Assignment operator.
bool	operator== (const SBCContainerUserPlan & userPlan) const Equality operator.
bool	operator> (const SBCContainerUserPlan & userPlan) const Comparison with another user plan.
bool	operator>= (const SBCContainerUserPlan & userPlan) const Comparison with another user plan.
virtual	~SBCContainerUserPlan () Destructs the user plan.

Detailed Description

This class describes a user plan in SAMSON.

Short name: SBUserPlan

Public Types Documentation

enum Type

The type of the user plan.

enum SBCContainerUserPlan::Type {
    None = 0,
    NoPlan = 0,
    Starter = 1,
    Standard = 2,
    Professional = 3,
    Enterprise = 4
};

---

Public Functions Documentation

function SBCContainerUserPlan [1/4]

Constructs the None user plan.

SBCContainerUserPlan::SBCContainerUserPlan () noexcept

---

function SBCContainerUserPlan [2/4]

Constructs a user plan.

SBCContainerUserPlan::SBCContainerUserPlan (
    Type type
) noexcept

---

function SBCContainerUserPlan [3/4]

Constructs a user plan.

SBCContainerUserPlan::SBCContainerUserPlan (
    const std::string & typeString
) 

---

function SBCContainerUserPlan [4/4]

Constructs a user plan.

SBCContainerUserPlan::SBCContainerUserPlan (
    const SBCContainerUserPlan & userPlan
) 

---

function getType

Returns the user plan type.

Type SBCContainerUserPlan::getType () noexcept const

---

function operator!=

Non-equality operator.

bool SBCContainerUserPlan::operator!= (
    const SBCContainerUserPlan & userPlan
) const

---

function operator()

Returns the user plan as a string.

std::string SBCContainerUserPlan::operator() () const

---

function operator<

Comparison with another user plan.

bool SBCContainerUserPlan::operator< (
    const SBCContainerUserPlan & userPlan
) const

---

function operator<=

Comparison with another user plan.

bool SBCContainerUserPlan::operator<= (
    const SBCContainerUserPlan & userPlan
) const

---

function operator=

Assignment operator.

SBCContainerUserPlan & SBCContainerUserPlan::operator= (
    const SBCContainerUserPlan & userPlan
) 

---

function operator==

Equality operator.

bool SBCContainerUserPlan::operator== (
    const SBCContainerUserPlan & userPlan
) const

---

function operator>

Comparison with another user plan.

bool SBCContainerUserPlan::operator> (
    const SBCContainerUserPlan & userPlan
) const

---

function operator>=

Comparison with another user plan.

bool SBCContainerUserPlan::operator>= (
    const SBCContainerUserPlan & userPlan
) const

---

function ~SBCContainerUserPlan

Destructs the user plan.

virtual SBCContainerUserPlan::~SBCContainerUserPlan () 

---