ast::XmlChan Class Reference

XmlChan provides input/output of AST objects. More...

#include <XmlChan.h>

Inheritance diagram for ast::XmlChan:

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

Public Member Functions
	XmlChan (Stream &stream, std::string const &options="")
	Construct a channel that uses a provided Stream. More...
virtual	~XmlChan ()
	XmlChan (XmlChan const &)=delete
	XmlChan (XmlChan &&)=default
XmlChan &	operator= (XmlChan const &)=delete
XmlChan &	operator= (XmlChan &&)=default
std::string	getXmlFormat () const
	Get XmlFormat System for formatting Objects as XML. More...
int	getXmlLength () const
	Get XmlLength: controls output buffer length. More...
std::string	getXmlPrefix ()
	Get XmlPrefix: the namespace prefix to use when writing. More...
void	setXmlFormat (std::string const &format)
	Set XmlFormat System for formatting Objects as XML. More...
void	setXmlLength (int len)
	Set XmlLength: controls output buffer length; 0 for no limit. More...
void	setXmlPrefix (std::string const &prefix)
	Set XmlPrefix: the namespace prefix to use when writing. More...
std::shared_ptr< Channel >	copy () const
	Return a deep copy of this object. More...
bool	getComment () const
	Get Comment: include textual comments in output? More...
int	getFull () const
	Get Full: level of output detail; one of -1: minimum, 0: normal, 1: verbose. More...
int	getIndent () const
	Get Indent: indentation increment between objects. More...
int	getReportLevel () const
	Get ReportLevel: report level. More...
bool	getSkip () const
	Get Skip: skip irrelevant data on input? More...
bool	getStrict () const
	Get Strict: generate errors instead of warnings? More...
std::shared_ptr< Object >	read ()
	Read an object from a channel. More...
void	setComment (bool skip)
	Set Comment: include textual comments in output? More...
void	setFull (int full)
	Set Full: level of output detail; one of -1: minimum, 0: normal, 1: verbose. More...
void	setIndent (int indent)
	Set Indent: indentation increment between objects. More...
void	setReportLevel (int level)
	Set ReportLevel: report level; an integer in the range [0, 3] where 0 is the most verbose. More...
void	setSkip (bool skip)
	Set Skip: skip irrelevant data on input? More...
void	setStrict (bool strict)
	Set Strict: generate errors instead of warnings? More...
KeyMap	warnings () const
	Return a KeyMap holding the text of any warnings issued as a result of the previous invocation of read or write. More...
int	write (Object const &object)
	Write an object to a channel. More...
bool	operator== (Object const &rhs) const
	Return True if this and rhs are the equal. More...
bool	operator!= (Object const &rhs) const
	Return True if this and rhs are not equal. More...
void	clear (std::string const &attrib)
	Clear the values of a specified set of attributes for an Object. More...
bool	hasAttribute (std::string const &attrib) const
	Does this object have an attribute with the specified name? More...
std::string	getClassName () const
	Get Class: the name of the class (e.g. More...
std::string	getID () const
	Get ID: object identification string that is not copied. More...
std::string	getIdent () const
	Get Ident: object identification string that is copied. More...
int	getNObject () const
	Get NObject: number of AST objects in existence of the same type as the underlying AST class. More...
int	getObjSize () const
	Get ObjSize: the in-memory size of the AST object in bytes. More...
int	getRefCount () const
	Get RefCount: number of active pointers to the underlying AST object. More...
bool	getUseDefs () const
	Get UseDefs: allow use of default values for Object attributes? More...
void	lock (bool wait)
	Lock this object for exclusive use by the calling thread. More...
bool	same (Object const &other) const
	Does this contain the same AST object as another? More...
void	setID (std::string const &id)
	Set ID: object identification string that is not copied. More...
void	setIdent (std::string const &ident)
	Set Ident: object identification string that is copied. More...
void	setUseDefs (bool usedefs)
	Set UseDefs: allow use of default values for Object attributes? More...
void	show (std::ostream &os, bool showComments=true) const
	Print a textual description the object to an ostream. More...
std::string	show (bool showComments=true) const
	Return a textual description the object as a string. More...
bool	test (std::string const &attrib) const
	Has this attribute been explicitly set (and not subsequently cleared)? More...
void	unlock (bool report=false)
	Unlock this object previously locked using lock, so that other threads can use this object. More...
AstObject const *	getRawPtr () const
	Get the raw AST pointer. More...
AstObject *	getRawPtr ()
	Get the raw AST pointer. More...

Static Public Member Functions
static std::shared_ptr< Object >	fromString (std::string const &str)
	Construct an Object from a string, using astFromString. More...
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. More...

Protected Member Functions
virtual std::shared_ptr< Object >	copyPolymorphic () const override
	Return a deep copy of this object. More...
template<typename T , typename AstT >
std::shared_ptr< T >	copyImpl () const
	Implementation of deep copy. More...
bool	getB (std::string const &attrib) const
	Get the value of an attribute as a bool. More...
std::string const	getC (std::string const &attrib) const
	Get the value of an attribute as a string. More...
double	getD (std::string const &attrib) const
	Get the value of an attribute as a double. More...
float	getF (std::string const &attrib) const
	Get the value of an attribute as a float. More...
int	getI (std::string const &attrib) const
	Get the value of an attribute as an int. More...
long int	getL (std::string const &attrib) const
	Get the value of an attribute as a long int. More...
void	set (std::string const &setting)
	Assign a set of attribute values, over-riding any previous values. More...
void	setB (std::string const &attrib, bool value)
	Set the value of an attribute as a bool. More...
void	setC (std::string const &attrib, std::string const &value)
	Set the value of an attribute as a string. More...
void	setD (std::string const &attrib, double value)
	Set the value of an attribute as a double. More...
void	setF (std::string const &attrib, float value)
	Set the value of an attribute as a float. More...
void	setI (std::string const &attrib, int value)
	Set the value of an attribute as an int. More...
void	setL (std::string const &attrib, long int value)
	Set the value of an attribute as a long int. More...

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. More...

Detailed Description

XmlChan provides input/output of AST objects.

Writing an Object to a XmlChan will generate a textual representation of that Object, and reading from a XmlChan will create a new Object from its textual representation.

XmlChan provides the following attributes, in addition to those provided by Channel and Object

XmlFormat: system for formatting Objects as XML. XmlLength: controls output buffer length; 0 for no limit. XmlPrefix: the namespace prefix to use when writing.

Definition at line 46 of file XmlChan.h.

Member Typedef Documentation

ObjectPtr

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

inherited

unique pointer holding an AST raw pointer

Definition at line 59 of file Object.h.

Constructor & Destructor Documentation

XmlChan() [1/3]

ast::XmlChan::XmlChan ( Stream &  stream, std::string const &  options = ""  )

inlineexplicit

Construct a channel that uses a provided Stream.

Parameters

[in]	stream	Stream for channel I/O: For file I/O: provide a FileStream For string I/O (e.g. unit tests): provide a StringStream For standard I/O provide Stream(&std::cin, &std::cout)) where either stream can be nullptr if not wanted
[in]	options	Comma-separated list of attribute assignments.

Definition at line 58 of file XmlChan.h.

            : Channel(reinterpret_cast<AstChannel *>(
                              astXmlChan(detail::source, detail::sink, "%s", options.c_str())),
                      stream) {
        assertOK();
    }

~XmlChan()

virtual ast::XmlChan::~XmlChan ( )

inlinevirtual

Definition at line 65 of file XmlChan.h.

{}

XmlChan() [2/3]

ast::XmlChan::XmlChan ( XmlChan const &  )

delete

XmlChan() [3/3]

ast::XmlChan::XmlChan ( XmlChan &&  )

default

Member Function Documentation

clear()

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

inlineinherited

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.

                                        {
        astClear(getRawPtr(), attrib.c_str());
        assertOK();
    }

copy()

std::shared_ptr<Channel> ast::Channel::copy ( ) const

inlineinherited

Return a deep copy of this object.

Definition at line 84 of file Channel.h.

                                        {
        throw std::logic_error(
                "Channel cannot be deep copied because its contained stream cannot be deep copied");
    }

copyImpl()

template<typename T , typename AstT >

std::shared_ptr<T> ast::Object::copyImpl ( ) const

inlineprotectedinherited

Implementation of deep copy.

Should be called to implement copyPolymorphic by all derived classes.

Definition at line 320 of file Object.h.

                                      {
        auto *rawptr = reinterpret_cast<AstT *>(astCopy(getRawPtr()));
        auto retptr = std::shared_ptr<T>(new T(rawptr));
        assertOK();
        return retptr;
    }

copyPolymorphic()

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

inlineoverrideprotectedvirtualinherited

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>();

Implements ast::Object.

Definition at line 159 of file Channel.h.

{ return std::shared_ptr<Object>(); }

fromAstObject()

template<typename Class >

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

staticinherited

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

Class

The class of the returned shared pointer. (The actual class will be the correct class of rawPtr.)

Parameters

[in]	rawObj	A bare AST object pointer
[in]	copy	If True then make a deep copy of the pointer (and free the original)

Definition at line 138 of file Object.cc.

                                                                       {
    AstObject *rawObjCopy = rawObj;
    if (copy) {
        rawObjCopy = reinterpret_cast<AstObject *>(astCopy(rawObj));
        astAnnul(rawObj);
    }
    assertOK(rawObjCopy);
 
    // Make the appropriate ast shim object and dynamically cast to the desired output type
    auto retObjectBeforeCast = Object::_basicFromAstObject(rawObjCopy);
    auto retObject = std::dynamic_pointer_cast<Class>(retObjectBeforeCast);
    if (!retObject) {
        std::ostringstream os;
        os << "The component is of type " << retObject->getClassName()
           << ", which could not be cast to the desired type " << typeid(Class).name();
        throw std::runtime_error(os.str());
    }
    return retObject;
}

fromString()

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

inlinestaticinherited

Construct an Object from a string, using astFromString.

Definition at line 88 of file Object.h.

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

getB()

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

inlineprotectedinherited

Get the value of an attribute as a bool.

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

Exceptions

std::runtime_error

if the attribute does not exist or the value cannot be converted

Definition at line 348 of file Object.h.

                                             {
        bool val = astGetI(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getC()

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

inlineprotectedinherited

Get the value of an attribute as a string.

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

Exceptions

std::runtime_error

if the attribute does not exist or the value cannot be converted

Definition at line 361 of file Object.h.

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

getClassName()

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

inlineinherited

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.

{ return detail::getClassName(getRawPtr()); }

getComment()

bool ast::Channel::getComment ( ) const

inlineinherited

Get Comment: include textual comments in output?

Definition at line 90 of file Channel.h.

{ return getB("Comment"); }

getD()

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

inlineprotectedinherited

Get the value of an attribute as a double.

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

Exceptions

std::runtime_error

if the attribute does not exist or the value cannot be converted

Definition at line 374 of file Object.h.

                                               {
        double val = astGetD(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getF()

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

inlineprotectedinherited

Get the value of an attribute as a float.

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

Exceptions

std::runtime_error

if the attribute does not exist or the value cannot be converted

Definition at line 387 of file Object.h.

                                              {
        float val = astGetF(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getFull()

int ast::Channel::getFull ( ) const

inlineinherited

Get Full: level of output detail; one of -1: minimum, 0: normal, 1: verbose.

Definition at line 93 of file Channel.h.

{ return getI("Full"); }

getI()

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

inlineprotectedinherited

Get the value of an attribute as an int.

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

Exceptions

std::runtime_error

if the attribute does not exist or the value cannot be converted

Definition at line 400 of file Object.h.

                                            {
        int val = astGetI(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getID()

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

inlineinherited

Get ID: object identification string that is not copied.

Definition at line 142 of file Object.h.

{ return getC("ID"); }

getIdent()

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

inlineinherited

Get Ident: object identification string that is copied.

Definition at line 145 of file Object.h.

{ return getC("Ident"); }

getIndent()

int ast::Channel::getIndent ( ) const

inlineinherited

Get Indent: indentation increment between objects.

Definition at line 96 of file Channel.h.

{ return getB("Indent"); }

getL()

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

inlineprotectedinherited

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_error

if the attribute does not exist or the value cannot be converted

Definition at line 413 of file Object.h.

                                                 {
        long int val = astGetL(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getNObject()

int ast::Object::getNObject ( ) const

inlineinherited

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.

{ return getI("NObject"); }

getObjSize()

int ast::Object::getObjSize ( ) const

inlineinherited

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

Definition at line 156 of file Object.h.

{ return getI("ObjSize"); }

getRawPtr() [1/2]

AstObject* ast::Object::getRawPtr ( )

inlineinherited

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.

{ return &*_objPtr; };

getRawPtr() [2/2]

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

inlineinherited

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.

{ return &*_objPtr; };

getRefCount()

int ast::Object::getRefCount ( ) const

inlineinherited

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.

{ return getI("RefCount"); }

getReportLevel()

int ast::Channel::getReportLevel ( ) const

inlineinherited

Get ReportLevel: report level.

Definition at line 99 of file Channel.h.

{ return getI("ReportLevel"); }

getSkip()

bool ast::Channel::getSkip ( ) const

inlineinherited

Get Skip: skip irrelevant data on input?

Definition at line 102 of file Channel.h.

{ return getB("Skip"); }

getStrict()

bool ast::Channel::getStrict ( ) const

inlineinherited

Get Strict: generate errors instead of warnings?

Definition at line 105 of file Channel.h.

{ return getB("Strict"); }

getUseDefs()

bool ast::Object::getUseDefs ( ) const

inlineinherited

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

Definition at line 166 of file Object.h.

{ return getB("UseDefs"); }

getXmlFormat()

std::string ast::XmlChan::getXmlFormat ( ) const

inline

Get XmlFormat System for formatting Objects as XML.

Definition at line 73 of file XmlChan.h.

{ return getC("XmlFormat"); }

getXmlLength()

int ast::XmlChan::getXmlLength ( ) const

inline

Get XmlLength: controls output buffer length.

Definition at line 76 of file XmlChan.h.

{ return getI("XmlLength"); }

getXmlPrefix()

std::string ast::XmlChan::getXmlPrefix ( )

inline

Get XmlPrefix: the namespace prefix to use when writing.

Definition at line 79 of file XmlChan.h.

{ return getC("XmlPrefix"); }

hasAttribute()

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

inlineinherited

Does this object have an attribute with the specified name?

Definition at line 127 of file Object.h.

                                                     {
        bool ret = astHasAttribute(getRawPtr(), attrib.c_str());
        assertOK();
        return ret;
    }

lock()

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

inlineinherited

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]

wait

If 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.

                         {
        astLock(getRawPtr(), static_cast<int>(wait));
        assertOK();
    }

makeShim()

template<typename ShimT , typename AstT >

static std::shared_ptr<ShimT> ast::Object::makeShim ( AstObject *  p )

inlinestaticprotectedinherited

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

Template Parameters

ShimT	Output astshim class
AstT	Output AST class

Definition at line 310 of file Object.h.

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

operator!=()

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

inlineinherited

Return True if this and rhs are not equal.

See operator== for details

Definition at line 82 of file Object.h.

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

operator=() [1/2]

XmlChan& ast::XmlChan::operator= ( XmlChan &&  )

default

operator=() [2/2]

XmlChan& ast::XmlChan::operator= ( XmlChan const &  )

delete

operator==()

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

inherited

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.

                                               {
    auto thisStr = this->show(false);
    auto rhsStr = rhs.show(false);
    return rhsStr == thisStr;
}

read()

std::shared_ptr< Object > ast::Channel::read ( )

inherited

Read an object from a channel.

Definition at line 52 of file Channel.cc.

                                    {
    AstObject *rawRet = reinterpret_cast<AstObject *>(astRead(getRawPtr()));
    assertOK(rawRet);
    if (!rawRet) {
        throw std::runtime_error("Could not read an AST object from this channel");
    }
    return Object::fromAstObject<Object>(rawRet, false);
}

same()

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

inlineinherited

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.

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

set()

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

inlineprotectedinherited

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_error

if the attribute is read-only

Definition at line 440 of file Object.h.

                                       {
        astSet(getRawPtr(), "%s", setting.c_str());
        assertOK();
    }

setB()

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

inlineprotectedinherited

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_error

if the attribute does not exist or the value cannot be converted

Definition at line 452 of file Object.h.

                                                   {
        astSetI(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setC()

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

inlineprotectedinherited

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_error

if the attribute does not exist or the value cannot be converted

Definition at line 464 of file Object.h.

                                                               {
        astSetC(getRawPtr(), attrib.c_str(), value.c_str());
        assertOK();
    }

setComment()

void ast::Channel::setComment ( bool  skip )

inlineinherited

Set Comment: include textual comments in output?

Definition at line 111 of file Channel.h.

{ setB("Comment", skip); }

setD()

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

inlineprotectedinherited

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_error

if the attribute does not exist or the value cannot be converted

Definition at line 476 of file Object.h.

                                                     {
        astSetD(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setF()

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

inlineprotectedinherited

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_error

if the attribute does not exist or the value cannot be converted

Definition at line 488 of file Object.h.

                                                    {
        astSetF(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setFull()

void ast::Channel::setFull ( int  full )

inlineinherited

Set Full: level of output detail; one of -1: minimum, 0: normal, 1: verbose.

Definition at line 114 of file Channel.h.

{ setI("Full", full); }

setI()

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

inlineprotectedinherited

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_error

if the attribute does not exist or the value cannot be converted

Definition at line 500 of file Object.h.

                                                  {
        astSetI(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setID()

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

inlineinherited

Set ID: object identification string that is not copied.

Definition at line 215 of file Object.h.

{ setC("ID", id); }

setIdent()

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

inlineinherited

Set Ident: object identification string that is copied.

Definition at line 218 of file Object.h.

{ setC("Ident", ident); }

setIndent()

void ast::Channel::setIndent ( int  indent )

inlineinherited

Set Indent: indentation increment between objects.

Definition at line 117 of file Channel.h.

{ setI("Indent", indent); }

setL()

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

inlineprotectedinherited

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_error

if the attribute does not exist or the value cannot be converted

Definition at line 512 of file Object.h.

                                                       {
        astSetL(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setReportLevel()

void ast::Channel::setReportLevel ( int  level )

inlineinherited

Set ReportLevel: report level; an integer in the range [0, 3] where 0 is the most verbose.

Exceptions

std::invalid_argument

if level is not in range [0, 3]

Definition at line 125 of file Channel.h.

                                   {
        if ((level < 0) || (level > 3)) {
            std::ostringstream os;
            os << "level = " << level << " not in range [0, 3]";
            throw std::invalid_argument(os.str());
        }
        setI("ReportLevel", level);
    }

setSkip()

void ast::Channel::setSkip ( bool  skip )

inlineinherited

Set Skip: skip irrelevant data on input?

Definition at line 135 of file Channel.h.

{ setB("Skip", skip); }

setStrict()

void ast::Channel::setStrict ( bool  strict )

inlineinherited

Set Strict: generate errors instead of warnings?

Definition at line 138 of file Channel.h.

{ setB("Strict", strict); }

setUseDefs()

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

inlineinherited

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

Definition at line 221 of file Object.h.

{ setB("UseDefs", usedefs); }

setXmlFormat()

void ast::XmlChan::setXmlFormat ( std::string const &  format )

inline

Set XmlFormat System for formatting Objects as XML.

Definition at line 82 of file XmlChan.h.

{ setC("XmlFormat", format); }

setXmlLength()

void ast::XmlChan::setXmlLength ( int  len )

inline

Set XmlLength: controls output buffer length; 0 for no limit.

Definition at line 85 of file XmlChan.h.

{ setI("XmlLength", len); }

setXmlPrefix()

void ast::XmlChan::setXmlPrefix ( std::string const &  prefix )

inline

Set XmlPrefix: the namespace prefix to use when writing.

Definition at line 88 of file XmlChan.h.

{ setC("XmlPrefix", prefix); }

show() [1/2]

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

inherited

Return a textual description the object as a string.

Parameters

[in]

showComments

Show comments?

Definition at line 165 of file Object.cc.

                                              {
    std::ostringstream os;
    show(os, showComments);
    return os.str();
}

show() [2/2]

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

inherited

Print a textual description the object to an ostream.

Parameters

[in,out]	os	The stream to which to write the string representation.
[in]	showComments	Show comments?

Definition at line 158 of file Object.cc.

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

test()

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

inlineinherited

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_error

if an error results.

Definition at line 250 of file Object.h.

                                             {
        bool res = astTest(getRawPtr(), attrib.c_str());
        assertOK();
        return res;
    }

unlock()

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

inlineinherited

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

See lock for further details.

Parameters

[in]

report

If 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.

                                     {
        astUnlock(getRawPtr(), static_cast<int>(report));
        assertOK();
    }

warnings()

KeyMap ast::Channel::warnings ( ) const

inherited

Return a KeyMap holding the text of any warnings issued as a result of the previous invocation of read or write.

If no warnings were issued, an empty KeyMap will be returned. Such warnings are non-fatal and will not prevent the read or write operation succeeding. However, the converted object may not be identical to the original object in all respects. Differences which would usually be deemed as insignificant in most usual cases will generate a warning, whereas more significant differences will generate an error.

The " Strict" attribute allows this warning facility to be switched off, so that a fatal error is always reported for any conversion error.

Definition at line 67 of file Channel.cc.

                               {
    AstKeyMap *rawKeyMap =
            reinterpret_cast<AstKeyMap *>(astWarnings(reinterpret_cast<AstChannel const *>(getRawPtr())));
    assertOK();
    return rawKeyMap ? KeyMap(rawKeyMap) : KeyMap();
}

write()

int ast::Channel::write ( Object const &  object )

inherited

Write an object to a channel.

Definition at line 61 of file Channel.cc.

                                       {
    int ret = astWrite(getRawPtr(), object.getRawPtr());
    assertOK();
    return ret;
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/astshim/22.0.1-1-geca5380+7fa3b7d9b6/include/astshim/XmlChan.h