PEBLObjectBase Class Reference

#include <PEBLObject.h>

Inheritance diagram for PEBLObjectBase:

Public Member Functions
	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
virtual std::ostream &	SendToStream (std::ostream &out) const

Protected Attributes
ComplexDataType	mCDT
std::map< std::string, Variant >	mProperties

Friends
std::ostream &	operator<< (std::ostream &out, const PEBLObjectBase &object)

Detailed Description

Definition at line 72 of file PEBLObject.h.

Constructor & Destructor Documentation

PEBLObjectBase() [1/3]

PEBLObjectBase::PEBLObjectBase

(

)

Standard Constructor.

Definition at line 43 of file PEBLObject.cpp.

{
    mCDT=CDT_UNDEFINED;
}

References CDT_UNDEFINED, and mCDT.

PEBLObjectBase() [2/3]

PEBLObjectBase::PEBLObjectBase

(

ComplexDataType

cdt

)

Standard Constructor.

Definition at line 48 of file PEBLObject.cpp.

{
    mCDT=cdt;
 
}

References mCDT.

PEBLObjectBase() [3/3]

PEBLObjectBase::PEBLObjectBase

(

const PEBLObjectBase &

pob

)

Definition at line 54 of file PEBLObject.cpp.

{
 
}

~PEBLObjectBase()

PEBLObjectBase::~PEBLObjectBase ( )

virtual

Standard Destructor.

Definition at line 60 of file PEBLObject.cpp.

{
    mProperties.clear();
    //  cout << "Deleting pob\n";
}

References mProperties.

Member Function Documentation

GetProperty()

Variant PEBLObjectBase::GetProperty

(

std::string

name

)

const

Definition at line 94 of file PEBLObject.cpp.

{
 
    std::string uname = PEBLUtility::ToUpper(name);
 
 
    ObjectValidationError err = PEBLObjectBase::ValidateProperty(uname);
 
 
 
    if((err == OVE_SUCCESS ) | ( err == OVE_VALID ))
       {
           return mProperties.find(uname)->second;
       }
    else
        {
            PError::SignalFatalError("Attempted to get invalid property [" + name + "] of object.");
        }
    return Variant(0);
}

References mProperties, OVE_SUCCESS, OVE_VALID, PError::SignalFatalError(), PEBLUtility::ToUpper(), and ValidateProperty().

Referenced by PlatformTextBox::Draw(), PlatformWindow::Draw(), PFont::GetBackgroundColorPtr(), PDrawObject::GetColor(), PFont::GetFontColorPtr(), PDrawObject::GetOutlineColor(), PComplexData::GetProperty(), PStream::GetProperty(), PCustomObject::GetProperty(), PDrawObject::GetProperty(), PLine::GetProperty(), PThickLine::GetProperty(), PRectangle::GetProperty(), PSquare::GetProperty(), PEllipse::GetProperty(), PCircle::GetProperty(), PPolygon::GetProperty(), PBezier::GetProperty(), PFont::GetProperty(), PImageBox::GetProperty(), PMovie::GetProperty(), PTextObject::GetProperty(), PWidget::GetProperty(), PWindow::GetProperty(), PlatformEnvironment::GetProperty(), PlatformLabel::RenderText(), PlatformTextBox::RenderText(), PlatformTextBox::SetEditable(), and PlatformTextBox::SetFont().

GetPropertyList()

Variant PEBLObjectBase::GetPropertyList ( )

virtual

Reimplemented in PCustomObject.

Definition at line 190 of file PEBLObject.cpp.

{
 
    //Create a plist to put the properties in
 
    PList * newlist = new PList();
 
 
 
    std::map<std::string, Variant>::const_iterator i;
    i = mProperties.begin();
    while(i != mProperties.end())
        {
            newlist->PushBack(i->first);
            i++;
        }
 
    counted_ptr<PEBLObjectBase> tmpObj;
    tmpObj = counted_ptr<PEBLObjectBase>(newlist);
    PComplexData * tmpPCD = (new PComplexData(tmpObj));
    Variant tmp = Variant(tmpPCD);
    delete tmpPCD;
    tmpPCD=NULL;
    return tmp;
 
}

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

Referenced by PEBLObjects::GetPropertyList().

GetType()

ComplexDataType PEBLObjectBase::GetType ( )

inline

Definition at line 102 of file PEBLObject.h.

{return mCDT;};

References mCDT.

Referenced by PComplexData::GetType().

InitializeProperty()

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

virtual

Definition at line 88 of file PEBLObject.cpp.

{
    mProperties[name]=v;
    return true;
}

References mProperties.

Referenced by PlatformLabel::Draw(), PBezier::PBezier(), PCanvas::PCanvas(), PCanvas::PCanvas(), PCanvas::PCanvas(), PCircle::PCircle(), PColor::PColor(), PColor::PColor(), PColor::PColor(), PDrawObject::PDrawObject(), PEllipse::PEllipse(), PFont::PFont(), PFont::PFont(), PFont::PFont(), PImageBox::PImageBox(), PLabel::PLabel(), PLabel::PLabel(), PLabel::PLabel(), PlatformCanvas::PlatformCanvas(), PlatformLabel::PlatformLabel(), PlatformLabel::PlatformLabel(), PLine::PLine(), PMovie::PMovie(), PNetwork::PNetwork(), PPolygon::PPolygon(), PRectangle::PRectangle(), PSquare::PSquare(), PTextBox::PTextBox(), PTextBox::PTextBox(), PTextBox::PTextBox(), PTextObject::PTextObject(), PTextObject::PTextObject(), PTextObject::PTextObject(), PThickLine::PThickLine(), PWidget::PWidget(), PWidget::PWidget(), PWidget::PWidget(), PWindow::PWindow(), and PlatformLabel::RenderText().

ObjectName()

std::string PEBLObjectBase::ObjectName ( ) const

virtual

Reimplemented in PCanvas, PColor, PCustomObject, PFont, PImageBox, PLabel, PMovie, PTextBox, PTextObject, PWidget, PWindow, PlatformCanvas, PlatformFont, PlatformFont, PlatformImageBox, PlatformLabel, PlatformTextBox, PlatformWindow, PlatformCanvas, PlatformLine, PlatformThickLine, PlatformRectangle, PlatformSquare, PlatformEllipse, PlatformCircle, PlatformPolygon, PlatformBezier, PlatformImageBox, PlatformLabel, PlatformTextBox, and PlatformWindow.

Definition at line 167 of file PEBLObject.cpp.

{
    return "<Unknown PEBLObjectBase>";
}

Referenced by SendToStream().

PrintProperties()

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

virtual

Reimplemented in PCustomObject.

Definition at line 172 of file PEBLObject.cpp.

{
    out << "----------\n";
    std::map<std::string, Variant>::const_iterator i;
    i = mProperties.begin();
    while(i != mProperties.end())
        {
            out << "[" << i->first << "]: " <<  i->second << endl;
            i++;
        }
    out << "----------\n";
 
 
    return out;
 
}

References mProperties.

Referenced by PEBLObjects::PrintProperties().

SendToStream()

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

protectedvirtual

Reimplemented in PList, PJoystick, PNetwork, PParallelPort, PStream, PCanvas, PColor, PCustomObject, PFont, PImageBox, PLabel, PMovie, PTextBox, PTextObject, PWidget, PWindow, PlatformCanvas, PlatformLine, PlatformThickLine, PlatformRectangle, PlatformSquare, PlatformEllipse, PlatformCircle, PlatformPolygon, PlatformBezier, PlatformEnvironment, PlatformFont, PlatformFont, PlatformImageBox, PlatformJoystick, PlatformKeyboard, PlatformLabel, PlatformTextBox, PlatformWidget, PlatformWindow, PlatformAudioOut, PlatformCanvas, PlatformLine, PlatformThickLine, PlatformRectangle, PlatformSquare, PlatformEllipse, PlatformCircle, PlatformPolygon, PlatformBezier, PlatformEnvironment, PlatformFont, PlatformImageBox, PlatformJoystick, PlatformKeyboard, PlatformLabel, PlatformNetwork, PlatformTextBox, PlatformWidget, PlatformWindow, and PDrawObject.

Definition at line 220 of file PEBLObject.cpp.

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

References ObjectName().

SetProperty()

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

virtual

Reimplemented in PlatformCanvas, PlatformLine, PlatformThickLine, PlatformRectangle, PlatformSquare, PlatformEllipse, PlatformCircle, PlatformPolygon, PlatformBezier, PlatformImageBox, PlatformLabel, PlatformTextBox, PlatformWindow, PStream, PCanvas, PColor, PCustomObject, PDrawObject, PLine, PThickLine, PRectangle, PSquare, PEllipse, PCircle, PPolygon, PBezier, PFont, PImageBox, PLabel, PMovie, PTextBox, PTextObject, PWidget, PWindow, PlatformCanvas, PlatformEnvironment, PlatformLabel, PlatformTextBox, and PlatformEnvironment.

Definition at line 67 of file PEBLObject.cpp.

{
 
    ObjectValidationError err = ValidateProperty(name,v);
 
    if(err == OVE_SUCCESS)
        {
            mProperties[name]=v;
            return true;
        }
    else
        {
            Variant msg = Variant("Failing to set property:[") +
                Variant(name)+ Variant("]:[")+v+Variant("]\n");
 
            PError::SignalFatalError(msg);
            return false;
        }
}

References mProperties, OVE_SUCCESS, PError::SignalFatalError(), and ValidateProperty().

Referenced by PlatformTextBox::Draw(), PWidget::Hide(), PDrawObject::SetAA(), PColor::SetAlpha(), PFont::SetAntiAliased(), PWidget::SetBackgroundColor(), PColor::SetBlue(), PCanvas::SetColor(), PDrawObject::SetColor(), PTextObject::SetDirection(), PlatformTextBox::SetEditable(), PThickLine::SetEnds(), PDrawObject::SetFilled(), PlatformLabel::SetFont(), PlatformTextBox::SetFont(), PFont::SetFontFileName(), PFont::SetFontSize(), PFont::SetFontStyle(), PColor::SetGreen(), PWidget::SetHeight(), PlatformCanvas::SetHeight(), PNetwork::SetHostIP(), PNetwork::SetHostName(), PNetwork::SetOpen(), PDrawObject::SetOutlineColor(), PWidget::SetParent(), PMovie::SetPlaybackPosition(), PNetwork::SetPort(), PCanvas::SetPosition(), PImageBox::SetPosition(), PLabel::SetPosition(), PWidget::SetPosition(), PComplexData::SetProperty(), PStream::SetProperty(), PLabel::SetProperty(), PMovie::SetProperty(), PTextBox::SetProperty(), PWidget::SetProperty(), PColor::SetRed(), PWidget::SetRotation(), PImageBox::SetSize(), PMovie::SetSize(), PLine::SetSize(), PRectangle::SetSize(), PEllipse::SetSize(), PCircle::SetSize(), PSquare::SetSize(), PTextObject::SetText(), PThickLine::SetThickness(), PMovie::SetVolume(), PlatformCanvas::SetWidth(), PWidget::SetWidth(), PlatformCanvas::SetZoomX(), PWidget::SetZoomX(), PlatformImageBox::SetZoomX(), PlatformCanvas::SetZoomY(), PWidget::SetZoomY(), PlatformImageBox::SetZoomY(), and PWidget::Show().

ValidateProperty() [1/2]

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

virtual

Reimplemented in PColor, PlatformCanvas, PlatformLine, PlatformThickLine, PlatformRectangle, PlatformSquare, PlatformEllipse, PlatformCircle, PlatformPolygon, PlatformBezier, PlatformImageBox, PlatformLabel, PlatformTextBox, PlatformWindow, PStream, PCanvas, PCustomObject, PDrawObject, PLine, PThickLine, PRectangle, PSquare, PEllipse, PCircle, PPolygon, PBezier, PFont, PImageBox, PLabel, PMovie, PTextBox, PTextObject, PWidget, and PWindow.

Definition at line 123 of file PEBLObject.cpp.

{
 
    std::string uname = PEBLUtility::ToUpper(name);
 
 
#if 0
    cout << "Testing: [" << uname << "]" <<endl;
    cout << "Object is: " << *this << endl;
    cout << "-----------------\n";
 
    std::map<std::string, Variant>::const_iterator i;
    i = mProperties.begin();
    while(i != mProperties.end())
        {
            cout << "[" << i->first << "]: " <<  i->second << endl;
            i++;
        }
    cout << "----------\n";
#endif
 
 
    if(mProperties.find(uname) == mProperties.end())
        {
 
            return OVE_INVALID_PROPERTY_NAME;
        }
    else
        {
 
            return OVE_SUCCESS;
        }
}

References mProperties, OVE_INVALID_PROPERTY_NAME, OVE_SUCCESS, and PEBLUtility::ToUpper().

ValidateProperty() [2/2]

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

virtual

Reimplemented in PColor, PlatformCanvas, PlatformLine, PlatformThickLine, PlatformRectangle, PlatformSquare, PlatformEllipse, PlatformCircle, PlatformPolygon, PlatformBezier, PlatformImageBox, PlatformLabel, PlatformTextBox, PlatformWindow, PStream, PCanvas, PCustomObject, PDrawObject, PLine, PThickLine, PRectangle, PSquare, PEllipse, PCircle, PPolygon, PBezier, PFont, PImageBox, PLabel, PMovie, PTextBox, PTextObject, PWidget, and PWindow.

Definition at line 117 of file PEBLObject.cpp.

{
 
    return ValidateProperty(name);
}

References ValidateProperty().

Referenced by GetProperty(), PComplexData::PropertyExists(), SetProperty(), PColor::ValidateProperty(), PCustomObject::ValidateProperty(), and ValidateProperty().

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  out, const PEBLObjectBase &  object  )

friend

Definition at line 159 of file PEBLObject.cpp.

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

Member Data Documentation

mCDT

ComplexDataType PEBLObjectBase::mCDT

protected

Definition at line 109 of file PEBLObject.h.

Referenced by GetType(), PEBLObjectBase(), PEBLObjectBase(), PFont::PFont(), PFont::PFont(), PFont::PFont(), PJoystick::PJoystick(), PLabel::PLabel(), PLabel::PLabel(), PLabel::PLabel(), PlatformBezier::PlatformBezier(), PlatformCanvas::PlatformCanvas(), PlatformCanvas::PlatformCanvas(), PlatformCanvas::PlatformCanvas(), PlatformCircle::PlatformCircle(), PlatformEllipse::PlatformEllipse(), PlatformImageBox::PlatformImageBox(), PlatformLabel::PlatformLabel(), PlatformLabel::PlatformLabel(), PlatformLine::PlatformLine(), PlatformPolygon::PlatformPolygon(), PlatformRectangle::PlatformRectangle(), PlatformSquare::PlatformSquare(), PlatformTextBox::PlatformTextBox(), PlatformThickLine::PlatformThickLine(), PlatformWindow::PlatformWindow(), PNetwork::PNetwork(), and PParallelPort::PParallelPort().

mProperties

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

protected

Definition at line 112 of file PEBLObject.h.

Referenced by GetProperty(), GetPropertyList(), InitializeProperty(), PrintProperties(), SetProperty(), PCustomObject::SetProperty(), ValidateProperty(), PCustomObject::~PCustomObject(), and ~PEBLObjectBase().

---

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

• PEBLObject.h
• PEBLObject.cpp