#include <PList.h>

Inheritance diagram for PList:

Public Member Functions
	PList ()
	Standard Constructor.

	PList (int reservedsize)

virtual	~PList ()
	Standard Destructor.

	PList (const PList &tmpList)
	Copy Constructor.

virtual PList *	Clone ()
	Makes and returns a deep copy–notworking because copy makes deep copy anyway?

std::vector< Variant >::const_iterator	Begin () const

std::vector< Variant >::const_iterator	End () const

std::vector< Variant >::iterator	Begin ()

std::vector< Variant >::iterator	End ()

void	PushBack (const Variant &v)

void	PopBack ()

bool	IsEmpty ()

void	Clear ()

Variant	First ()

Variant	Rest ()

Variant	Nth (unsigned int n)

Variant	Last ()

counted_ptr< PEBLObjectBase >	SortBy (const PList &key)

unsigned long	Length () const

bool	IsMember (Variant v)

void	SetElement (unsigned int n, Variant value)

const std::vector< Variant > *	GetList () const

Public Member Functions inherited from PEBLObjectBase
	PEBLObjectBase ()
	Standard Constructor.

	PEBLObjectBase (ComplexDataType cdt)
	Standard Constructor.

	PEBLObjectBase (const PEBLObjectBase &pob)

virtual	~PEBLObjectBase ()
	Standard Destructor.

virtual bool	InitializeProperty (std::string name, Variant v)

virtual bool	SetProperty (std::string name, Variant v)

Variant	GetProperty (std::string) const

virtual ObjectValidationError	ValidateProperty (std::string, Variant v) const

virtual ObjectValidationError	ValidateProperty (std::string) const

ComplexDataType	GetType ()

virtual std::string	ObjectName () const

virtual std::ostream &	PrintProperties (std::ostream &out)

virtual Variant	GetPropertyList ()

Protected Member Functions
std::ostream &	SendToStream (std::ostream &out) const

Friends
std::ostream &	operator<< (std::ostream &out, const PList &pcd)

Additional Inherited Members
Protected Attributes inherited from PEBLObjectBase
ComplexDataType	mCDT

std::map< std::string, Variant >	mProperties

Detailed Description

This class is a simple list of Variants. It is implemented as an STL list, but does not currently expose all of the STL list methods.

Definition at line 44 of file PList.h.

Constructor & Destructor Documentation

◆ PList() [1/3]

PList::PList ( )

Standard Constructor.

Definition at line 48 of file PList.cpp.

            : PEBLObjectBase(CDT_LIST)
{
 
    //    mCDT = CDT_LIST;
}

Referenced by Clone(), and SortBy().

◆ PList() [2/3]

PList::PList ( int reservedsize )

Definition at line 55 of file PList.cpp.

                            : PEBLObjectBase(CDT_LIST)
{
 
      mList.reserve((int)(reservedsize));
}

◆ ~PList()

PList::~PList ( )

virtual

Standard Destructor.

Definition at line 109 of file PList.cpp.

{
 
}

◆ PList() [3/3]

PList::PList ( const PList & tmpList )

Copy Constructor.

Copy constructor. Should make a deep copy.

Defunct code attempt: Using STL copy algorithm

Definition at line 63 of file PList.cpp.

                                 : PEBLObjectBase(CDT_LIST)
{
 
 
    //mCDT=CDT_LIST;
    const std::vector<Variant> * tmp = tmpList.GetList();
 
    //Make an item-by-item copy of list into mList.
    //Couldn't figure out how to use the stl copy algorithm to
    //do this, so I will do it by hand.
    //  std::copy(tmp->begin(), tmp->end(), mList.begin());
 
    std::vector<Variant>::const_iterator p;
    for(p = tmp->begin(); p!=tmp->end(); p++)
        {
            mList.push_back(Variant(*p));
        }
 
}

References GetList().

Member Function Documentation

◆ Begin() [1/2]

std::vector< Variant >::iterator PList::Begin ( )

Definition at line 115 of file PList.cpp.

{
    return mList.begin();
}

◆ Begin() [2/2]

std::vector< Variant >::const_iterator PList::Begin ( ) const

◆ Clear()

void PList::Clear ( )

inline

Definition at line 76 of file PList.h.

76{mList.clear();};

◆ Clone()

PList * PList::Clone ( )

virtual

Makes and returns a deep copy–notworking because copy makes deep copy anyway?

Cloner. This makes a item-for-item deep copy and returns a pointer to it.

Defunct code attempt: Using STL copy algorithm

Definition at line 86 of file PList.cpp.

{
 
    cout << "Cloning list\n";
    PList * newlist = new PList();
 
    //Make an item-by-item copy of list into mList.
    //Couldn't figure out how to use the stl copy algorithm to
    //do this, so I will do it by hand.
    //  std::copy(tmp->begin(), tmp->end(), mList.begin());
 
    std::vector<Variant>::iterator p;
    for(p = mList.begin(); p!=mList.end(); p++)
        {
            // This does not work.  Need to make the contained list and then embed it.
            //       newlist->push_back(Variant(*p));
        }
 
    return newlist;
}

References PList().

◆ End() [1/2]

std::vector< Variant >::iterator PList::End ( )

Definition at line 120 of file PList.cpp.

{
    return mList.end();
}

◆ End() [2/2]

std::vector< Variant >::const_iterator PList::End ( ) const

◆ First()

Variant PList::First ( )

Definition at line 169 of file PList.cpp.

{
    if(mList.empty())
        PError::SignalFatalError("Attempting to get First() element of empty list.");
 
    return mList.front();
 
}

References PError::SignalFatalError().

◆ GetList()

const std::vector< Variant > * PList::GetList ( ) const

inline

Definition at line 96 of file PList.h.

96{return &mList;};

Referenced by PList().

◆ IsEmpty()

bool PList::IsEmpty ( )

inline

Definition at line 74 of file PList.h.

74{return mList.empty();};

◆ IsMember()

bool PList::IsMember ( Variant v )

◆ Last()

Variant PList::Last ( )

Definition at line 235 of file PList.cpp.

{
    //This is messed up--need a NULL variant type
    //or error codes etc.
    if(mList.empty())
        PError::SignalFatalError("Attempting to get last element element of empty list.");
 
 
    std::vector<Variant>::iterator p = mList.end();
    p--;
    return *p;
}

References PError::SignalFatalError().

Referenced by PEBLList::Last().

◆ Length()

unsigned long PList::Length ( ) const

inline

◆ Nth()

Variant PList::Nth ( unsigned int n )

Definition at line 181 of file PList.cpp.

{
    //This is messed up--need a NULL variant type
    //or error codes etc.
    if(mList.size() < n)
        PError::SignalFatalError("Attempting to get Nth element element of  too-short list.");
    if(n==0)
        PError::SignalFatalError("Attempting to get 0th element element of  too-short list.");
 
    //std::vector<Variant>::iterator p = mList[n];
    //.begin();
    //    for(unsigned int i = 1; i< n; i++,p++);
    //return *p;
 
    //Note: this is 1-indexed, so 1 is 0, etc.
    return mList[n-1];
}

References PError::SignalFatalError().

◆ PopBack()

void PList::PopBack ( )

Definition at line 162 of file PList.cpp.

{
    mList.pop_back();
}

◆ PushBack()

void PList::PushBack ( const Variant & v )

Definition at line 149 of file PList.cpp.

{
 
    //Let's try to reduce time overhead by expanding using reserve to 50% larger than the current list.
    //which is really a std::vector
   if(mList.capacity() < mList.size()+1)
   {
    //increase reserve capacity by 25%
       mList.reserve((int)(mList.size()*1.25));
   }
    mList.push_back(v);
}

Referenced by PEBLList::Append(), PEBLList::CrossFactorWithoutDuplicates(), PEBLList::DesignFullCounterbalance(), Evaluator::Evaluate(), Evaluator::Evaluate1(), PEBLUtility::ExtractJSONObject(), PEBLStream::FileReadList(), PEBLStream::FileReadTable(), PEBLObjects::GetAudioStats(), PlatformJoystick::GetBallState(), SDLUtility::GetCurrentScreenResolution(), PEBLEnvironment::GetCurrentScreenResolution(), PlatformEnvironment::GetCursorPosition(), PEBLUtility::GetDirectoryListing(), SDLUtility::GetDriverList(), PEBLStream::GetHTTPText(), PlatformTextBox::GetLineBreaks(), PlatformEnvironment::GetMouseState(), PEBLObjectBase::GetPropertyList(), PCustomObject::GetPropertyList(), PlatformEnvironment::GetScreenModes(), PEBLObjects::GetSize(), PEventLoop::Loop1(), PEBLList::Merge(), PEvent::operator Variant(), PEBLInterpret(), PEBLList::PushOnEnd(), PEBLMath::Recurse(), PEBLMath::Recurse2(), PEBLList::Repeat(), PEBLList::RepeatList(), PEBLList::Rotate(), PEBLList::Sequence(), PEBLList::Shuffle(), SortBy(), PEBLEnvironment::StartEventLoop(), PEBLList::SubList(), PEBLUtility::Tokenize(), PEBLList::Transpose(), PEBLEnvironment::WaitForMouseButton(), and PEBLEnvironment::WaitForMouseButtonWithTimeout().

◆ Rest()

Variant PList::Rest ( )

◆ SendToStream()

ostream & PList::SendToStream ( std::ostream & out ) const

protectedvirtual

This is used by the friend function of PComplex Data <<, which calls the inheritable function SendToStream(). It just spits out the items of the list with spaces as separators. Since the items are variants, it uses the overloaded << operator for variants.

Reimplemented from PEBLObjectBase.

Definition at line 305 of file PList.cpp.

{
    std::vector<Variant>::const_iterator p;
    p = mList.begin();
 
     out << "[" ;
    //out << this->Length() << ":";
 
    //Print out the first item, so comma-ing works out ok.
    if( p != mList.end())
        {
            out << *p ;
            p++;
            while(p != mList.end())
                {
                    //send each item to stream with space and comma in between.
                    out << ", " << *p  << flush;
                    p++;
                }
        }
    out << "]" ;
 
    return out;
}

◆ SetElement()

void PList::SetElement	(	unsigned int	n,
		Variant	value
	)

Definition at line 222 of file PList.cpp.

{
 
    //This is messed up--need a NULL variant type
    //or error codes etc.
    if(mList.size() < n)
        PError::SignalFatalError("Attempting to get Nth element element of  too-short list.");
    if(n==0)
        PError::SignalFatalError("Attempting to get 0th element element of  too-short list.");
    mList[n-1] = value;
 
}

References PError::SignalFatalError().

Referenced by PEBLList::SetElement().

◆ SortBy()

counted_ptr< PEBLObjectBase > PList::SortBy ( const PList & key )

This sorts the member list by the values in another list. It does this by making a multiset, which is implicitly sorted, and then making the map back into a list.

Definition at line 253 of file PList.cpp.

{
    //This is the map that the variant pairs will be put into
    multimap<Variant, Variant> sortMap;
 
    //Iterators for the key/data lists.  Woe to he who allows
    //these to be of different sizes.
    std::vector<Variant>::const_iterator keyIterator  = key.Begin();
    std::vector<Variant>::const_iterator dataIterator = Begin();
 
    //Go through the entire data list, inserting pairs into the map.
    while(dataIterator != End())
        {
            sortMap.insert( pair<Variant,Variant>(*keyIterator, *dataIterator));
            keyIterator++;     //move through both lists.
            dataIterator++;
        }
 
 
    //Now, sortmap should be in order of keyIterator. Make
    //a new PList to put the data in.
    PList * newList = new PList();
 
    multimap<Variant, Variant>::iterator i=sortMap.begin();
 
    while(i != sortMap.end())
        {
            newList->PushBack(i->second);
            i++;
        }
    return counted_ptr<PEBLObjectBase>(newList);
}

References Begin(), End(), PList(), and PushBack().

Referenced by PEBLList::Shuffle(), PEBLList::Sort(), and PEBLList::SortBy().

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		const PList &	pcd
	)

friend

Definition at line 293 of file PList.cpp.

{
    list.SendToStream(out);
    return out;
}

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PList() [1/3]

◆ PList() [2/3]

◆ ~PList()

◆ PList() [3/3]

Member Function Documentation

◆ Begin() [1/2]

◆ Begin() [2/2]

◆ Clear()

◆ Clone()

◆ End() [1/2]

◆ End() [2/2]

◆ First()

◆ GetList()

◆ IsEmpty()

◆ IsMember()

◆ Last()

◆ Length()

◆ Nth()

◆ PopBack()

◆ PushBack()

◆ Rest()

◆ SendToStream()

◆ SetElement()

◆ SortBy()

Friends And Related Symbol Documentation

◆ operator<<