reference

This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.

ofAbstractParameter Class Referenceabstract

Base class for ofParameter, ofReadOnlyParameter and ofParameterGroup. More...

#include <ofParameter.h>

Inheritance diagram for ofAbstractParameter:
ofParameter< glm::vec3 > ofParameter< glm::quat > ofParameter< ParameterType > ofParameter< void > ofParameterGroup ofReadOnlyParameter< ParameterType, Friend >

Public Member Functions

virtual ~ofAbstractParameter ()
 
virtual std::string getName () const =0
 
virtual void setName (const std::string &name)=0
 
virtual std::string toString () const =0
 
virtual void fromString (const std::string &str)=0
 
virtual std::string type () const
 
virtual std::string getEscapedName () const
 
virtual std::string valueType () const =0
 
virtual void setParent (ofParameterGroup &_parent)=0
 
std::vector< std::string > getGroupHierarchyNames () const
 
template<typename ParameterType >
ofParameter< ParameterType > & cast ()
 
template<typename ParameterType >
const ofParameter< ParameterType > & cast () const
 
template<typename ParameterType , typename Friend >
ofReadOnlyParameter< ParameterType, Friend > & castReadOnly ()
 
template<typename ParameterType , typename Friend >
const ofReadOnlyParameter< ParameterType, Friend > & castReadOnly () const
 
ofParameterGroupcastGroup ()
 
const ofParameterGroupcastGroup () const
 
virtual bool isSerializable () const =0
 
virtual bool isReadOnly () const =0
 
virtual std::shared_ptr< ofAbstractParameternewReference () const =0
 
virtual bool isReferenceTo (const ofAbstractParameter &other) const
 

Protected Member Functions

virtual const ofParameterGroup getFirstParent () const =0
 
virtual void setSerializable (bool serializable)=0
 
virtual std::string escape (const std::string &str) const
 
virtual const void * getInternalObject () const =0
 

Friends

std::ostream & operator<< (std::ostream &os, const ofAbstractParameter &p)
 
std::istream & operator>> (std::istream &is, ofAbstractParameter &p)
 

Detailed Description

Constructor & Destructor Documentation

◆ ~ofAbstractParameter()

virtual ofAbstractParameter::~ofAbstractParameter ( )
inlinevirtual

Member Function Documentation

◆ cast() [1/2]

template<typename ParameterType >
ofParameter< ParameterType > & ofAbstractParameter::cast ( )
inline

◆ cast() [2/2]

template<typename ParameterType >
const ofParameter< ParameterType > & ofAbstractParameter::cast ( ) const
inline

◆ castGroup() [1/2]

ofParameterGroup & ofAbstractParameter::castGroup ( )

◆ castGroup() [2/2]

const ofParameterGroup & ofAbstractParameter::castGroup ( ) const

◆ castReadOnly() [1/2]

template<typename ParameterType , typename Friend >
ofReadOnlyParameter< ParameterType, Friend > & ofAbstractParameter::castReadOnly ( )
inline

◆ castReadOnly() [2/2]

template<typename ParameterType , typename Friend >
const ofReadOnlyParameter< ParameterType, Friend > & ofAbstractParameter::castReadOnly ( ) const
inline

◆ escape()

string ofAbstractParameter::escape ( const std::string &  str) const
protectedvirtual

◆ fromString()

virtual void ofAbstractParameter::fromString ( const std::string &  str)
pure virtual

◆ getEscapedName()

string ofAbstractParameter::getEscapedName ( ) const
virtual

Reimplemented in ofParameterGroup.

◆ getFirstParent()

virtual const ofParameterGroup ofAbstractParameter::getFirstParent ( ) const
protectedpure virtual

◆ getGroupHierarchyNames()

std::vector< string > ofAbstractParameter::getGroupHierarchyNames ( ) const

◆ getInternalObject()

virtual const void * ofAbstractParameter::getInternalObject ( ) const
protectedpure virtual

◆ getName()

virtual std::string ofAbstractParameter::getName ( ) const
pure virtual

◆ isReadOnly()

◆ isReferenceTo()

bool ofAbstractParameter::isReferenceTo ( const ofAbstractParameter other) const
virtual

◆ isSerializable()

virtual bool ofAbstractParameter::isSerializable ( ) const
pure virtual

◆ newReference()

virtual std::shared_ptr< ofAbstractParameter > ofAbstractParameter::newReference ( ) const
pure virtual

◆ setName()

virtual void ofAbstractParameter::setName ( const std::string &  name)
pure virtual

◆ setParent()

◆ setSerializable()

virtual void ofAbstractParameter::setSerializable ( bool  serializable)
protectedpure virtual

◆ toString()

virtual std::string ofAbstractParameter::toString ( ) const
pure virtual

◆ type()

string ofAbstractParameter::type ( ) const
virtual

◆ valueType()

virtual std::string ofAbstractParameter::valueType ( ) const
pure virtual

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const ofAbstractParameter p 
)
friend

◆ operator>>

std::istream & operator>> ( std::istream &  is,
ofAbstractParameter p 
)
friend

The documentation for this class was generated from the following files:
  • /Users/icq4ever/Desktop/oF0120/libs/openFrameworks/types/ofParameter.h
  • /Users/icq4ever/Desktop/oF0120/libs/openFrameworks/types/ofParameter.cpp