Simbody  3.6
SimTK::MatrixStorage::Mask Struct Reference

Use this class to represent sets of acceptable values for each of the storage attributes (packing, position, order, diagonal). More...

Public Member Functions

 Mask ()
 
 Mask (PackingMask pkm, PlacementMask plm, OrderMask om, DiagonalMask dm)
 
MasksetToUncommitted ()
 
bool isUncommitted () const
 
bool isSatisfiedBy (Packing pack, Placement place, Order ord, Diagonal diag) const
 
bool isSatisfiedBy (const MatrixStorage &actual) const
 

Public Attributes

PackingMask packing
 
PlacementMask placement
 
OrderMask order
 
DiagonalMask diagonal
 

Detailed Description

Use this class to represent sets of acceptable values for each of the storage attributes (packing, position, order, diagonal).

Constructor & Destructor Documentation

◆ Mask() [1/2]

SimTK::MatrixStorage::Mask::Mask ( )
inline

◆ Mask() [2/2]

SimTK::MatrixStorage::Mask::Mask ( PackingMask  pkm,
PlacementMask  plm,
OrderMask  om,
DiagonalMask  dm 
)
inline

Member Function Documentation

◆ setToUncommitted()

Mask& SimTK::MatrixStorage::Mask::setToUncommitted ( )
inline

◆ isUncommitted()

bool SimTK::MatrixStorage::Mask::isUncommitted ( ) const
inline

◆ isSatisfiedBy() [1/2]

bool SimTK::MatrixStorage::Mask::isSatisfiedBy ( Packing  pack,
Placement  place,
Order  ord,
Diagonal  diag 
) const
inline

◆ isSatisfiedBy() [2/2]

bool SimTK::MatrixStorage::Mask::isSatisfiedBy ( const MatrixStorage actual) const
inline

Member Data Documentation

◆ packing

PackingMask SimTK::MatrixStorage::Mask::packing

◆ placement

PlacementMask SimTK::MatrixStorage::Mask::placement

◆ order

OrderMask SimTK::MatrixStorage::Mask::order

◆ diagonal

DiagonalMask SimTK::MatrixStorage::Mask::diagonal

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