PCustomObject Class Reference

This class simply represent an abstract text-based object. More...

#include <PCustomObject.h>

Inheritance diagram for PCustomObject:

Public Member Functions
	PCustomObject ()
	PCustomObject (const std::string &text)
	PCustomObject (PCustomObject &object)
virtual	~PCustomObject ()
virtual bool	SetProperty (std::string, Variant v)
virtual Variant	GetProperty (std::string) const
virtual ObjectValidationError	ValidateProperty (std::string, Variant v) const
virtual ObjectValidationError	ValidateProperty (std::string) const
std::list< std::string >	GetObjectOrder ()
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)
Variant	GetProperty (std::string) const
ComplexDataType	GetType ()

Protected Member Functions
virtual std::ostream &	SendToStream (std::ostream &out) const
	This sends the color descriptions to the specified stream.
virtual std::string	ObjectName () const
virtual std::ostream &	PrintProperties (std::ostream &out)
virtual Variant	GetPropertyList ()

Protected Attributes
std::string	mName
std::list< std::string >	mObjectOrder
Protected Attributes inherited from PEBLObjectBase
ComplexDataType	mCDT
std::map< std::string, Variant >	mProperties

Detailed Description

This class simply represent an abstract text-based object.

Definition at line 36 of file PCustomObject.h.

Constructor & Destructor Documentation

PCustomObject() [1/3]

PCustomObject::PCustomObject

(

)

Definition at line 37 of file PCustomObject.cpp.

                            :
    PEBLObjectBase(CDT_CUSTOMOBJECT),
    mName("Unknown Custom Object")
{
 
 
}

PCustomObject() [2/3]

PCustomObject::PCustomObject

(

const std::string &

text

)

Definition at line 47 of file PCustomObject.cpp.

                                                  :
    PEBLObjectBase(CDT_CUSTOMOBJECT),
    mName(name)
{
 
}

PCustomObject() [3/3]

PCustomObject::PCustomObject

(

PCustomObject &

object

)

Definition at line 55 of file PCustomObject.cpp.

                                                  :
    PEBLObjectBase(object)
 
{
 
}

~PCustomObject()

PCustomObject::~PCustomObject ( )

virtual

Definition at line 63 of file PCustomObject.cpp.

{
    mProperties.clear();
}

References PEBLObjectBase::mProperties.

Member Function Documentation

GetObjectOrder()

std::list< std::string > PCustomObject::GetObjectOrder ( )

inline

Definition at line 50 of file PCustomObject.h.

{return mObjectOrder;};

References mObjectOrder.

GetProperty()

Variant PCustomObject::GetProperty ( std::string  name ) const

virtual

Definition at line 87 of file PCustomObject.cpp.

{
    std::string uname = PEBLUtility::ToUpper(name);
    return PEBLObjectBase::GetProperty(uname);
}

References PEBLObjectBase::GetProperty(), and PEBLUtility::ToUpper().

Referenced by Evaluator::CallFunction(), Evaluator::Evaluate1(), and PrintProperties().

GetPropertyList()

Variant PCustomObject::GetPropertyList ( )

protectedvirtual

Reimplemented from PEBLObjectBase.

Definition at line 145 of file PCustomObject.cpp.

{
 
  PList * returnList = new PList();
 
    for(std::list<std::string>::iterator i = mObjectOrder.begin(); i != mObjectOrder.end(); ++i)
    {
      returnList->PushBack(Variant(*i));
    }
 
    counted_ptr<PEBLObjectBase> tmpObj = counted_ptr<PEBLObjectBase>(returnList);
    PComplexData * tmpPCD= (new PComplexData(tmpObj));
    Variant tmp = Variant(tmpPCD);
    delete tmpPCD;
    tmpPCD=NULL;
    return tmp;
}

References mObjectOrder, NULL, and PList::PushBack().

ObjectName()

std::string PCustomObject::ObjectName ( ) const

protectedvirtual

Reimplemented from PEBLObjectBase.

Definition at line 118 of file PCustomObject.cpp.

{
    return mName;
}

References mName.

Referenced by SendToStream().

PrintProperties()

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

protectedvirtual

Reimplemented from PEBLObjectBase.

Definition at line 124 of file PCustomObject.cpp.

{
    out << "----------\n";
    for(std::list<std::string>::iterator i = mObjectOrder.begin(); i != mObjectOrder.end(); ++i)
    {
        std::string name = (*i);
        std::string uname = PEBLUtility::ToUpper(name);
 
        out << "[" << name << "]: " <<  GetProperty(uname) << endl;
 
    }
    out << "----------\n";
 
 
    return out;
 
}

References GetProperty(), mObjectOrder, and PEBLUtility::ToUpper().

SendToStream()

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

protectedvirtual

This sends the color descriptions to the specified stream.

Reimplemented from PEBLObjectBase.

Definition at line 111 of file PCustomObject.cpp.

{
    out << ObjectName()<< std::flush;
    return out;
}

References ObjectName().

SetProperty()

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

virtual

Reimplemented from PEBLObjectBase.

Definition at line 69 of file PCustomObject.cpp.

{
    //We won't do any validation here.  Maybe in the future
    //some validation could be done here; allowing the usere
    //to specify things like value type, or a subset of values.
    std::string uname = PEBLUtility::ToUpper(name);
    bool newname = (mProperties.find(uname) == mProperties.end());
 
    mProperties[uname]=v;
 
    if(newname){
      mObjectOrder.push_back(std::string(name));
    }
 
    return true;
}

References mObjectOrder, PEBLObjectBase::mProperties, and PEBLUtility::ToUpper().

Referenced by PEBLUtility::ExtractJSONObject().

ValidateProperty() [1/2]

ObjectValidationError PCustomObject::ValidateProperty ( std::string  name ) const

virtual

Reimplemented from PEBLObjectBase.

Definition at line 99 of file PCustomObject.cpp.

{
   ObjectValidationError ove = PEBLObjectBase::ValidateProperty(name);
    if(ove == OVE_VALID)
        return ove;
    else
        return OVE_INVALID_PROPERTY_NAME;
 
}

References OVE_INVALID_PROPERTY_NAME, OVE_VALID, and PEBLObjectBase::ValidateProperty().

ValidateProperty() [2/2]

ObjectValidationError PCustomObject::ValidateProperty ( std::string  name, Variant  v  ) const

virtual

Reimplemented from PEBLObjectBase.

Definition at line 94 of file PCustomObject.cpp.

{
    return ValidateProperty(name);
}

References ValidateProperty().

Referenced by Evaluator::CallFunction(), Evaluator::Evaluate1(), and ValidateProperty().

Member Data Documentation

mName

std::string PCustomObject::mName

protected

Definition at line 57 of file PCustomObject.h.

Referenced by ObjectName().

mObjectOrder

std::list<std::string> PCustomObject::mObjectOrder

protected

Definition at line 58 of file PCustomObject.h.

Referenced by GetObjectOrder(), GetPropertyList(), PrintProperties(), and SetProperty().

---

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

• PCustomObject.h
• PCustomObject.cpp