DtOverlayLayersPredicate Class Reference

Contains the DtOverlayLayersPredicate class declaration.

Instances of DtOverlayLayersPredicate can be used to test the object for being on any of the supplied layers

Inheritance diagram for DtOverlayLayersPredicate:

Public Member Functions
	DtOverlayLayersPredicate (bool negate=false)
virtual	~DtOverlayLayersPredicate ()
	DtOverlayLayersPredicate (const DtOverlayLayersPredicate &orig)
DtOverlayLayersPredicate &	operator= (const DtOverlayLayersPredicate &orig)
virtual DtVrfObjectPredicate *	clone () const
void	addOverlay (const DtString &)
void	removeOverlay (const DtString &)
const std::set< DtString > &	overlays () const
Public Member Functions inherited from DtVrfObjectPredicate
	DtVrfObjectPredicate (bool negate=false)
virtual	~DtVrfObjectPredicate ()
	DtVrfObjectPredicate (const DtVrfObjectPredicate &orig)
DtVrfObjectPredicate &	operator= (const DtVrfObjectPredicate &orig)
bool	operator== (const DtVrfObjectPredicate &orig) const
bool	operator!= (const DtVrfObjectPredicate &orig) const
virtual bool	negated () const
virtual void	setNegate (bool negate)
bool	isTrue (const DtSimObject *vrfObject) const
virtual bool	canBeTrue (const DtSimObject *vrfObject)
virtual bool	canBeFalse (const DtSimObject *vrfObject)
virtual void	stringRep (std::ostream &str, int indentLevel=0) const

Protected Member Functions
virtual bool	eval (const DtSimObject *vrfObject) const
virtual bool	predicateEqual (const DtVrfObjectPredicate &orig) const
virtual bool	canEvalTrue (const DtSimObject *vrfObject) const override
virtual bool	canEvalFalse (const DtSimObject *vrfObject) const override
virtual void	typeSpecificStringRep (std::ostream &str, int indentLevel) const

Protected Attributes
std::set< DtString >	myOverlays
Protected Attributes inherited from DtVrfObjectPredicate
bool	myNegated

Additional Inherited Members
Static Public Member Functions inherited from DtVrfObjectPredicate
static const DtVrfObjectPredicate &	nullPredicate ()

Constructor & Destructor Documentation

DtOverlayLayersPredicate::DtOverlayLayersPredicate

(

bool

negate = false

)

default constructor

virtual DtOverlayLayersPredicate::~DtOverlayLayersPredicate ( )

virtual

destructor

DtOverlayLayersPredicate::DtOverlayLayersPredicate

(

const DtOverlayLayersPredicate &

orig

)

copy constructor

Member Function Documentation

DtOverlayLayersPredicate& DtOverlayLayersPredicate::operator=

(

const DtOverlayLayersPredicate &

orig

)

assignment operator

virtual DtVrfObjectPredicate* DtOverlayLayersPredicate::clone ( ) const

virtual

clone function

Implements DtVrfObjectPredicate.

void DtOverlayLayersPredicate::addOverlay

(

const DtString &

)

@ Layer management for this predicate

void DtOverlayLayersPredicate::removeOverlay

(

const DtString &

)

const std::set<DtString>& DtOverlayLayersPredicate::overlays

(

)

const

virtual bool DtOverlayLayersPredicate::eval ( const DtSimObject *  vrfObject ) const

protectedvirtual

The actual test this predicate performs.

Implements DtVrfObjectPredicate.

virtual bool DtOverlayLayersPredicate::predicateEqual ( const DtVrfObjectPredicate &  orig ) const

protectedvirtual

Used by equality operator used to compare predicates.

Reimplemented from DtVrfObjectPredicate.

virtual bool DtOverlayLayersPredicate::canEvalTrue ( const DtSimObject *  vrfObject ) const

overrideprotectedvirtual

Since this predicate tests a static parameter of the entity, it will only ever have the result it currently has for a given object.

Reimplemented from DtVrfObjectPredicate.

virtual bool DtOverlayLayersPredicate::canEvalFalse ( const DtSimObject *  vrfObject ) const

overrideprotectedvirtual

Returns

true if this predicate's eval() function can ever return false. If predicate subclass tests a static property of an object, override this function to return appropriately.

Reimplemented from DtVrfObjectPredicate.

virtual void DtOverlayLayersPredicate::typeSpecificStringRep ( std::ostream &  str, int  indentLevel  ) const

protectedvirtual

Override in specific subclasses to print the predicate description to the stream.

Reimplemented from DtVrfObjectPredicate.

Member Data Documentation

std::set<DtString> DtOverlayLayersPredicate::myOverlays

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/overlayLayersPredicate.h