inet::utils Namespace Reference

Namespaces
	filters

Functions
std::string	ltostr (long i)
	Converts an integer to string. More...
std::string	dtostr (double d)
	Converts a double to string. More...
double	atod (const char *s)
	Converts string to double. More...
unsigned long	atoul (const char *s)
	Converts string to unsigned long. More...
std::string	stripnonalnum (const char *s)
	Removes non-alphanumeric characters from the given string. More...
std::string	stringf (const char *fmt,...)
	Accepts a printf-like argument list, and returns the result in a string. More...
std::string	vstringf (const char *fmt, va_list &args)
	Accepts a vprintf-like argument list, and returns the result in a string. More...
cObject *	createOneIfClassIsKnown (const char *className, const char *defaultNamespace=getSimulation() ->getContext() ->getClassName())
	Like cObjectFactory::createOneIfClassIsKnown(), except it starts searching for the class in the given namespace. More...
cObject *	createOne (const char *className, const char *defaultNamespace=getSimulation() ->getContext() ->getClassName())
	Like cObjectFactory::createOne(), except it starts searching for the class in the given namespace. More...
int	roundUp (int numToRound, int multiple)
	Rounding up to the nearest multiple of a number. More...
template<typename T >
T *	dupPacketAndControlInfo (T *packet)
	Duplicate a packet together with its control info. More...
cNEDValue	nedf_hasVisualizer (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_hasVisualizer,"bool hasVisualizer()","","Returns true if the visualizer feature is available")
cNEDValue	nedf_hasModule (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_hasModule,"bool hasModule(string nedTypeName)","string","Returns true if the given NED type exists")
cNEDValue	nedf_haveClass (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_haveClass,"bool haveClass(string className)","string","Returns true if the given C++ class exists")
cNEDValue	nedf_moduleListByPath (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_moduleListByPath,"string moduleListByPath(string modulePath,...)","string","Returns a space-separated list of the modules at the given path(s). ""See cTopology::extractByModulePath().")
cNEDValue	nedf_moduleListByNedType (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_moduleListByNedType,"string moduleListByNedType(string nedTypeName,...)","string","Returns a space-separated list of the modules with the given NED type(s). ""See cTopology::extractByNedTypeName().")
cNEDValue	nedf_select (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_select,"any select(int index, ...)","misc","Returns the <index>th item from the rest of the argument list; numbering starts from 0.")
cNEDValue	nedf_absPath (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_absPath,"string absPath(string modulePath)","string","Returns absolute path of given module")
cNEDValue	nedf_firstAvailableOrEmpty (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_firstAvailableOrEmpty,"string firstAvailableOrEmpty(...)","misc","Accepts any number of strings, interprets them as NED type names ""(qualified or unqualified), and returns the first one that exists and ""its C++ implementation class is also available. Returns empty string if ""none of the types are available.")
cNEDValue	nedf_nanToZero (cComponent *context, cNEDValue argv[], int argc)
	Define_NED_Function2 (nedf_nanToZero,"quantity nanToZero(quantity x)","math","Returns the argument if it is not NaN, otherwise returns 0.")

Function Documentation

INET_API double inet::utils::atod

(

const char *

s

)

Converts string to double.

Referenced by inet::REDDropper::initialize(), IndexedImageFigure::parse(), IndicatorLabelFigure::parse(), IndicatorTextFigure::parse(), ProgressMeterFigure::parse(), LinearGaugeFigure::parse(), ThermometerFigure::parse(), CounterFigure::parse(), and GaugeFigure::parse().

{
    char *e;
    double d = ::strtod(s, &e);
    if (*e)
        throw cRuntimeError("Invalid cast: '%s' cannot be interpreted as a double", s);
    return d;
}

INET_API unsigned long inet::utils::atoul

(

const char *

s

)

Converts string to unsigned long.

Referenced by inet::DelegateSignalConfigurator::configureDisplaySignal(), inet::IPv6RoutingTable::configureInterfaceFromXML(), inet::FigureRecorder::init(), and inet::WRRScheduler::initialize().

{
    char *e;
    unsigned long d = ::strtoul(s, &e, 10);
    if (*e)
        throw cRuntimeError("Invalid cast: '%s' cannot be interpreted as an unsigned long", s);
    return d;
}

INET_API cObject * inet::utils::createOne	(	const char *	className,
		const char *	defaultNamespace
	)

Like cObjectFactory::createOne(), except it starts searching for the class in the given namespace.

Referenced by inet::sctp::SCTPAssociation::cloneAssociation(), inet::tcp::TCPConnection::cloneListeningConnection(), inet::tcp::TCP_NSC::handleIpInputMessage(), inet::TCPSrvHostApp::handleMessage(), inet::sctp::SCTPAssociation::initAssociation(), inet::tcp::TCPConnection::initConnection(), inet::LifecycleController::processCommand(), and roundUp().

{
    cObject *ret = createOneIfClassIsKnown(className, defaultNamespace);
    if (!ret)
        throw cRuntimeError("Class \"%s\" not found -- perhaps its code was not linked in, "
                            "or the class wasn't registered with Register_Class(), or in the case of "
                            "modules and channels, with Define_Module()/Define_Channel()", className);
    return ret;
}

INET_API cObject * inet::utils::createOneIfClassIsKnown	(	const char *	className,
		const char *	defaultNamespace
	)

Like cObjectFactory::createOneIfClassIsKnown(), except it starts searching for the class in the given namespace.

Referenced by createOne(), and roundUp().

{
    std::string ns = defaultNamespace;
    do {
        std::string::size_type found = ns.rfind("::");
        if (found == std::string::npos)
            found = 0;
        ns.erase(found);
        std::string cn = found ? ns + "::" + className : className;
        cObject *ret = cObjectFactory::createOneIfClassIsKnown(cn.c_str());
        if (ret)
            return ret;
    } while (!ns.empty());
    return nullptr;
}

inet::utils::Define_NED_Function2	(	nedf_hasVisualizer	,
		"bool hasVisualizer()"	,
		""	,
		"Returns true if the visualizer feature is available"
	)

Referenced by nedf_absPath(), nedf_firstAvailableOrEmpty(), nedf_hasModule(), nedf_hasVisualizer(), nedf_haveClass(), nedf_moduleListByNedType(), nedf_moduleListByPath(), nedf_nanToZero(), and nedf_select().

inet::utils::Define_NED_Function2	(	nedf_hasModule	,
		"bool hasModule(string nedTypeName)"	,
		"string"	,
		"Returns true if the given NED type exists"
	)

inet::utils::Define_NED_Function2	(	nedf_haveClass	,
		"bool haveClass(string className)"	,
		"string"	,
		"Returns true if the given C++ class exists"
	)

inet::utils::Define_NED_Function2	(	nedf_moduleListByPath	,
		"string moduleListByPath(string modulePath,...)"	,
		"string"	,
		"Returns a space-separated list of the modules at the given path(s). ""See cTopology::extractByModulePath()."
	)

inet::utils::Define_NED_Function2	(	nedf_moduleListByNedType	,
		"string moduleListByNedType(string nedTypeName,...)"	,
		"string"	,
		"Returns a space-separated list of the modules with the given NED type(s). ""See cTopology::extractByNedTypeName()."
	)

inet::utils::Define_NED_Function2	(	nedf_select	,
		"any select(int index, ...)"	,
		"misc"	,
		"Returns the <index>th item from the rest of the argument list; numbering starts from 0."
	)

inet::utils::Define_NED_Function2	(	nedf_absPath	,
		"string absPath(string modulePath)"	,
		"string"	,
		"Returns absolute path of given module"
	)

inet::utils::Define_NED_Function2	(	nedf_firstAvailableOrEmpty	,
		"string firstAvailableOrEmpty(...)"	,
		"misc"	,
		"Accepts any number of	strings,
		interprets them as NED type names""	qualified or unqualified,
		and returns the first one that exists and""its C++implementation class is also available.Returns empty string if""none of the types are available."
	)

inet::utils::Define_NED_Function2	(	nedf_nanToZero	,
		"quantity nanToZero(quantity x)"	,
		"math"	,
		"Returns the argument if it is not	NaN,
		otherwise returns 0."
	)

INET_API std::string inet::utils::dtostr

(

double

d

)

Converts a double to string.

{
    std::ostringstream os;
    os << d;
    return os.str();
}

template<typename T >

T* inet::utils::dupPacketAndControlInfo

(

T *

packet

)

Duplicate a packet together with its control info.

(cPacket's dup() ignores the control info, it will be nullptr in the returned copy).

Referenced by inet::OrdinalBasedDuplicator::handleMessage(), inet::ieee80211::Tx::radioTransmissionFinished(), and inet::ieee80211::Tx::transmitFrame().

                                      {
    T *copy  = packet->dup();
    if (cObject *ctrl = packet->getControlInfo())
        copy->setControlInfo(ctrl->dup());
    return copy;
}

INET_API std::string inet::utils::ltostr

(

long

i

)

Converts an integer to string.

Referenced by inet::DiffservUtil::colorToString(), and inet::DiffservUtil::dscpToString().

{
    std::ostringstream os;
    os << i;
    return os.str();
}

cNEDValue inet::utils::nedf_absPath	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
    if (argc != 1)
        throw cRuntimeError("absPath(): must be one argument instead of %d argument(s)", argc);
    const char *path = argv[0].stringValue();
    switch (*path) {
        case '.':
            return context->getFullPath() + path;

        case '^':
            return context->getFullPath() + '.' + path;

        default:
            return argv[0];
    }
}

cNEDValue inet::utils::nedf_firstAvailableOrEmpty	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
    cRegistrationList *types = componentTypes.getInstance();
    for (int i=0; i<argc; i++)
    {
        if (argv[i].getType() != cNEDValue::STR)
            throw cRuntimeError("firstAvailable(): string arguments expected");
        const char *name = argv[i].stringValue();
        cComponentType *c;
        c = dynamic_cast<cComponentType *>(types->lookup(name)); // by qualified name
        if (c && c->isAvailable())
            return argv[i];
        c = dynamic_cast<cComponentType *>(types->find(name)); // by simple name
        if (c && c->isAvailable())
            return argv[i];
    }
    return "";
}

cNEDValue inet::utils::nedf_hasModule	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
    cRegistrationList *types = componentTypes.getInstance();
    if (argv[0].getType() != cNEDValue::STR)
        throw cRuntimeError("hasModule(): string arguments expected");
    const char *name = argv[0].stringValue();
    cComponentType *c;
    c = dynamic_cast<cComponentType *>(types->lookup(name)); // by qualified name
    if (c && c->isAvailable())
        return true;
    c = dynamic_cast<cComponentType *>(types->find(name)); // by simple name
    if (c && c->isAvailable())
        return true;
    return false;
}

cNEDValue inet::utils::nedf_hasVisualizer	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
#ifdef WITH_VISUALIZERS
    return true;
#else
    return false;
#endif
}

cNEDValue inet::utils::nedf_haveClass	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
    return classes.getInstance()->lookup(argv[0].stringValue()) != nullptr;
}

cNEDValue inet::utils::nedf_moduleListByNedType	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
    std::string modulenames;
    cTopology topo;
    std::vector<std::string> paths;
    for (int i = 0; i < argc; i++)
        paths.push_back(argv[i].stdstringValue());

    topo.extractByNedTypeName(paths);

    for (int i = 0; i < topo.getNumNodes(); i++) {
        std::string path = topo.getNode(i)->getModule()->getFullPath();
        if (modulenames.length() > 0)
            modulenames = modulenames + " " + path;
        else
            modulenames = path;
    }
    return modulenames;
}

cNEDValue inet::utils::nedf_moduleListByPath	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
    std::string modulenames;
    cTopology topo;
    std::vector<std::string> paths;
    for (int i = 0; i < argc; i++)
        paths.push_back(argv[i].stdstringValue());

    topo.extractByModulePath(paths);

    for (int i = 0; i < topo.getNumNodes(); i++) {
        std::string path = topo.getNode(i)->getModule()->getFullPath();
        if (modulenames.length() > 0)
            modulenames = modulenames + " " + path;
        else
            modulenames = path;
    }
    return modulenames;
}

cNEDValue inet::utils::nedf_nanToZero	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
    double x = argv[0].doubleValue();
    const char *unit = argv[0].getUnit();
    return std::isnan(x) ? cNEDValue(0, unit) : argv[0];
}

cNEDValue inet::utils::nedf_select	(	cComponent *	context,
		cNEDValue	argv[],
		int	argc
	)

{
    long index = argv[0];
    if (index < 0)
        throw cRuntimeError("select(): negative index %ld", index);
    if (index >= argc - 1)
        throw cRuntimeError("select(): index=%ld is too large", index, argc - 1);
    return argv[index + 1];
}

int inet::utils::roundUp ( int  numToRound, int  multiple  )

inline

Rounding up to the nearest multiple of a number.

Referenced by inet::IPv4Datagram::calculateHeaderByteLength(), and inet::GPSR::setGpsrOptionOnNetworkDatagram().

{ return ((numToRound + multiple -1) / multiple) * multiple; }

INET_API std::string inet::utils::stringf	(	const char *	fmt,
			...
	)

Accepts a printf-like argument list, and returns the result in a string.

The limit is 1024 chars.

Referenced by inet::IPv4RoutingTable::printMulticastRoutingTable(), and inet::IPv4RoutingTable::printRoutingTable().

{
    char buf[BUFLEN];
    va_list va;
    va_start(va, fmt);
    vsnprintf(buf, BUFLEN, fmt, va);
    buf[BUFLEN - 1] = '\0';
    va_end(va);
    return buf;
}

INET_API std::string inet::utils::stripnonalnum

(

const char *

s

)

Removes non-alphanumeric characters from the given string.

Referenced by inet::EtherEncap::initialize(), inet::ieee80211::Ieee80211AgentSTA::initialize(), inet::ieee80211::Ieee80211MgmtSTA::initialize(), inet::InterfaceEntry::InterfaceEntry(), and inet::ieee80211::Ieee80211Mac::isInterfaceRegistered().

{
    std::string result;
    for ( ; *s; s++)
        if (isalnum(*s))
            result += *s;

    return result;
}

INET_API std::string inet::utils::vstringf	(	const char *	fmt,
		va_list &	args
	)

Accepts a vprintf-like argument list, and returns the result in a string.

The limit is 1024 chars.

{
    char buf[BUFLEN];
    vsnprintf(buf, BUFLEN, fmt, args);
    buf[BUFLEN - 1] = '\0';
    return buf;
}