Choreonoid  1.8
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
cnoid::MprVariableList Class Reference

#include <MprVariableList.h>

Inheritance diagram for cnoid::MprVariableList:
cnoid::ClonableReferenced cnoid::Referenced

Public Types

enum  VariableType {
  GeneralVariable, IntVariable, DoubleVariable, BoolVariable,
  StringVariable
}
 

Public Member Functions

 MprVariableList ()
 
 MprVariableList (VariableType variableType)
 
 MprVariableList (const MprVariableList &org)
 
 ~MprVariableList ()
 
MprVariableList * clone () const
 
MprVariableList * clone (CloneMap &cloneMap) const
 
MprVariableList & operator= (const MprVariableList &rhs)=delete
 
void setVariableType (VariableType type)
 
void setGeneralVariableValueTypeUnchangeable (bool on)
 
void setNumberIdEnabled (bool on)
 
void setStringIdEnabled (bool on)
 
VariableType variableType () const
 
bool isGeneralVariableValueTypeUnchangeable () const
 
bool isNumberIdEnabled () const
 
bool isStringIdEnabled () const
 
void clear ()
 
int numVariables () const
 
MprVariable * variableAt (int index) const
 
int indexOf (MprVariable *variable) const
 
MprVariable * findVariable (const GeneralId &id) const
 
MprVariable::Value defaultValue () const
 
bool insert (int index, MprVariable *variable)
 
bool append (MprVariable *variable)
 
bool removeAt (int index)
 
SignalProxy< void(int index)> sigVariableAdded ()
 
SignalProxy< void(int index, MprVariable *variable)> sigVariableRemoved ()
 
SignalProxy< void(int index, int flags)> sigVariableUpdated ()
 
bool resetId (MprVariable *variable, const GeneralId &newId)
 
void resetIdCounter ()
 
GeneralId createNextId (int prevId=-1)
 
bool read (const Mapping &archive)
 
bool write (Mapping &archive) const
 
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()
 

Protected Member Functions

 MprVariableList (const MprVariableList &org, CloneMap *cloneMap)
 
virtual Referenced * doClone (CloneMap *cloneMap) const override
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &)
 
int refCount () const
 

Friends

class MprVariable
 

Member Enumeration Documentation

◆ VariableType

Enumerator
GeneralVariable 
IntVariable 
DoubleVariable 
BoolVariable 
StringVariable 

Constructor & Destructor Documentation

◆ MprVariableList() [1/4]

MprVariableList::MprVariableList ( )

◆ MprVariableList() [2/4]

MprVariableList::MprVariableList ( VariableType  variableType)

◆ MprVariableList() [3/4]

MprVariableList::MprVariableList ( const MprVariableList &  org)

◆ ~MprVariableList()

MprVariableList::~MprVariableList ( )

◆ MprVariableList() [4/4]

MprVariableList::MprVariableList ( const MprVariableList &  org,
CloneMap *  cloneMap 
)
protected

Member Function Documentation

◆ append()

bool MprVariableList::append ( MprVariable *  variable)

◆ clear()

void MprVariableList::clear ( )

◆ clone() [1/2]

MprVariableList* cnoid::MprVariableList::clone ( ) const
inline

◆ clone() [2/2]

MprVariableList* cnoid::MprVariableList::clone ( CloneMap &  cloneMap) const
inline

◆ createNextId()

GeneralId MprVariableList::createNextId ( int  prevId = -1)

◆ defaultValue()

MprVariable::Value MprVariableList::defaultValue ( ) const

◆ doClone()

Referenced * MprVariableList::doClone ( CloneMap *  cloneMap) const
overrideprotectedvirtual

◆ findVariable()

MprVariable * MprVariableList::findVariable ( const GeneralId &  id) const

◆ indexOf()

int MprVariableList::indexOf ( MprVariable *  variable) const

◆ insert()

bool MprVariableList::insert ( int  index,
MprVariable *  variable 
)

◆ isGeneralVariableValueTypeUnchangeable()

bool cnoid::MprVariableList::isGeneralVariableValueTypeUnchangeable ( ) const
inline

◆ isNumberIdEnabled()

bool cnoid::MprVariableList::isNumberIdEnabled ( ) const
inline

◆ isStringIdEnabled()

bool cnoid::MprVariableList::isStringIdEnabled ( ) const
inline

◆ numVariables()

int MprVariableList::numVariables ( ) const

◆ operator=()

MprVariableList& cnoid::MprVariableList::operator= ( const MprVariableList &  rhs)
delete

◆ read()

bool MprVariableList::read ( const Mapping &  archive)

◆ removeAt()

bool MprVariableList::removeAt ( int  index)

◆ resetId()

bool MprVariableList::resetId ( MprVariable *  variable,
const GeneralId &  newId 
)
Returns
true if the id is successfully changed. false if the id is not changed because anther coordinate frame with the same id is exists.

◆ resetIdCounter()

void MprVariableList::resetIdCounter ( )

◆ setGeneralVariableValueTypeUnchangeable()

void MprVariableList::setGeneralVariableValueTypeUnchangeable ( bool  on)

◆ setNumberIdEnabled()

void MprVariableList::setNumberIdEnabled ( bool  on)

◆ setStringIdEnabled()

void MprVariableList::setStringIdEnabled ( bool  on)

◆ setVariableType()

void MprVariableList::setVariableType ( VariableType  type)

◆ sigVariableAdded()

SignalProxy< void(int index)> MprVariableList::sigVariableAdded ( )

◆ sigVariableRemoved()

SignalProxy< void(int index, MprVariable *variable)> MprVariableList::sigVariableRemoved ( )

◆ sigVariableUpdated()

SignalProxy< void(int index, int flags)> MprVariableList::sigVariableUpdated ( )

◆ variableAt()

MprVariable * MprVariableList::variableAt ( int  index) const

◆ variableType()

VariableType cnoid::MprVariableList::variableType ( ) const
inline

◆ write()

bool MprVariableList::write ( Mapping &  archive) const

Friends And Related Function Documentation

◆ MprVariable

friend class MprVariable
friend

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