using doxygen

34 views
Skip to first unread message

Nina

unread,
Aug 27, 2018, 9:25:31 AM8/27/18
to ns-3-users
Hello,

I have trouble finding information using doxygen and I am hoping someone can give some pointers. I want to use ns-3 for wifi simulation. I have read tutorial and Wifi Module Model Library and I have tried searching topics on this group but couldn't find any answers because i think my questions are too general. 

1.My main issue with doxygen are attributes of methods. For example, I am looking at YansWifiChannelHelper class and method AddPropagationLoss:

void ns3::YansWifiChannelHelper::AddPropagationLoss(std::string name,
std::string n0 = "",
const AttributeValue & v0 = EmptyAttributeValue (),
std::string n1 = "",
const AttributeValue & v1 = EmptyAttributeValue (),
std::string n2 = "",
const AttributeValue & v2 = EmptyAttributeValue (),
std::string n3 = "",
const AttributeValue & v3 = EmptyAttributeValue (),
std::string n4 = "",
const AttributeValue & v4 = EmptyAttributeValue (),
std::string n5 = "",
const AttributeValue & v5 = EmptyAttributeValue (),
std::string n6 = "",
const AttributeValue & v6 = EmptyAttributeValue (),
std::string n7 = "",
const AttributeValue & v7 = EmptyAttributeValue () 
)





Parameters
namethe name of the model to add
n0the name of the attribute to set
v0the value of the attribute to set
n1the name of the attribute to set
v1the value of the attribute to set
n2the name of the attribute to set
v2the value of the attribute to set
n3the name of the attribute to set
v3the value of the attribute to set
n4the name of the attribute to set
v4the value of the attribute to set
n5the name of the attribute to set
v5the value of the attribute to set
n6the name of the attribute to set
v6the value of the attribute to set
n7the name of the attribute to set
v7the value of the attribute to set

Where can I see what are my options for models to add? What are all other attributes and their default vaules? 
This is my issue with methods in some other classes as well.
2.When using Building class, what measurement unit do coordinates x,y and z represent  (and where can I find this information)? 
3.When using setBuildingType I know there are three types of building, but where can i see their description?
4.When I am setting external or internal walls type what does have priority - walls in the building type or walls that I set with methods ( setExWallsType)?

In general, I have trouble finding information about using classes and their methods so I feel like I am missing something. I have read source and header files as well but could not find information there either. Can someone please help?

Nina

pdbarnes

unread,
Aug 30, 2018, 10:09:58 AM8/30/18
to ns-3-users
YansWifiChannelHelper is a helper, so it’s going to configure some factories to create the objects needed. One of these is a PropagationLossModel. The Attribute names and legal values will belong to the PropagationLossModel you configure the helper with.

I agree this should be explained better in the documentation.

Peter

Nina

unread,
Sep 5, 2018, 2:18:32 PM9/5/18
to ns-3-users
I understand this now, thank you for your help. 

Nina
Reply all
Reply to author
Forward
0 new messages