iSpike  2.1
Spike conversion library for robotics
ispike::Property Class Reference

#include <Property.hpp>

List of all members.

Public Types

enum  ValueType {
  Integer, Double, String, Combo,
  Undefined
}

Public Member Functions

 Property ()
 Property (ValueType type, int value, string name, string description, bool readOnly)
 Property (ValueType type, double value, string name, string description, bool readOnly)
 Property (string value, string name, string description, bool readOnly)
 Property (string value, vector< string > options, string name, string description, bool readOnly)
 Property (const Property &prop)
virtual ~Property ()
Propertyoperator= (const Property &rhs)
virtual string toString ()
ValueType getType ()
string getName ()
string getDescription ()
bool isReadOnly ()
int getInt ()
void setInt (int newInt)
double getDouble ()
void setDouble (double newDouble)
string getString ()
void setString (string newString)
vector< string > getOptions ()
void setOptions (vector< string > options)

Detailed Description

Describes a general Channel, Reader or Writer Property Information that is stored depends on the type.

Definition at line 14 of file Property.hpp.


Member Enumeration Documentation

Enumerator:
Integer 
Double 
String 
Combo 
Undefined 

Definition at line 16 of file Property.hpp.


Constructor & Destructor Documentation

Empty constructor

Definition at line 10 of file Property.cpp.

Property::Property ( ValueType  type,
int  value,
string  name,
string  description,
bool  readOnly 
)

Integer property constructor - avoids confusion between double and integer.

Definition at line 23 of file Property.cpp.

Property::Property ( ValueType  type,
double  value,
string  name,
string  description,
bool  readOnly 
)

Double property constructor - avoids confusion between double and integer.

Definition at line 43 of file Property.cpp.

Property::Property ( string  value,
string  name,
string  description,
bool  readOnly 
)

String property constructor

Definition at line 63 of file Property.cpp.

Property::Property ( string  value,
vector< string >  options,
string  name,
string  description,
bool  readOnly 
)

Combo property constructor

Definition at line 76 of file Property.cpp.

Property::Property ( const Property prop)

Property copy constructor

Definition at line 90 of file Property.cpp.

Property::~Property ( ) [virtual]

Property destructor

Definition at line 103 of file Property.cpp.


Member Function Documentation

string ispike::Property::getDescription ( ) [inline]

Definition at line 47 of file Property.hpp.

double Property::getDouble ( )

Definition at line 142 of file Property.cpp.

Definition at line 130 of file Property.cpp.

string ispike::Property::getName ( ) [inline]

Definition at line 46 of file Property.hpp.

vector< string > Property::getOptions ( )

Definition at line 166 of file Property.cpp.

string Property::getString ( )

Definition at line 154 of file Property.cpp.

Definition at line 45 of file Property.hpp.

bool ispike::Property::isReadOnly ( ) [inline]

Definition at line 48 of file Property.hpp.

Property & Property::operator= ( const Property rhs)

Property assignment operator

Definition at line 112 of file Property.cpp.

void Property::setDouble ( double  newDouble)

Definition at line 148 of file Property.cpp.

void Property::setInt ( int  newInt)

Definition at line 136 of file Property.cpp.

void Property::setOptions ( vector< string >  options)

Definition at line 172 of file Property.cpp.

void Property::setString ( string  newString)

Definition at line 160 of file Property.cpp.

virtual string ispike::Property::toString ( ) [inline, virtual]

Definition at line 44 of file Property.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Defines