LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
ast::Object Class Referenceabstract

Abstract base class for all AST objects. More...

#include <Object.h>

Inheritance diagram for ast::Object:
ast::Channel ast::KeyMap ast::Mapping ast::FitsChan ast::XmlChan ast::Table ast::ChebyMap ast::CmpMap ast::Frame ast::LutMap ast::MathMap ast::MatrixMap ast::NormMap ast::PcdMap ast::PermMap ast::PolyMap ast::RateMap ast::ShiftMap ast::SlaMap ast::SphMap ast::TimeMap ast::TranMap ast::UnitMap ast::UnitNormMap ast::WcsMap ast::WinMap ast::ZoomMap

Public Types

using ObjectPtr = std::unique_ptr<AstObject, Deleter>
 unique pointer holding an AST raw pointer
 

Public Member Functions

virtual ~Object ()
 
 Object (Object const &object)
 Copy constructor: make a deep copy.
 
 Object (Object &&)=default
 
Objectoperator= (Object const &)=delete
 
Objectoperator= (Object &&)=default
 
bool operator== (Object const &rhs) const
 Return True if this and rhs are the equal.
 
bool operator!= (Object const &rhs) const
 Return True if this and rhs are not equal.
 
std::shared_ptr< Objectcopy () const
 Return a deep copy of this object.
 
void clear (std::string const &attrib)
 Clear the values of a specified set of attributes for an Object.
 
bool hasAttribute (std::string const &attrib) const
 Does this object have an attribute with the specified name?
 
std::string getClassName () const
 Get Class: the name of the class (e.g.
 
std::string getID () const
 Get ID: object identification string that is not copied.
 
std::string getIdent () const
 Get Ident: object identification string that is copied.
 
int getNObject () const
 Get NObject: number of AST objects in existence of the same type as the underlying AST class.
 
int getObjSize () const
 Get ObjSize: the in-memory size of the AST object in bytes.
 
int getRefCount () const
 Get RefCount: number of active pointers to the underlying AST object.
 
bool getUseDefs () const
 Get UseDefs: allow use of default values for Object attributes?
 
void lock (bool wait)
 Lock this object for exclusive use by the calling thread.
 
bool same (Object const &other) const
 Does this contain the same AST object as another?
 
void setID (std::string const &id)
 Set ID: object identification string that is not copied.
 
void setIdent (std::string const &ident)
 Set Ident: object identification string that is copied.
 
void setUseDefs (bool usedefs)
 Set UseDefs: allow use of default values for Object attributes?
 
void show (std::ostream &os, bool showComments=true) const
 Print a textual description the object to an ostream.
 
std::string show (bool showComments=true) const
 Return a textual description the object as a string.
 
bool test (std::string const &attrib) const
 Has this attribute been explicitly set (and not subsequently cleared)?
 
void unlock (bool report=false)
 Unlock this object previously locked using lock, so that other threads can use this object.
 
AstObject const * getRawPtr () const
 Get the raw AST pointer.
 
AstObject * getRawPtr ()
 Get the raw AST pointer.
 

Static Public Member Functions

static std::shared_ptr< ObjectfromString (std::string const &str)
 Construct an Object from a string, using astFromString.
 
template<typename Class >
static std::shared_ptr< Class > fromAstObject (AstObject *rawObj, bool copy)
 Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type.
 

Protected Member Functions

 Object (AstObject *object)
 Construct an Object from a pointer to a raw AstObject.
 
template<typename T , typename AstT >
std::shared_ptr< T > copyImpl () const
 Implementation of deep copy.
 
virtual std::shared_ptr< ObjectcopyPolymorphic () const =0
 Return a deep copy of this object.
 
bool getB (std::string const &attrib) const
 Get the value of an attribute as a bool.
 
std::string const getC (std::string const &attrib) const
 Get the value of an attribute as a string.
 
double getD (std::string const &attrib) const
 Get the value of an attribute as a double.
 
float getF (std::string const &attrib) const
 Get the value of an attribute as a float.
 
int getI (std::string const &attrib) const
 Get the value of an attribute as an int.
 
long int getL (std::string const &attrib) const
 Get the value of an attribute as a long int.
 
void set (std::string const &setting)
 Assign a set of attribute values, over-riding any previous values.
 
void setB (std::string const &attrib, bool value)
 Set the value of an attribute as a bool.
 
void setC (std::string const &attrib, std::string const &value)
 Set the value of an attribute as a string.
 
void setD (std::string const &attrib, double value)
 Set the value of an attribute as a double.
 
void setF (std::string const &attrib, float value)
 Set the value of an attribute as a float.
 
void setI (std::string const &attrib, int value)
 Set the value of an attribute as an int.
 
void setL (std::string const &attrib, long int value)
 Set the value of an attribute as a long int.
 

Static Protected Member Functions

template<typename ShimT , typename AstT >
static std::shared_ptr< ShimT > makeShim (AstObject *p)
 Functor to make an astshim instance from a raw AST pointer of the corresponding type.
 

Friends

class MapSplit
 
class FrameDict
 

Detailed Description

Abstract base class for all AST objects.

Attributes

Object provides the following attributes:

Definition at line 51 of file Object.h.

Member Typedef Documentation

◆ ObjectPtr

using ast::Object::ObjectPtr = std::unique_ptr<AstObject, Deleter>

unique pointer holding an AST raw pointer

Definition at line 59 of file Object.h.

Constructor & Destructor Documentation

◆ ~Object()

virtual ast::Object::~Object ( )
inlinevirtual

Definition at line 61 of file Object.h.

61{}

◆ Object() [1/3]

ast::Object::Object ( Object const & object)
inline

Copy constructor: make a deep copy.

Definition at line 64 of file Object.h.

64: _objPtr(object.getRawPtrCopy(), &detail::annulAstObject) {}
void annulAstObject(AstObject *object)
A wrapper around astAnnul; intended as a custom deleter for std::unique_ptr.
Definition utils.h:40

◆ Object() [2/3]

ast::Object::Object ( Object && )
default

◆ Object() [3/3]

ast::Object::Object ( AstObject * object)
explicitprotected

Construct an Object from a pointer to a raw AstObject.

Definition at line 171 of file Object.cc.

171 : _objPtr(object, &detail::annulAstObject) {
172 assertOK();
173 if (!object) {
174 throw std::runtime_error("Null pointer");
175 }
176}
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition base.cc:49

Member Function Documentation

◆ clear()

void ast::Object::clear ( std::string const & attrib)
inline

Clear the values of a specified set of attributes for an Object.

Clearing an attribute cancels any value that has previously been explicitly set for it, so that the standard default attribute value will subsequently be used instead. This also causes the astTest function to return the value zero for the attribute, indicating that no value has been set.

Definition at line 119 of file Object.h.

119 {
120 astClear(getRawPtr(), attrib.c_str());
121 assertOK();
122 }
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition Object.h:292

◆ copy()

std::shared_ptr< Object > ast::Object::copy ( ) const
inline

Return a deep copy of this object.

Definition at line 109 of file Object.h.

109{ return std::static_pointer_cast<Object>(copyPolymorphic()); }
virtual std::shared_ptr< Object > copyPolymorphic() const =0
Return a deep copy of this object.

◆ copyImpl()

template<typename T , typename AstT >
std::shared_ptr< T > ast::Object::copyImpl ( ) const
inlineprotected

Implementation of deep copy.

Should be called to implement copyPolymorphic by all derived classes.

Definition at line 320 of file Object.h.

320 {
321 auto *rawptr = reinterpret_cast<AstT *>(astCopy(getRawPtr()));
322 auto retptr = std::shared_ptr<T>(new T(rawptr));
323 assertOK();
324 return retptr;
325 }

◆ copyPolymorphic()

virtual std::shared_ptr< Object > ast::Object::copyPolymorphic ( ) const
protectedpure virtual

Return a deep copy of this object.

This is called by copy.

Each subclass must override this method. The standard implementation is:

return copyImpl<astshim_class, ast_class>();

for example Frame implements this as:

return copyImpl<Frame, AstFrame>();

Implemented in ast::Channel, ast::ChebyMap, ast::CmpFrame, ast::CmpMap, ast::Frame, ast::FrameDict, ast::FrameSet, ast::KeyMap, ast::LutMap, ast::Mapping, ast::MathMap, ast::MatrixMap, ast::NormMap, ast::ParallelMap, ast::PcdMap, ast::PermMap, ast::PolyMap, ast::RateMap, ast::SeriesMap, ast::ShiftMap, ast::SkyFrame, ast::SlaMap, ast::SpecFrame, ast::SphMap, ast::TimeFrame, ast::TimeMap, ast::TranMap, ast::UnitMap, ast::UnitNormMap, ast::WcsMap, ast::WinMap, and ast::ZoomMap.

◆ fromAstObject()

template<typename Class >
template std::shared_ptr< Object > ast::Object::fromAstObject< Object > ( AstObject * rawObj,
bool copy )
static

Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type.

The returned object takes ownership of the pointer. This is almost always what you want, for instance astDecompose returns shallow copies of the internal pointers.

Template Parameters
ClassThe class of the returned shared pointer. (The actual class will be the correct class of rawPtr.)
Parameters
[in]rawObjA bare AST object pointer
[in]copyIf True then make a deep copy of the pointer (and free the original)

Definition at line 138 of file Object.cc.

138 {
139 AstObject *rawObjCopy = rawObj;
140 if (copy) {
141 rawObjCopy = reinterpret_cast<AstObject *>(astCopy(rawObj));
142 astAnnul(rawObj);
143 }
144 assertOK(rawObjCopy);
145
146 // Make the appropriate ast shim object and dynamically cast to the desired output type
147 auto retObjectBeforeCast = Object::_basicFromAstObject(rawObjCopy);
148 auto retObject = std::dynamic_pointer_cast<Class>(retObjectBeforeCast);
149 if (!retObject) {
151 os << "The component is of type " << retObject->getClassName()
152 << ", which could not be cast to the desired type " << typeid(Class).name();
153 throw std::runtime_error(os.str());
154 }
155 return retObject;
156}
table::Key< std::string > name
Definition Amplifier.cc:116
std::ostream * os
Definition Schema.cc:557

◆ fromString()

static std::shared_ptr< Object > ast::Object::fromString ( std::string const & str)
inlinestatic

Construct an Object from a string, using astFromString.

Definition at line 88 of file Object.h.

88 {
89 auto *rawPtr = reinterpret_cast<AstObject *>(astFromString(str.c_str()));
90 assertOK(rawPtr);
91 return Object::_basicFromAstObject(rawPtr);
92 }

◆ getB()

bool ast::Object::getB ( std::string const & attrib) const
inlineprotected

Get the value of an attribute as a bool.

If possible, the attribute value is converted to the type you request.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 348 of file Object.h.

348 {
349 bool val = astGetI(getRawPtr(), attrib.c_str());
350 assertOK();
351 return val;
352 }
ImageT val
Definition CR.cc:146

◆ getC()

std::string const ast::Object::getC ( std::string const & attrib) const
inlineprotected

Get the value of an attribute as a string.

If possible, the attribute value is converted to the type you request.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 361 of file Object.h.

361 {
362 char const *rawval = astGetC(getRawPtr(), attrib.c_str());
363 assertOK();
364 return std::string(rawval);
365 }

◆ getClassName()

std::string ast::Object::getClassName ( ) const
inline

Get Class: the name of the class (e.g.

ZoomMap)

Note: if AST returns "CmpMap" then the name will be changed to "SeriesMap" or "ParallelMap", as appropriate.

Definition at line 139 of file Object.h.

139{ return detail::getClassName(getRawPtr()); }
std::string getClassName(AstObject const *rawObj)
Get the AST class name, changing CmpMap to SeriesMap or ParallelMap as appropriate.
Definition utils.cc:37

◆ getD()

double ast::Object::getD ( std::string const & attrib) const
inlineprotected

Get the value of an attribute as a double.

If possible, the attribute value is converted to the type you request.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 374 of file Object.h.

374 {
375 double val = astGetD(getRawPtr(), attrib.c_str());
376 assertOK();
377 return val;
378 }

◆ getF()

float ast::Object::getF ( std::string const & attrib) const
inlineprotected

Get the value of an attribute as a float.

If possible, the attribute value is converted to the type you request.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 387 of file Object.h.

387 {
388 float val = astGetF(getRawPtr(), attrib.c_str());
389 assertOK();
390 return val;
391 }

◆ getI()

int ast::Object::getI ( std::string const & attrib) const
protected

Get the value of an attribute as an int.

If possible, the attribute value is converted to the type you request.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 178 of file Object.cc.

178 {
179 int val = astGetI(getRawPtr(), attrib.c_str());
180 assertOK();
181 return val;
182}

◆ getID()

std::string ast::Object::getID ( ) const
inline

Get ID: object identification string that is not copied.

Definition at line 142 of file Object.h.

142{ return getC("ID"); }
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition Object.h:361

◆ getIdent()

std::string ast::Object::getIdent ( ) const
inline

Get Ident: object identification string that is copied.

Definition at line 145 of file Object.h.

145{ return getC("Ident"); }

◆ getL()

long int ast::Object::getL ( std::string const & attrib) const
inlineprotected

Get the value of an attribute as a long int.

If possible, the attribute value is converted to the type you request.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 409 of file Object.h.

409 {
410 long int val = astGetL(getRawPtr(), attrib.c_str());
411 assertOK();
412 return val;
413 }

◆ getNObject()

int ast::Object::getNObject ( ) const
inline

Get NObject: number of AST objects in existence of the same type as the underlying AST class.

Warning
Intended only for debugging astshim.

Definition at line 153 of file Object.h.

153{ return getI("NObject"); }
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition Object.cc:178

◆ getObjSize()

int ast::Object::getObjSize ( ) const
inline

Get ObjSize: the in-memory size of the AST object in bytes.

Definition at line 156 of file Object.h.

156{ return getI("ObjSize"); }

◆ getRawPtr() [1/2]

AstObject * ast::Object::getRawPtr ( )
inline

Get the raw AST pointer.

Intended for internal use only, but cannot be made protected without endless "friend class" declarations.

Definition at line 294 of file Object.h.

294{ return &*_objPtr; };

◆ getRawPtr() [2/2]

AstObject const * ast::Object::getRawPtr ( ) const
inline

Get the raw AST pointer.

Intended for internal use only, but cannot be made protected without endless "friend class" declarations.

Definition at line 292 of file Object.h.

292{ return &*_objPtr; };

◆ getRefCount()

int ast::Object::getRefCount ( ) const
inline

Get RefCount: number of active pointers to the underlying AST object.

Warning
Intended only for debugging astshim.

Definition at line 163 of file Object.h.

163{ return getI("RefCount"); }

◆ getUseDefs()

bool ast::Object::getUseDefs ( ) const
inline

Get UseDefs: allow use of default values for Object attributes?

Definition at line 166 of file Object.h.

166{ return getB("UseDefs"); }
bool getB(std::string const &attrib) const
Get the value of an attribute as a bool.
Definition Object.h:348

◆ hasAttribute()

bool ast::Object::hasAttribute ( std::string const & attrib) const
inline

Does this object have an attribute with the specified name?

Definition at line 127 of file Object.h.

127 {
128 bool ret = astHasAttribute(getRawPtr(), attrib.c_str());
129 assertOK();
130 return ret;
131 }

◆ lock()

void ast::Object::lock ( bool wait)
inline

Lock this object for exclusive use by the calling thread.

The thread-safe public interface to AST is designed so that an error is reported if any thread attempts to use an Object that it has not previously locked for its own exclusive use using this function. When an Object is created, it is initially locked by the thread that creates it, so newly created objects do not need to be explicitly locked. However, if an Object pointer is passed to another thread, the original thread must first unlock it (using astUnlock) and the new thread must then lock it (using astLock) before the new thread can use the Object.

Parameters
[in]waitIf the Object is curently locked by another thread then this function will either report an error or block. If a non-zero value is supplied for "wait", the calling thread waits until the object is available for it to use. Otherwise, an error is reported and the function returns immediately without locking the Object.

Notes

  • The Locked object will belong to the current AST context.
  • This function returns without action if the Object is already locked by the calling thread.
  • If simultaneous use of the same object is required by two or more threads, Object::copy should be used to to produce a deep copy of the Object for each thread. Each copy should then be unlocked by the parent thread (i.e. the thread that created the copy), and then locked by the child thread (i.e. the thread that wants to use the copy).
  • This function returns without action if the AST library has been built without POSIX thread support (i.e. the "-with-pthreads" option was not specified when running the "configure" script).

Definition at line 202 of file Object.h.

202 {
203 astLock(getRawPtr(), static_cast<int>(wait));
204 assertOK();
205 }

◆ makeShim()

template<typename ShimT , typename AstT >
static std::shared_ptr< ShimT > ast::Object::makeShim ( AstObject * p)
inlinestaticprotected

Functor to make an astshim instance from a raw AST pointer of the corresponding type.

Template Parameters
ShimTOutput astshim class
AstTOutput AST class

Definition at line 310 of file Object.h.

310 {
311 return std::shared_ptr<ShimT>(new ShimT(reinterpret_cast<AstT *>(p)));
312 }

◆ operator!=()

bool ast::Object::operator!= ( Object const & rhs) const
inline

Return True if this and rhs are not equal.

See operator== for details

Definition at line 82 of file Object.h.

82 {
83 return !(*this == rhs); };

◆ operator=() [1/2]

Object & ast::Object::operator= ( Object && )
default

◆ operator=() [2/2]

Object & ast::Object::operator= ( Object const & )
delete

◆ operator==()

bool ast::Object::operator== ( Object const & rhs) const

Return True if this and rhs are the equal.

For two objects be equal, they both must have the same attributes and all contained objects must be equal.

Definition at line 85 of file Object.cc.

85 {
86 auto thisStr = this->show(false);
87 auto rhsStr = rhs.show(false);
88 return rhsStr == thisStr;
89}
void show(std::ostream &os, bool showComments=true) const
Print a textual description the object to an ostream.
Definition Object.cc:158

◆ same()

bool ast::Object::same ( Object const & other) const
inline

Does this contain the same AST object as another?

This is a test of identity, not of equality.

Definition at line 212 of file Object.h.

212{ return astSame(getRawPtr(), other.getRawPtr()); }

◆ set()

void ast::Object::set ( std::string const & setting)
inlineprotected

Assign a set of attribute values, over-riding any previous values.

The attributes and their new values are specified via a character string, which should contain a comma-separated list of the form: "attribute_1 = value_1, attribute_2 = value_2, ... " where "attribute_n" specifies an attribute name, and the value to the right of each " =" sign should be a suitable textual representation of the value to be assigned. This value will be interpreted according to the attribute's data type.

Notes

  • Attribute names are not case sensitive and may be surrounded by white space
  • Attribute names are not case sensitive and may be surrounded by white space.
  • White space may also surround attribute values, where it will generally be ignored (except for string-valued attributes where it is significant and forms part of the value to be assigned).
  • To include a literal comma or percent sign in the value assigned to an attribute, the whole attribute value should be enclosed in quotation markes.
Exceptions
std::runtime_errorif the attribute is read-only

Definition at line 436 of file Object.h.

436 {
437 astSet(getRawPtr(), "%s", setting.c_str());
438 assertOK();
439 }

◆ setB()

void ast::Object::setB ( std::string const & attrib,
bool value )
inlineprotected

Set the value of an attribute as a bool.

If possible, the type you provide is converted to the actual type of the attribute.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 448 of file Object.h.

448 {
449 astSetI(getRawPtr(), attrib.c_str(), value);
450 assertOK();
451 }

◆ setC()

void ast::Object::setC ( std::string const & attrib,
std::string const & value )
inlineprotected

Set the value of an attribute as a string.

If possible, the type you provide is converted to the actual type of the attribute.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 460 of file Object.h.

460 {
461 astSetC(getRawPtr(), attrib.c_str(), value.c_str());
462 assertOK();
463 }

◆ setD()

void ast::Object::setD ( std::string const & attrib,
double value )
inlineprotected

Set the value of an attribute as a double.

If possible, the type you provide is converted to the actual type of the attribute.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 472 of file Object.h.

472 {
473 astSetD(getRawPtr(), attrib.c_str(), value);
474 assertOK();
475 }

◆ setF()

void ast::Object::setF ( std::string const & attrib,
float value )
inlineprotected

Set the value of an attribute as a float.

If possible, the type you provide is converted to the actual type of the attribute.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 484 of file Object.h.

484 {
485 astSetF(getRawPtr(), attrib.c_str(), value);
486 assertOK();
487 }

◆ setI()

void ast::Object::setI ( std::string const & attrib,
int value )
inlineprotected

Set the value of an attribute as an int.

If possible, the type you provide is converted to the actual type of the attribute.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 496 of file Object.h.

496 {
497 astSetI(getRawPtr(), attrib.c_str(), value);
498 assertOK();
499 }

◆ setID()

void ast::Object::setID ( std::string const & id)
inline

Set ID: object identification string that is not copied.

Definition at line 215 of file Object.h.

215{ setC("ID", id); }
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition Object.h:460

◆ setIdent()

void ast::Object::setIdent ( std::string const & ident)
inline

Set Ident: object identification string that is copied.

Definition at line 218 of file Object.h.

218{ setC("Ident", ident); }

◆ setL()

void ast::Object::setL ( std::string const & attrib,
long int value )
inlineprotected

Set the value of an attribute as a long int.

If possible, the type you provide is converted to the actual type of the attribute.

Exceptions
std::runtime_errorif the attribute does not exist or the value cannot be converted

Definition at line 508 of file Object.h.

508 {
509 astSetL(getRawPtr(), attrib.c_str(), value);
510 assertOK();
511 }

◆ setUseDefs()

void ast::Object::setUseDefs ( bool usedefs)
inline

Set UseDefs: allow use of default values for Object attributes?

Definition at line 221 of file Object.h.

221{ setB("UseDefs", usedefs); }
void setB(std::string const &attrib, bool value)
Set the value of an attribute as a bool.
Definition Object.h:448

◆ show() [1/2]

std::string ast::Object::show ( bool showComments = true) const

Return a textual description the object as a string.

Parameters
[in]showCommentsShow comments?

Definition at line 165 of file Object.cc.

165 {
167 show(os, showComments);
168 return os.str();
169}

◆ show() [2/2]

void ast::Object::show ( std::ostream & os,
bool showComments = true ) const

Print a textual description the object to an ostream.

Parameters
[in,out]osThe stream to which to write the string representation.
[in]showCommentsShow comments?

Definition at line 158 of file Object.cc.

158 {
159 Stream stream(nullptr, &os);
160 Channel ch(stream, showComments ? "" : "Comment=0");
161 ch.write(*this);
162 assertOK();
163}

◆ test()

bool ast::Object::test ( std::string const & attrib) const
inline

Has this attribute been explicitly set (and not subsequently cleared)?

Warning
Unlike the underlying astTest function, throws an exception if an error results

Notes

  • Attribute names are not case sensitive and may be surrounded by white space.
  • As you might expect, the returned value for a read-only attribute is always false.
Exceptions
std::runtime_errorif an error results.

Definition at line 250 of file Object.h.

250 {
251 bool res = astTest(getRawPtr(), attrib.c_str());
252 assertOK();
253 return res;
254 }

◆ unlock()

void ast::Object::unlock ( bool report = false)
inline

Unlock this object previously locked using lock, so that other threads can use this object.

See lock for further details.

Parameters
[in]reportIf true, an error will be reported if the supplied Object, or any Object contained within the supplied Object, is not currently locked by the running thread. If false, such Objects will be left unchanged, and no error will be reported.

Notes

  • This function attempts to execute even if AST's global error status is set, but no further error report will be made if it subsequently fails under these circumstances.
  • All unlocked Objects are excluded from AST context handling until they are re-locked using astLock.
  • This function returns without action if the Object is not currently locked by any thread. If it is locked by the running thread, it is unlocked. If it is locked by another thread, an error will be reported if "error" is non-zero.
  • This function returns without action if the AST library has been built without POSIX thread support (i.e. the "-with-pthreads" option was not specified when running the "configure" script).

Definition at line 280 of file Object.h.

280 {
281 astUnlock(getRawPtr(), static_cast<int>(report));
282 assertOK();
283 }

Friends And Related Symbol Documentation

◆ FrameDict

friend class FrameDict
friend

Definition at line 53 of file Object.h.

◆ MapSplit

friend class MapSplit
friend

Definition at line 52 of file Object.h.


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