RSOResourceFilterImpl Class Reference

#include <gls_rso_interface_impl.h>

Inheritance diagram for RSOResourceFilterImpl:

Public Member Functions
	RSOResourceFilterImpl (GlsResourceFilter *filter)
int	LevelsUp () const override
void	LevelsUp (int value) override
int	GroupLevelsDown () const override
void	GroupLevelsDown (int value) override
bool	NamesOnly () const override
void	NamesOnly (bool value) override
void	AddExclude (const char *str) override
int	ExcludeCount () const override
const char *	GetExclude (int index) const override
void	AddInclude (const char *str) override
int	IncludeCount () const override
const char *	GetInclude (int index) const override
bool	PassFilter (const char *name) const override
void	PushParentName (const char *parent)
void	PopParentName ()
	Pop the parent object name stack.
unsigned int	ParentNameCount () const
const char *	GetParentName (unsigned int index) const
virtual int	LevelsUp () const =0
virtual void	LevelsUp (int value)=0
virtual int	GroupLevelsDown () const =0
virtual void	GroupLevelsDown (int value)=0
virtual bool	NamesOnly () const =0
virtual void	NamesOnly (bool value)=0
virtual void	AddExclude (const char *str)=0
virtual int	ExcludeCount () const =0
virtual const char *	GetExclude (int index) const =0
virtual void	AddInclude (const char *str)=0
virtual int	IncludeCount () const =0
virtual const char *	GetInclude (int index) const =0
virtual bool	PassFilter (const char *name) const =0

Detailed Description

Wraps a GlsResourceFilter so it can be passed to the RSO Interface's GetResources call

Constructor & Destructor Documentation

RSOResourceFilterImpl()

RSOResourceFilterImpl ( GlsResourceFilter *  filter )

inline

Constructor

Parameters

filter

The filter to wrap.

Member Function Documentation

AddExclude()

void AddExclude ( const char *  str )

inlineoverridevirtual

Manage the list of excluded attributes. Takes precedence over includes.

Parameters

str	The new name to add to the exclude list.

Implements RSOInterface1::ResourceFilter.

AddInclude()

void AddInclude ( const char *  str )

inlineoverridevirtual

Manage the list of included attributes.

Parameters

str	The new name to add to the include list.

Implements RSOInterface1::ResourceFilter.

ExcludeCount()

int ExcludeCount ( ) const

inlineoverridevirtual

Default: 0

Returns

The number of entries in the exclude list.

Implements RSOInterface1::ResourceFilter.

GetExclude()

const char * GetExclude ( int  index ) const

inlineoverridevirtual

Note

Returns NULL if index >= ExcludeCount() or index < -1.

Returns

The exclude name associated with the incoming index.

Parameters

index

The index of the exclusion item to return.

Implements RSOInterface1::ResourceFilter.

GetInclude()

const char * GetInclude ( int  index ) const

inlineoverridevirtual

Note

Returns NULL if index >= IncludeCount() or index < -1

Returns

The include name associated with the incoming index.

Parameters

index

The index of the inclusion item to return.

Implements RSOInterface1::ResourceFilter.

GetParentName()

const char * GetParentName ( unsigned int  index ) const

inline

Note

Returns NULL if index >= ParentNameCount() or index < -1.

Returns

The parent name associated with the incoming index.

Parameters

index

The index of the parent name to return.

GroupLevelsDown() [1/2]

int GroupLevelsDown ( ) const

inlineoverridevirtual

Returns

The current levels of children to show.

Implements RSOInterface1::ResourceFilter.

GroupLevelsDown() [2/2]

void GroupLevelsDown ( int  value )

inlineoverridevirtual

How many levels of children to show. 0 means don't show any children properties -1 means all the way down. Default: -1

Parameters

value

The new levels of children to show.

Implements RSOInterface1::ResourceFilter.

IncludeCount()

int IncludeCount ( ) const

inlineoverridevirtual

Default: 0

Returns

The number of entries in the include list.

Implements RSOInterface1::ResourceFilter.

LevelsUp() [1/2]

int LevelsUp ( ) const

inlineoverridevirtual

Returns

The current qualification level.

Implements RSOInterface1::ResourceFilter.

LevelsUp() [2/2]

void LevelsUp ( int  value )

inlineoverridevirtual

How many levels of qualification to show in the name. -1 means full qualification. Default: -1

Parameters

value

The new qualification level to set.

Implements RSOInterface1::ResourceFilter.

NamesOnly() [1/2]

bool NamesOnly ( ) const

inlineoverridevirtual

Returns

Whether or not names, or names and values should be returned.

Implements RSOInterface1::ResourceFilter.

NamesOnly() [2/2]

void NamesOnly ( bool  value )

inlineoverridevirtual

If true, only a list of names will be returned. Values will not be returned. The format changes to not include the ":". Default: false

Parameters

value

The new name display flag to set.

Implements RSOInterface1::ResourceFilter.

ParentNameCount()

unsigned int ParentNameCount ( ) const

inline

Returns

The number of entries in the parent name stack.

PassFilter()

bool PassFilter ( const char *  name ) const

inlineoverridevirtual

Check a name against the filters. Exclude list takes precedence.

Parameters

name	The name of the item to test.

Returns

Whether or not the name passes the filter (to be included in the returned results).

Implements RSOInterface1::ResourceFilter.

PushParentName()

void PushParentName ( const char *  parent )

inline

Manage the stack of parent object names.

Parameters

parent

The name of the item to add to the stack.

---

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

• gls_rso_interface_impl.h