example::Animal Class Reference

Base class for all animals from which Bird derives. More...

#include <animal.h>

Inheritance diagram for example::Animal:

Collaboration diagram for example::Animal:

Classes
struct	Result
	Some random inner class of Animal. More...

Public Types
enum	Type {   NONE = 0, INSECT = 1, AMPHIBIAN = 2, BIRD = 3,   FISH = 4, REPTILE = 5, MAMMAL = 6 }
	The 6 classes of animal kingdom. More...
typedef std::pair< Animal *, Animal * >	Parents

Public Member Functions
	Animal (Type type, const std::string &name, Animal *mother=nullptr, Animal *father=nullptr)
	The main constructor. More...
	Animal (const Animal &other)=delete
	Animal (Animal &&animal) noexcept
virtual	~Animal ()=default
	operator bool () const
	Returns true if this is an valid animal. More...
void	swap (Animal &other) noexcept
int	get_num_of_limbs () const override
	Returns the number of limbs. More...
int	get_num_of_eyes () const override
	Returns the number of eyes. More...
bool	has_tail () const override
	Returns true if the animal has a tail. More...
virtual void	move ()
virtual void	make_sound ()=0
Parents	get_parents () const
const std::string &	get_name () const
	Get the name of the animal. More...
void	some_inline_member_function (Animal *animal)
	Lorem Ipsum. More...
Animal &	operator= (const Animal &other)=delete
	Deleted copy operator. More...
Animal &	operator= (Animal &&other) noexcept
	Move operator. More...

Static Public Member Functions
static Animal *	find_parent_by_name (Animal *child)
static Animal *	find_child_by_name (Animal *parent)

Protected Attributes
Animal *	mother
	The pointer to the mother. More...
Animal *	father
	The pointer to the father. More...
std::string	name

Friends
void	some_global_function (Animal *animal)
	Some random global function that modifies Animal. More...

Detailed Description

Base class for all animals from which Bird derives.

Lorem Ipsum Donor. Some Random link with bold and italics And the following is a typewritter font.

Example code:

Animal animal = Animal("Hello World", nullptr, nullptr);
std::cout << animal.get_name() << std::endl;

See also

Bird

Bug:

Some random bug

Note

Some random note

Warning

Some random warning

Test:

Some random test description

Todo:

Some random todo

Template Parameters

T	Some random template paramater description which actually does not exist in the code!

Precondition

First initialize the system.

Date

2017-2018

Author

Matus Novak

Hello World

Member Typedef Documentation

Parents

typedef std::pair<Animal*, Animal*> example::Animal::Parents

Constructor & Destructor Documentation

Animal() [1/3]

example::Animal::Animal	(	Type	type,
		const std::string &	name,
		Animal *	mother = nullptr,
		Animal *	father = nullptr
	)

The main constructor.

Use this constructor to allocate a new instance of Animal

Parameters

type	The type of the animal that matches Animal::Type
name	Any name to associate the animal with

Exceptions

CustomException

If either only mother or father is assigned

Animal() [2/3]

example::Animal::Animal ( const Animal &  other )

delete

Animal() [3/3]

example::Animal::Animal ( Animal &&  animal )

noexcept

~Animal()

virtual example::Animal::~Animal ( )

virtualdefault

Member Function Documentation

find_child_by_name()

static Animal* example::Animal::find_child_by_name ( Animal *  parent )

static

find_parent_by_name()

static Animal* example::Animal::find_parent_by_name ( Animal *  child )

static

get_name()

const std::string& example::Animal::get_name ( ) const

inline

Get the name of the animal.

Returns

A constant reference to the name

get_num_of_eyes()

int example::Animal::get_num_of_eyes ( ) const

overridevirtual

Returns the number of eyes.

See also

get_num_of_limbs, get_num_of_eyes

Implements example::AnimalInterface.

get_num_of_limbs()

int example::Animal::get_num_of_limbs ( ) const

overridevirtual

Returns the number of limbs.

See also

get_num_of_eyes, get_num_of_limbs

Implements example::AnimalInterface.

get_parents()

Parents example::Animal::get_parents ( ) const

inline

has_tail()

bool example::Animal::has_tail ( ) const

overridevirtual

Returns true if the animal has a tail.

See also

get_num_of_limbs, get_num_of_eyes

Return values

true	Does have a tail
false	Does not have a tail

Implements example::AnimalInterface.

make_sound()

virtual void example::Animal::make_sound ( )

pure virtual

Implemented in example::Bird.

move()

virtual void example::Animal::move ( )

virtual

Reimplemented in example::Bird.

operator bool()

example::Animal::operator bool

(

)

const

Returns true if this is an valid animal.

Lorem Ipsum returns true

operator=() [1/2]

Animal& example::Animal::operator= ( const Animal &  other )

delete

Deleted copy operator.

operator=() [2/2]

Animal& example::Animal::operator= ( Animal &&  other )

noexcept

Move operator.

some_inline_member_function()

void example::Animal::some_inline_member_function ( Animal *  animal )

inline

Lorem Ipsum.

See also

Animal

Parameters

animal

The pointer to the animal instance

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Implementation:

Does some more things

Checks that the things it does are the best

swap()

void example::Animal::swap ( Animal &  other )

noexcept

Friends And Related Function Documentation

some_global_function

void some_global_function ( Animal *  animal )

friend

Some random global function that modifies Animal.

See also

Animal

Parameters

animal

The pointer to the animal instance

Member Data Documentation

father

Animal* example::Animal::father

protected

The pointer to the father.

Can be null!

mother

Animal* example::Animal::mother

protected

The pointer to the mother.

Can be null!

name

std::string example::Animal::name

protected

---

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

• src/animal.h