Eclipse SUMO - Simulation of Urban MObility
GNEAttributeCarrier::AttributeProperties Class Reference

struct with the attribute Properties More...

#include <GNEAttributeCarrier.h>

Collaboration diagram for GNEAttributeCarrier::AttributeProperties:

Public Member Functions

 AttributeProperties ()
 default constructor More...
 
 AttributeProperties (const SumoXMLAttr attribute, const int attributeProperty, const std::string &definition, std::string defaultValue="")
 parameter constructor More...
 
bool cannotBeZero () const
 return true if atribute cannot be zero More...
 
void checkAttributeIntegrity ()
 check Attribute integrity (For example, throw an exception if tag has a Float default value, but given default value cannot be parse to float) More...
 
SumoXMLAttr getAttr () const
 get XML Attribute More...
 
const std::string & getAttrStr () const
 get XML Attribute More...
 
SumoXMLAttr getAttrSynonym () const
 get tag synonym More...
 
const std::string & getDefaultValue () const
 get default value More...
 
const std::string & getDefinition () const
 get default value More...
 
std::string getDescription () const
 return a description of attribute More...
 
const std::vector< std::string > & getDiscreteValues () const
 get discrete values More...
 
double getMaximumRange () const
 get maximum range More...
 
double getMinimumRange () const
 get minimum range More...
 
int getPositionListed () const
 get position in list (used in frames for listing attributes with certain sort) More...
 
const TagPropertiesgetTagPropertyParent () const
 get reference to tagProperty parent More...
 
bool hasAttrRange () const
 return true if Attr correspond to an element that only accept a range of values More...
 
bool hasAttrSynonym () const
 return true if Attr correspond to an element that will be written in XML with another name More...
 
bool hasMutableDefaultValue () const
 return true if attribute owns a mutable default value More...
 
bool hasStaticDefaultValue () const
 return true if attribute owns a static default value More...
 
bool isBool () const
 return true if atribute is boolean More...
 
bool isColor () const
 return true if atribute is a color More...
 
bool isCombinable () const
 return true if atribute is combinable with other Attribute More...
 
bool isComplex () const
 return true if atribute is complex More...
 
bool isDiscrete () const
 return true if atribute is discrete More...
 
bool isEnablitable () const
 return true if atribute is enablitable More...
 
bool isExtended () const
 return true if atribute is extended More...
 
bool isFilename () const
 return true if atribute is a filename More...
 
bool isFloat () const
 return true if atribute is a float More...
 
bool isInt () const
 return true if atribute is an integer More...
 
bool isList () const
 return true if atribute is a list More...
 
bool isNonEditable () const
 return true if atribute isn't editable More...
 
bool isNumerical () const
 return true if atribute is numerical (int or float) More...
 
bool isOptional () const
 return true if atribute is optional More...
 
bool isposition () const
 return true if atribute is a position More...
 
bool isPositive () const
 return true if atribute is positive More...
 
bool isProbability () const
 return true if atribute is a probability More...
 
bool isSecuential () const
 return true if atribute is sequential More...
 
bool isString () const
 return true if atribute is a string More...
 
bool isSUMOTime () const
 return true if atribute is a SUMOTime More...
 
bool isSVCPermission () const
 return true if atribute is a VehicleClass More...
 
bool isUnique () const
 return true if atribute is unique More...
 
bool isVClass () const
 return true if atribute is a VehicleClass More...
 
bool isWriteXMLOptional () const
 return true if atribute is write XML optional More...
 
bool requiereUpdateGeometry () const
 return true if atribute requieres a update geometry in setAttribute(...) More...
 
void setDiscreteValues (const std::vector< std::string > &discreteValues)
 set discrete values More...
 
void setRange (const double minimum, const double maximum)
 set range More...
 
void setSynonym (const SumoXMLAttr synonym)
 set synonim More...
 
void setTagPropertyParent (TagProperties *tagPropertyParent)
 set tag property parent More...
 
 ~AttributeProperties ()
 destructor More...
 

Private Attributes

SumoXMLAttr myAttribute
 XML Attribute. More...
 
int myAttributeProperty
 Property of attribute. More...
 
std::string myAttrStr
 string with the Attribute in text format (to avoid unnecesaries toStrings(...) calls) More...
 
SumoXMLAttr myAttrSynonym
 Attribute written in XML (If is SUMO_ATTR_NOTHING), original Attribute will be written) More...
 
std::string myDefaultValue
 default value (by default empty) More...
 
std::string myDefinition
 text with a definition of attribute More...
 
std::vector< std::string > myDiscreteValues
 discrete values that can take this Attribute (by default empty) More...
 
double myMaximumRange
 maxium Range More...
 
double myMinimumRange
 minimun Range More...
 
TagPropertiesmyTagPropertyParent
 pointer to tagProperty parent More...
 

Detailed Description

struct with the attribute Properties

Definition at line 99 of file GNEAttributeCarrier.h.

Constructor & Destructor Documentation

◆ AttributeProperties() [1/2]

GNEAttributeCarrier::AttributeProperties::AttributeProperties ( )

default constructor

Definition at line 58 of file GNEAttributeCarrier.cpp.

◆ AttributeProperties() [2/2]

GNEAttributeCarrier::AttributeProperties::AttributeProperties ( const SumoXMLAttr  attribute,
const int  attributeProperty,
const std::string &  definition,
std::string  defaultValue = "" 
)

◆ ~AttributeProperties()

GNEAttributeCarrier::AttributeProperties::~AttributeProperties ( )

destructor

Definition at line 99 of file GNEAttributeCarrier.cpp.

Member Function Documentation

◆ cannotBeZero()

bool GNEAttributeCarrier::AttributeProperties::cannotBeZero ( ) const

return true if atribute cannot be zero

Definition at line 392 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_NOTZERO.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ checkAttributeIntegrity()

void GNEAttributeCarrier::AttributeProperties::checkAttributeIntegrity ( )

check Attribute integrity (For example, throw an exception if tag has a Float default value, but given default value cannot be parse to float)

Definition at line 103 of file GNEAttributeCarrier.cpp.

References SUMO_ATTR_NOTHING.

◆ getAttr()

◆ getAttrStr()

const std::string & GNEAttributeCarrier::AttributeProperties::getAttrStr ( ) const

◆ getAttrSynonym()

SumoXMLAttr GNEAttributeCarrier::AttributeProperties::getAttrSynonym ( ) const

get tag synonym

Definition at line 285 of file GNEAttributeCarrier.cpp.

◆ getDefaultValue()

const std::string & GNEAttributeCarrier::AttributeProperties::getDefaultValue ( ) const

get default value

Definition at line 200 of file GNEAttributeCarrier.cpp.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ getDefinition()

const std::string & GNEAttributeCarrier::AttributeProperties::getDefinition ( ) const

get default value

Definition at line 194 of file GNEAttributeCarrier.cpp.

◆ getDescription()

◆ getDiscreteValues()

const std::vector< std::string > & GNEAttributeCarrier::AttributeProperties::getDiscreteValues ( ) const

◆ getMaximumRange()

double GNEAttributeCarrier::AttributeProperties::getMaximumRange ( ) const

get maximum range

Definition at line 305 of file GNEAttributeCarrier.cpp.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ getMinimumRange()

double GNEAttributeCarrier::AttributeProperties::getMinimumRange ( ) const

get minimum range

Definition at line 295 of file GNEAttributeCarrier.cpp.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ getPositionListed()

int GNEAttributeCarrier::AttributeProperties::getPositionListed ( ) const

get position in list (used in frames for listing attributes with certain sort)

Definition at line 183 of file GNEAttributeCarrier.cpp.

◆ getTagPropertyParent()

const GNEAttributeCarrier::TagProperties & GNEAttributeCarrier::AttributeProperties::getTagPropertyParent ( ) const

get reference to tagProperty parent

Definition at line 177 of file GNEAttributeCarrier.cpp.

Referenced by GNEFrameAttributesModuls::AttributesEditorRow::AttributesEditorRow().

◆ hasAttrRange()

bool GNEAttributeCarrier::AttributeProperties::hasAttrRange ( ) const

return true if Attr correspond to an element that only accept a range of values

Definition at line 332 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_RANGE.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ hasAttrSynonym()

bool GNEAttributeCarrier::AttributeProperties::hasAttrSynonym ( ) const

return true if Attr correspond to an element that will be written in XML with another name

Definition at line 327 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_SYNONYM.

◆ hasMutableDefaultValue()

bool GNEAttributeCarrier::AttributeProperties::hasMutableDefaultValue ( ) const

return true if attribute owns a mutable default value

Definition at line 321 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_DEFAULTVALUEMUTABLE.

◆ hasStaticDefaultValue()

bool GNEAttributeCarrier::AttributeProperties::hasStaticDefaultValue ( ) const

return true if attribute owns a static default value

Definition at line 315 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_DEFAULTVALUESTATIC.

◆ isBool()

bool GNEAttributeCarrier::AttributeProperties::isBool ( ) const

◆ isColor()

bool GNEAttributeCarrier::AttributeProperties::isColor ( ) const

◆ isCombinable()

bool GNEAttributeCarrier::AttributeProperties::isCombinable ( ) const

return true if atribute is combinable with other Attribute

Definition at line 452 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_COMBINABLE.

Referenced by GNEFrameAttributesModuls::AttributesEditorRow::AttributesEditorRow().

◆ isComplex()

bool GNEAttributeCarrier::AttributeProperties::isComplex ( ) const

return true if atribute is complex

Definition at line 482 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_COMPLEX.

◆ isDiscrete()

bool GNEAttributeCarrier::AttributeProperties::isDiscrete ( ) const

◆ isEnablitable()

bool GNEAttributeCarrier::AttributeProperties::isEnablitable ( ) const

return true if atribute is enablitable

Definition at line 488 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_ENABLITABLE.

Referenced by GNEFrameAttributesModuls::AttributesEditorRow::AttributesEditorRow().

◆ isExtended()

bool GNEAttributeCarrier::AttributeProperties::isExtended ( ) const

return true if atribute is extended

Definition at line 464 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_EXTENDED.

◆ isFilename()

bool GNEAttributeCarrier::AttributeProperties::isFilename ( ) const

return true if atribute is a filename

Definition at line 404 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_FILENAME.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ isFloat()

bool GNEAttributeCarrier::AttributeProperties::isFloat ( ) const

◆ isInt()

bool GNEAttributeCarrier::AttributeProperties::isInt ( ) const

◆ isList()

bool GNEAttributeCarrier::AttributeProperties::isList ( ) const

return true if atribute is a list

Definition at line 422 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_LIST.

Referenced by GNEAttributeCarrier::checkParsedAttribute(), and GNENet::replaceInListAttribute().

◆ isNonEditable()

bool GNEAttributeCarrier::AttributeProperties::isNonEditable ( ) const

return true if atribute isn't editable

Definition at line 458 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_NONEDITABLE.

Referenced by GNEFrameAttributesModuls::AttributesEditorRow::AttributesEditorRow().

◆ isNumerical()

bool GNEAttributeCarrier::AttributeProperties::isNumerical ( ) const

return true if atribute is numerical (int or float)

Definition at line 380 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_FLOAT, GNEAttributeCarrier::ATTRPROPERTY_INT, and GNEAttributeCarrier::ATTRPROPERTY_SUMOTIME.

◆ isOptional()

bool GNEAttributeCarrier::AttributeProperties::isOptional ( ) const

return true if atribute is optional

Definition at line 476 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_OPTIONAL.

Referenced by GNEFrameAttributesModuls::AttributesEditorRow::AttributesEditorRow().

◆ isposition()

bool GNEAttributeCarrier::AttributeProperties::isposition ( ) const

return true if atribute is a position

Definition at line 368 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_POSITION.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ isPositive()

bool GNEAttributeCarrier::AttributeProperties::isPositive ( ) const

return true if atribute is positive

Definition at line 386 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_POSITIVE.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ isProbability()

bool GNEAttributeCarrier::AttributeProperties::isProbability ( ) const

return true if atribute is a probability

Definition at line 374 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_PROBABILITY.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ isSecuential()

bool GNEAttributeCarrier::AttributeProperties::isSecuential ( ) const

return true if atribute is sequential

Definition at line 428 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_SECUENCIAL.

◆ isString()

bool GNEAttributeCarrier::AttributeProperties::isString ( ) const

return true if atribute is a string

Definition at line 362 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_STRING.

◆ isSUMOTime()

bool GNEAttributeCarrier::AttributeProperties::isSUMOTime ( ) const

◆ isSVCPermission()

bool GNEAttributeCarrier::AttributeProperties::isSVCPermission ( ) const

return true if atribute is a VehicleClass

Definition at line 416 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_LIST, and GNEAttributeCarrier::ATTRPROPERTY_VCLASS.

◆ isUnique()

bool GNEAttributeCarrier::AttributeProperties::isUnique ( ) const

return true if atribute is unique

Definition at line 434 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_UNIQUE.

◆ isVClass()

bool GNEAttributeCarrier::AttributeProperties::isVClass ( ) const

return true if atribute is a VehicleClass

Definition at line 410 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_VCLASS.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ isWriteXMLOptional()

bool GNEAttributeCarrier::AttributeProperties::isWriteXMLOptional ( ) const

return true if atribute is write XML optional

Definition at line 440 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_WRITEXMLOPTIONAL.

Referenced by GNEAttributeCarrier::checkParsedAttribute().

◆ requiereUpdateGeometry()

bool GNEAttributeCarrier::AttributeProperties::requiereUpdateGeometry ( ) const

return true if atribute requieres a update geometry in setAttribute(...)

Definition at line 470 of file GNEAttributeCarrier.cpp.

References GNEAttributeCarrier::ATTRPROPERTY_UPDATEGEOMETRY.

Referenced by GNEChange_Attribute::redo(), and GNEChange_Attribute::undo().

◆ setDiscreteValues()

void GNEAttributeCarrier::AttributeProperties::setDiscreteValues ( const std::vector< std::string > &  discreteValues)

◆ setRange()

void GNEAttributeCarrier::AttributeProperties::setRange ( const double  minimum,
const double  maximum 
)

◆ setSynonym()

void GNEAttributeCarrier::AttributeProperties::setSynonym ( const SumoXMLAttr  synonym)

set synonim

Definition at line 138 of file GNEAttributeCarrier.cpp.

Referenced by GNEAttributeCarrier::fillAdditionals().

◆ setTagPropertyParent()

void GNEAttributeCarrier::AttributeProperties::setTagPropertyParent ( TagProperties tagPropertyParent)

set tag property parent

Definition at line 159 of file GNEAttributeCarrier.cpp.

Field Documentation

◆ myAttribute

SumoXMLAttr GNEAttributeCarrier::AttributeProperties::myAttribute
private

XML Attribute.

Definition at line 251 of file GNEAttributeCarrier.h.

◆ myAttributeProperty

int GNEAttributeCarrier::AttributeProperties::myAttributeProperty
private

Property of attribute.

Definition at line 260 of file GNEAttributeCarrier.h.

◆ myAttrStr

std::string GNEAttributeCarrier::AttributeProperties::myAttrStr
private

string with the Attribute in text format (to avoid unnecesaries toStrings(...) calls)

Definition at line 257 of file GNEAttributeCarrier.h.

◆ myAttrSynonym

SumoXMLAttr GNEAttributeCarrier::AttributeProperties::myAttrSynonym
private

Attribute written in XML (If is SUMO_ATTR_NOTHING), original Attribute will be written)

Definition at line 272 of file GNEAttributeCarrier.h.

◆ myDefaultValue

std::string GNEAttributeCarrier::AttributeProperties::myDefaultValue
private

default value (by default empty)

Definition at line 266 of file GNEAttributeCarrier.h.

◆ myDefinition

std::string GNEAttributeCarrier::AttributeProperties::myDefinition
private

text with a definition of attribute

Definition at line 263 of file GNEAttributeCarrier.h.

◆ myDiscreteValues

std::vector<std::string> GNEAttributeCarrier::AttributeProperties::myDiscreteValues
private

discrete values that can take this Attribute (by default empty)

Definition at line 269 of file GNEAttributeCarrier.h.

◆ myMaximumRange

double GNEAttributeCarrier::AttributeProperties::myMaximumRange
private

maxium Range

Definition at line 278 of file GNEAttributeCarrier.h.

◆ myMinimumRange

double GNEAttributeCarrier::AttributeProperties::myMinimumRange
private

minimun Range

Definition at line 275 of file GNEAttributeCarrier.h.

◆ myTagPropertyParent

TagProperties* GNEAttributeCarrier::AttributeProperties::myTagPropertyParent
private

pointer to tagProperty parent

Definition at line 254 of file GNEAttributeCarrier.h.


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