Beatmup::Fragments::FragmentPtr Struct Reference

Pointer to a Fragment. More...

#include <fragment.h>

Public Member Functions
void	operator= (const FragmentPtr &)
	FragmentPtr ()
	Initialize to null. More...
	FragmentPtr (Fragment &fragment, int offset, int length)
	FragmentPtr (const FragmentPtr &)
	FragmentPtr (FragmentPtr &&)
	~FragmentPtr ()
void	editData ()
bool	isNull () const
void	nullify ()

Public Attributes
Fragment *	fragment
int	offset
	offset in samples inside the fragment since its beginning More...
int	length
	number of samples to use from the fragment More...

Detailed Description

Pointer to a Fragment.

Handles reference counting of the pointer Fragment.

Definition at line 67 of file fragment.h.

Constructor & Destructor Documentation

FragmentPtr() [1/4]

FragmentPtr::FragmentPtr

(

)

Initialize to null.

Definition at line 71 of file fragment.cpp.

                         {
    fragment = NULL;
    offset = length = 0;
}

FragmentPtr() [2/4]

FragmentPtr::FragmentPtr	(	Fragment &	fragment,
		int	offset,
		int	length
	)

Definition at line 78 of file fragment.cpp.

                                                                  :
    fragment(&fragment), offset(offset), length(length)
{
    fragment.use();
}

FragmentPtr() [3/4]

FragmentPtr::FragmentPtr

(

const FragmentPtr &

src

)

Definition at line 85 of file fragment.cpp.

                                               {
    if (src.isNull()) {
        fragment = NULL;
        offset = length = 0;
    }
    else {
        fragment = src.fragment->use();
        offset = src.offset;
        length = src.length;
    }
}

FragmentPtr() [4/4]

FragmentPtr::FragmentPtr

(

FragmentPtr &&

src

)

Definition at line 98 of file fragment.cpp.

                                          {
    fragment = src.fragment;
    offset = src.offset;
    length = src.length;
    // nullifying source
    src.fragment = NULL;
    src.offset = src.length = 0;
}

~FragmentPtr()

FragmentPtr::~FragmentPtr

(

)

Definition at line 108 of file fragment.cpp.

                          {
    if (!isNull())
        fragment->drop();
}

Member Function Documentation

operator=()

void FragmentPtr::operator=

(

const FragmentPtr &

src

)

Definition at line 58 of file fragment.cpp.

                                                   {
    if (!isNull())
        fragment->drop();
    if (src.isNull())
        nullify();
    else {
        fragment = src.fragment->use();
        offset = src.offset;
        length = src.length;
    }
}

editData()

void FragmentPtr::editData

(

)

Definition at line 114 of file fragment.cpp.

                           {
    fragment = fragment->edit();
        // No need to check if the fragment is cloned or not and drop the original if it is.
        // If it is cloned, there is at least one reference to the original fragment.
        // So no dropping, just decrease ref counter in fragment->edit().
}

isNull()

bool Beatmup::Fragments::FragmentPtr::isNull ( ) const

inline

Definition at line 85 of file fragment.h.

{ return fragment == NULL; }

nullify()

void FragmentPtr::nullify

(

)

Definition at line 122 of file fragment.cpp.

                          {
    if (!isNull())
        fragment->drop();
    fragment = NULL;
    offset = length = 0;
}

Member Data Documentation

fragment

Fragment* Beatmup::Fragments::FragmentPtr::fragment

Definition at line 69 of file fragment.h.

offset

int Beatmup::Fragments::FragmentPtr::offset

offset in samples inside the fragment since its beginning

Definition at line 70 of file fragment.h.

length

int Beatmup::Fragments::FragmentPtr::length

number of samples to use from the fragment

Definition at line 71 of file fragment.h.

---

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

• core/fragments/fragment.h
• core/fragments/fragment.cpp