Style Guide¶
Naming Styles¶
Class Static Members¶
Camel case names starting with lower case and preceded by a s_
e.g. s_staticMember
Class Members¶
Camel case names starting with lower case and preceded by a m_
e.g. m_classMember
Model Parameters¶
A subset of class members specifically referring to settable model parameters.
Engineering reference model parameters are preceded by mp_
, K
is used for gains, T
for time constants, R
for resistances, X
for impedances, and others are used as appropriate, typically using a capital letter first followed by a number of other lower case letters.
e.g. mp_K1
, mp_T3
, mp_Rs
Function Arguments¶
Camel case starting with lower case
e.g. functionName(type functionArgument1, type2 functionArgument2)