int DimServiceInfoList::PrintDescription	(	std::ostream &	out,
		bool	iscmd,
		const std::string &	serv = "",
		const std::string &	service = ""
	)		const

Print the full available documentation (description) of all available services or comments to the the given stream.

Parameters

out	ostream to which the output is send.
iscmd	true if all commands should be printed, false for services.
serv	if a server is given, only the information for this server is printed
service	if a service is given, only information for this service is printed

Returns

the number of descriptions found

Definition at line 516 of file DimServiceInfoList.cc.

References i, if(), kBlue, kGreen, kRed, kReset, kYellow, and t.

Referenced by DimServiceInfoListImp::PrintDescription(), and ~DimServiceInfoList().

{
    int rc = 0;
    for (ServiceList::const_iterator i=fServiceList.begin(); i!=fServiceList.end(); i++)
    {
        const string &server = i->first;

        if (!serv.empty() && server!=serv)
            continue;

        out << kRed << "----- " << server << " -----" << endl;

        const TypeList        &types = i->second.first;
        const DescriptionList &descs = i->second.second;

        for (TypeList::const_iterator t=types.begin(); t!=types.end(); t++)
        {
            if (!service.empty() && t->first!=service)
                continue;

            if (t->second.second!=iscmd)
                continue;

            rc++;

            out << " " << t->first;

            // Check t->second->first for command or service
            const string fmt = t->second.first;
            if (!fmt.empty())
                out << '[' << fmt << ']';

            const DescriptionList::const_iterator d = descs.find(t->first);
            if (d==descs.end())
            {
                out << endl;
                continue;
            }

            const string comment         = d->second.first;
            const vector<Description> &v = d->second.second;

            for (vector<Description>::const_iterator j=v.begin(); j!=v.end(); j++)
                out << " <" << j->name << ">";
            out << endl;

            if (!comment.empty())
                out << "    " << comment << endl;

            for (vector<Description>::const_iterator j=v.begin(); j!=v.end(); j++)
            {
                out << "    " << kGreen << j->name;
                if (!j->comment.empty())
                    out << kReset << ": " << kBlue << j->comment;
                if (!j->unit.empty())
                    out << kYellow << " [" << j->unit << "]";
                out << endl;
            }
        }
        out << endl;
    }

    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: