A FrameSet whose frames can be referenced by domain name. More...

#include <FrameDict.h>

Inheritance diagram for ast::FrameDict:

Public Member Functions
	FrameDict (Frame const &frame, std::string const &options="")
	Construct a FrameDict from a single Frame.
	FrameDict (Frame const &baseFrame, Mapping const &mapping, Frame const &currentFrame, std::string const &options="")
	Construct a FrameDict from two frames and a mapping that connects them.
	FrameDict (FrameSet const &frameSet)
	Construct a FrameDict from a FrameSet.
virtual	~FrameDict ()
	FrameDict (FrameDict const &)=default
	Copy constructor: make a deep copy.
	FrameDict (FrameDict &&)=default
FrameDict &	operator= (FrameDict const &)=delete
FrameDict &	operator= (FrameDict &&)=default
std::shared_ptr< FrameDict >	copy () const
	Return a deep copy of this object.
void	addFrame (int iframe, Mapping const &map, Frame const &frame) override
	Add a new Frame and an associated Mapping to this FrameSet so as to define a new coordinate system, derived from one which already exists within this FrameSet.
void	addFrame (std::string const &domain, Mapping const &map, Frame const &frame)
	Variant of addFrame(int, ...) where the initial frame is specified by domain.
std::set< std::string >	getAllDomains () const
	Get the domain names for all contained Frames (excluding frames with empty or defaulted domain names).
std::shared_ptr< Frame >	getFrame (std::string const &domain, bool copy=true) const
	Variant of getFrame(int, bool) where the frame is specified by domain name.
std::shared_ptr< Mapping >	getMapping (int from, std::string const &to) const
	Variant of FrameSet::getMapping with the second frame specified by domain.
std::shared_ptr< Mapping >	getMapping (std::string const &from, int to) const
	Variant of FrameSet::getMapping with the first frame specified by domain.
std::shared_ptr< Mapping >	getMapping (std::string const &from, std::string const &to) const
	Variant of FrameSet::getMapping with the both frames specified by domain.
int	getIndex (std::string const &domain) const
	Get the index of a frame specified by domain.
bool	hasDomain (std::string const &domain) const
	Return True if a frame in this FrameDict has the specified domain.
void	mirrorVariants (std::string const &domain)
	Variant of mirrorVariants(int) with the frame specified by domain.
void	remapFrame (std::string const &domain, Mapping &map)
	Variant of remapFrame(int, Mapping&) with the frame specified by domain.
void	removeFrame (int iframe) override
	Remove a Frame from a FrameSet.
void	removeFrame (std::string const &domain)
	Variant of removeFrame(int) with the frame specified by domain.
void	setBase (std::string const &domain)
	Variant of setBase(int) with the frame specified by domain.
void	setCurrent (std::string const &domain)
	Variant of setCurrent(int) with the frame specified by domain.
void	setDomain (std::string const &domain) override
	Set the domain of the current frame (and update the internal dict).
std::shared_ptr< Frame >	getFrame (int iframe, bool copy=true) const
	Obtain a deep copy of the specified Frame.
std::shared_ptr< Mapping >	getMapping (int from=BASE, int to=CURRENT) const
	Obtain a Mapping that converts between two Frames in a FrameSet.
void	mirrorVariants (int iframe)
	Indicates that all access to the Variant attribute of the current Frame should should be forwarded to some other nominated Frame in the FrameSet.
void	remapFrame (int iframe, Mapping &map)
	Modify the relationship (i.e.
void	setBase (int ind)
	Set Base: index of base Frame.
void	setCurrent (int ind)
	Set Current: index of current Frame, starting from 1.
void	addAxes (Frame const &frame)
	Append the axes from a specified Frame to every existing Frame in this FrameSet.
void	addVariant (Mapping const &map, std::string const &name)
	Store a new variant Mapping with the current Frame.
std::string	getAllVariants () const
	Get AllVariants: a list of all variant mappings stored with the current Frame.
int	getBase () const
	Get Base: index of base Frame.
int	getCurrent () const
	Get Current: index of current Frame, starting from 1.
int	getNFrame () const
	Get FrameSet_NFrame "NFrame": number of Frames in the FrameSet, starting from 1.
std::string	getVariant () const
	Variant: name of variant mapping in use by current Frame
void	renameVariant (std::string const &name)
	Rename the current Variant of the current Mapping.

Static Public Attributes
static int constexpr	BASE = AST__BASE
	index of base frame
static int constexpr	CURRENT = AST__CURRENT
	index of current frame
static int constexpr	NOFRAME = AST__NOFRAME
	an invalid frame index

Protected Member Functions
virtual std::shared_ptr< Object >	copyPolymorphic () const override
std::shared_ptr< FrameSet >	getFrameSet () const
	Return a deep copy as a FrameSet.
	FrameDict (AstFrameSet *rawptr)
	Construct a FrameDict from a raw AST pointer.

Friends
class	Object

Detailed Description

A FrameSet whose frames can be referenced by domain name.

For every FrameSet method that takes a frame index, the same method in FrameDict may take a (case blind) domain name or a frame index.

This has several useful applications:

Locate a frame without changing the FrameSet (findFrame is not a const method).
Locate a frame or mapping in a way that is unaffected by deleting frames (indices change, domain names do not).

All contained Frames with explicitly set, non-empty domains must have unique domains (where the comparison ignores case). Use FrameSet if you want a collection of Frames that may have matching domains.

Warning

FrameDict is a convenience wrapper around FrameSet with no corresponding class in AST. As a consequence:

FrameDict.getClassName returns "FrameSet"
A FrameDict persisted using a Channel or pickle is unpersisted as a FrameSet

Note

AST casts all Frame domains to uppercase. This is why domain comparison and domain lookup are case blind.
Some AST frame classes have default domain names, e.g. SkyFrame defaults to "SKY". Such default names are ignored in order to reduce the chance of accidental collisions.

Attributes

All those of FrameSet.

Definition at line 67 of file FrameDict.h.

Constructor & Destructor Documentation

◆ FrameDict() [1/6]

ast::FrameDict::FrameDict	(	Frame const &	frame,
		std::string const &	options = "" )

inlineexplicit

Construct a FrameDict from a single Frame.

The frame is deep copied.

Parameters

[in]	frame	the first Frame to be inserted into the FrameDict. This initially becomes both the base and the current Frame. Further Frames may be added using addFrame
[in]	options	Comma-separated list of attribute assignments.

Definition at line 81 of file FrameDict.h.

◆ FrameDict() [2/6]

ast::FrameDict::FrameDict	(	Frame const &	baseFrame,
		Mapping const &	mapping,
		Frame const &	currentFrame,
		std::string const &	options = "" )

inlineexplicit

Construct a FrameDict from two frames and a mapping that connects them.

Both frames and the mapping are deep copied.

Parameters

[in]	baseFrame	base Frame.
[in]	mapping	mapping connecting baseFrame to currentFrame.
[in]	currentFrame	current Frame.
[in]	options	Comma-separated list of attribute assignments.

Exceptions

std::invalid_argument if both Frames have the same non-empty domain.

Definition at line 97 of file FrameDict.h.

◆ FrameDict() [3/6]

ast::FrameDict::FrameDict ( FrameSet const & frameSet )

inlineexplicit

Construct a FrameDict from a FrameSet.

The FrameSet is deep-copied

Exceptions

std::invalid_argument if two Frames in the FrameSet have the same non-empty domain.

Definition at line 110 of file FrameDict.h.

◆ ~FrameDict()

virtual ast::FrameDict::~FrameDict ( )

inlinevirtual

Definition at line 114 of file FrameDict.h.

◆ FrameDict() [4/6]

ast::FrameDict::FrameDict ( FrameDict const & )

default

Copy constructor: make a deep copy.

◆ FrameDict() [5/6]

ast::FrameDict::FrameDict ( FrameDict && )

default

◆ FrameDict() [6/6]

ast::FrameDict::FrameDict ( AstFrameSet * rawptr )

explicitprotected

Construct a FrameDict from a raw AST pointer.

Definition at line 74 of file FrameDict.cc.

Member Function Documentation

◆ addAxes()

void ast::FrameSet::addAxes ( Frame const & frame )

inlineinherited

Append the axes from a specified Frame to every existing Frame in this FrameSet.

In detail, each Frame in this FrameSet is replaced by a CmpFrame containing the original Frame and the Frame specified by parameter frame. In addition, each Mapping in the FrameSet is replaced by a CmpMap containing the original Mapping and a UnitMap in parallel. The NIn and NOut attributes of the UnitMap are set equal to the number of axes in the supplied Frame. Each new CmpMap is simplified before being stored in the FrameSet.

Parameters

[in] frame Frame whose axes are to be appended to each Frame in this FrameSet.

Definition at line 160 of file FrameSet.h.

◆ addFrame() [1/2]

void ast::FrameDict::addFrame	(	int	iframe,
		Mapping const &	map,
		Frame const &	frame )

overridevirtual

Add a new Frame and an associated Mapping to this FrameSet so as to define a new coordinate system, derived from one which already exists within this FrameSet.

If frame is a Frame then it becomes the current frame and its index is the new number of frames. If frame is a FrameSet then its current frame becomes the new current frame and the indices of all its frames are increased by the number of frames originally in this FrameSet. In both cases the indices of the Frames already in this FrameSet are left unchanged.

Parameters

[in]	iframe	The index of the Frame within the FrameSet which describes the coordinate system upon which the new one is to be based. This value should lie in the range from 1 to the number of frames already in this FrameSet (as given by getNFrame). A value of FrameSet::BASE or FrameSet::CURRENT may be given to specify the base Frame or the current Frame respectively. A value of AST__ALLFRAMES is not permitted; call addAllFrames instead.
[in]	map	A Mapping which describes how to convert coordinates from the old coordinate system (described by the Frame with index iframe ) into coordinates in the new system. The Mapping's forward transformation should perform this conversion, and its inverse transformation should convert in the opposite direction.
[in]	frame	A Frame that describes the new coordinate system. Any type of Frame may be supplied (including Regions and FrameSets). This function may also be used to merge two FrameSets by supplying a pointer to a second FrameSet for this parameter (see the Notes section for details).

Notes

Deep copies of the supplied map and frame are stored within the modified FrameSet. So any changes made to the FrameSet after calling this method will have no effect on the supplied Mapping and Frame objects.
This function sets the value of the Current attribute for the FrameSet so that the new Frame subsequently becomes the current Frame.
The number of input coordinate values accepted by the supplied map (its NIn attribute) must match the number of axes in the Frame identified by the iframe parameter. Similarly, the number of output coordinate values generated by map (its NOut attribute) must match the number of axes in frame.
As a special case, if a pointer to a FrameSet is given for the frame parameter, this is treated as a request to merge frame into this FrameSet. This is done by appending all the new Frames in the frame FrameSet to this FrameSet, while preserving their order and retaining all the inter-relationships (i.e. Mappings) between them. The two sets of Frames are inter-related within the merged FrameSet by using the Mapping supplied. This should convert between the Frame identified by the iframe parameter (in this FrameSet) and the current Frame of the frame FrameSet. This latter Frame becomes the current Frame in this FrameSet.

Exceptions

std::invalid_argument if frame has a non-empty domain and this FrameDict already contains a Frame with that domain

Reimplemented from ast::FrameSet.

Definition at line 32 of file FrameDict.cc.

◆ addFrame() [2/2]

void ast::FrameDict::addFrame	(	std::string const &	domain,
		Mapping const &	map,
		Frame const &	frame )

Variant of addFrame(int, ...) where the initial frame is specified by domain.

Definition at line 41 of file FrameDict.cc.

◆ addVariant()

void ast::FrameSet::addVariant	(	Mapping const &	map,
		std::string const &	name )

inlineinherited

Store a new variant Mapping with the current Frame.

The newly added variant becomes the current variant (attribute the Variant is set to name).

See the Variant attribute for more details. See also getVariant, renameVariant and mirrorVariants

Parameters

[in]	map	A Mapping which describes how to convert coordinates from the current frame to the new variant of the current Frame.
[in]	name	The name to associate with the new variant Mapping.

Exceptions

std::runtime_error

if:

A variant with the supplied name already exists in the current Frame.
The current Frame is a mirror for the variant Mappings in another Frame. This is only the case if the astMirrorVariants function has been called to make the current Frame act as a mirror.

Definition at line 234 of file FrameSet.h.

◆ copy()

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

inline

Return a deep copy of this object.

Definition at line 123 of file FrameDict.h.

◆ copyPolymorphic()

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

inlineoverrideprotectedvirtual

Reimplemented from ast::FrameSet.

Definition at line 257 of file FrameDict.h.

◆ getAllDomains()

std::set< std::string > ast::FrameDict::getAllDomains ( ) const

Get the domain names for all contained Frames (excluding frames with empty or defaulted domain names).

Definition at line 45 of file FrameDict.cc.

◆ getAllVariants()

std::string ast::FrameSet::getAllVariants ( ) const

inlineinherited

Get AllVariants: a list of all variant mappings stored with the current Frame.

Definition at line 243 of file FrameSet.h.

◆ getBase()

int ast::FrameSet::getBase ( ) const

inlineinherited

Get Base: index of base Frame.

Definition at line 248 of file FrameSet.h.

◆ getCurrent()

int ast::FrameSet::getCurrent ( ) const

inlineinherited

Get Current: index of current Frame, starting from 1.

Definition at line 253 of file FrameSet.h.

◆ getFrame() [1/2]

std::shared_ptr< Frame > ast::FrameSet::getFrame	(	int	iframe,
		bool	copy = true ) const

inline

Obtain a deep copy of the specified Frame.

Parameters

[in]	iframe	The index of the required Frame within this FrameSet. This value should lie in the range 1 to the number of frames already in this FrameSet (as given by getNFrame). A value of FrameSet::Base or FrameSet::CURRENT may be given to specify the base Frame or the current Frame, respectively.
[in]	copy	If true return a deep copy, else a shallow copy.

Warning: : to permute axes of a frame in a FrameSet, such that the connecting mappings are updated: set the current frame to the frame in question and call permAxes directly on the FrameSet. Do not call permAxes on a shallow copy of the frame (retrieved by getFrame) as this will not affect the connected mappings.

Definition at line 270 of file FrameSet.h.

◆ getFrame() [2/2]

std::shared_ptr< Frame > ast::FrameDict::getFrame	(	std::string const &	domain,
		bool	copy = true ) const

inline

Variant of getFrame(int, bool) where the frame is specified by domain name.

Exceptions

std::out_of_range if no frame found with the specified domain

Definition at line 151 of file FrameDict.h.

◆ getFrameSet()

std::shared_ptr< FrameSet > ast::FrameDict::getFrameSet ( ) const

inlineprotected

Return a deep copy as a FrameSet.

This is used internally for operations that modify the contents:

Retrieve a copy as a FrameSet
Modify the copy
Call _update to construct a new domain:index dict from the copy and swap in the new data

This could be a public member function, but wait until a need is identified.

Warning: this must return a FrameSet, not a FrameDict in order to avoid an infinite loop.

Definition at line 273 of file FrameDict.h.

◆ getIndex()

int ast::FrameDict::getIndex ( std::string const & domain ) const

inline

Get the index of a frame specified by domain.

Exceptions

std::out_of_range if no frame found with the specified domain

Definition at line 189 of file FrameDict.h.

◆ getMapping() [1/4]

std::shared_ptr< Mapping > ast::FrameDict::getMapping	(	int	from,
		std::string const &	to ) const

inline

Variant of FrameSet::getMapping with the second frame specified by domain.

Exceptions

std::out_of_range if no frame found with the specified from or to domain

Definition at line 162 of file FrameDict.h.

◆ getMapping() [2/4]

std::shared_ptr< Mapping > ast::FrameSet::getMapping	(	int	from = BASE,
		int	to = CURRENT ) const

inline

Obtain a Mapping that converts between two Frames in a FrameSet.

Parameters

[in]	from	The index of the first Frame in the FrameSet, the frame describing the coordinate system for the "input" end of the Mapping. This value should lie in the range 1 to the number of frames already in this FrameSet (as given by getNFrame).
[in]	to	The index of the second Frame in the FrameSet, the frame describing the coordinate system for the "output" end of the Mapping. This value should lie in the range 1 to the number of frames already in this FrameSet (as given by getNFrame).

Returns: A Mapping whose forward transformation converts coordinates from the first frame to the second one, and whose inverse transformation converts coordinates in the opposite direction.

Notes

The returned Mapping will include the clipping effect of any Regions which occur on the path between the two supplied Frames, including the specified end frames.
It should always be possible to generate the Mapping requested, but this does not necessarily guarantee that it will be able to perform the required coordinate conversion. If necessary, call hasForward or hasInverse on the returned Mapping to determine if the required transformation is available.

Definition at line 304 of file FrameSet.h.

◆ getMapping() [3/4]

std::shared_ptr< Mapping > ast::FrameDict::getMapping	(	std::string const &	from,
		int	to ) const

inline

Variant of FrameSet::getMapping with the first frame specified by domain.

Exceptions

std::out_of_range if no frame found with the specified from or to domain

Definition at line 171 of file FrameDict.h.

◆ getMapping() [4/4]

std::shared_ptr< Mapping > ast::FrameDict::getMapping	(	std::string const &	from,
		std::string const &	to ) const

inline

Variant of FrameSet::getMapping with the both frames specified by domain.

Exceptions

std::out_of_range if no frame found with the specified from or to domain

Definition at line 180 of file FrameDict.h.

◆ getNFrame()

int ast::FrameSet::getNFrame ( ) const

inlineinherited

Get FrameSet_NFrame "NFrame": number of Frames in the FrameSet, starting from 1.

Definition at line 316 of file FrameSet.h.

◆ getVariant()

std::string ast::FrameSet::getVariant ( ) const

inlineinherited

Variant: name of variant mapping in use by current Frame

See also addVariant, mirrorVariants and renameVariant

Definition at line 323 of file FrameSet.h.

◆ hasDomain()

bool ast::FrameDict::hasDomain ( std::string const & domain ) const

inline

Return True if a frame in this FrameDict has the specified domain.

Definition at line 201 of file FrameDict.h.

◆ mirrorVariants() [1/2]

void ast::FrameSet::mirrorVariants ( int iframe )

inline

Indicates that all access to the Variant attribute of the current Frame should should be forwarded to some other nominated Frame in the FrameSet.

For instance, if a value is set subsequently for the Variant attribute of the current Frame, the current Frame will be left unchanged and the setting is instead applied to the nominated Frame. Likewise, if the value of the Variant attribute is requested, the value returned is the value stored for the nominated Frame rather than the current Frame itself.

This provides a mechanism for propagating the effects of variant Mappings around a FrameSet. If a new Frame is added to a FrameSet by connecting it to an pre-existing Frame that has two or more variant Mappings, then it may be appropriate to set the new Frame so that it mirrors the variants Mappings of the pre-existing Frame. If this is done, then it will be possible to select a specific variant Mapping using either the pre-existing Frame or the new Frame.

See also addVariant, getVariant and renameVariant.

Parameters

[in] iframe The index of the Frame within the FrameSet which is to be mirrored by the current Frame. This value should lie in the range from 1 to the number of Frames in the FrameSet (as given by getNFrame). If AST__NOFRAME is supplied (or the current Frame is specified), then any mirroring established by a previous call to this function is disabled. A value of FrameSet::BASE may be given to specify the base frame.

Notes:

Mirrors can be chained. That is, if Frame B is set to be a mirror of Frame A, and Frame C is set to be a mirror of Frame B, then Frame C will act as a mirror of Frame A.
Variant Mappings cannot be added to the current Frame if it is mirroring another Frame. So calls to addVariant will cause an error to be reported if the current Frame is mirroring another Frame.
Any variant Mappings explicitly added to the current Frame using addVariant will be ignored if the current Frame is mirroring another Frame.

Definition at line 367 of file FrameSet.h.

◆ mirrorVariants() [2/2]

void ast::FrameDict::mirrorVariants ( std::string const & domain )

inline

Variant of mirrorVariants(int) with the frame specified by domain.

Exceptions

std::out_of_range if no frame found with the specified domain

Definition at line 210 of file FrameDict.h.

◆ operator=() [1/2]

FrameDict & ast::FrameDict::operator= ( FrameDict && )

default

◆ operator=() [2/2]

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

delete

◆ remapFrame() [1/2]

void ast::FrameSet::remapFrame	(	int	iframe,
		Mapping &	map )

inline

Modify the relationship (i.e.

Mapping) between a specified Frame in a FrameSet and the other Frames in that FrameSet.

Typically, this might be required if the FrameSet has been used to calibrate (say) an image, and that image is re-binned. The Frame describing the image will then have undergone a coordinate transformation, and this should be communicated to the associated FrameSet using this function.

See also addVariant, getVariant and mirrorVariants.

Parameters

[in]	iframe	The index within the FrameSet of the Frame to be modified. This value should lie in the range 1 to the number of frames already in this FrameSet (as given by getNFrame). A value of FrameSet::BASE or FrameSet::CURRENT may be given to specify the base Frame or the current Frame respectively.
[in]	map	A Mapping whose forward transformation converts coordinate values from the original coordinate system described by the Frame to the new one, and whose inverse transformation converts in the opposite direction.

Notes

The relationship between the selected Frame and any other Frame within the FrameSet will be modified by this function, but the relationship between all other Frames in the FrameSet remains unchanged.
The number of input and output coordinate values of the Mapping must be equal and must match the number of axes in the Frame being modified.
If a simple change of axis order is required, then permAxes may provide a more straightforward method of making the required changes to the FrameSet.
This function cannot be used to change the number of Frame axes. To achieve this, a new Frame must be added to the FrameSet (with addFrame) and the original one removed if necessary (with removeFrame).
Any variant Mappings associated with the remapped Frame (except for the current variant) will be lost as a consequence of calling this method (see attribute Variant).

Definition at line 410 of file FrameSet.h.

◆ remapFrame() [2/2]

void ast::FrameDict::remapFrame	(	std::string const &	domain,
		Mapping &	map )

inline

Variant of remapFrame(int, Mapping&) with the frame specified by domain.

Exceptions

std::out_of_range if no frame found with the specified domain

Definition at line 219 of file FrameDict.h.

◆ removeFrame() [1/2]

void ast::FrameDict::removeFrame ( int iframe )

overridevirtual

Remove a Frame from a FrameSet.

Other Frame indices in the FrameSet are re-numbered as follows: Frame indices greater than iframe are decremented by one; other Frame indeces retain the same index.

Parameters

[in] iframe The index of the required Frame within this FrameSet. This value should lie in the range 1 to the number of Frames in this FrameSet (as given by getNFrame). A value of FrameSet::BASE or FrameSet::CURRENT may be given to specify the base Frame or the current Frame, respectively.

Notes

Removing a Frame from a FrameSet does not affect the relationship between other Frames in this FrameSet, even if they originally depended on the Frame being removed.
The number of Frames in a FrameSet cannot be reduced to zero.
If a FrameSet's base or current Frame is removed, the Base or Current attribute (respectively) of the FrameSet will have its value cleared, so that another Frame will then assume its role by default.
If any other Frame is removed, the base and current Frames will remain the same. To ensure this, the Base and/or Current attributes of the FrameSet will be changed, if necessary, to reflect any change in the indices of these Frames.

Exceptions

std::runtime_error if you attempt to remove the last frame

Reimplemented from ast::FrameSet.

Definition at line 53 of file FrameDict.cc.

◆ removeFrame() [2/2]

void ast::FrameDict::removeFrame ( std::string const & domain )

Variant of removeFrame(int) with the frame specified by domain.

Exceptions

std::out_of_range if no frame found with the specified domain

Definition at line 59 of file FrameDict.cc.

◆ renameVariant()

void ast::FrameSet::renameVariant ( std::string const & name )

inlineinherited

Rename the current Variant of the current Mapping.

The Variant attribute is updated to name.

See the Variant attribute for more details. See also addVariant, getVariant and mirrorVariants.

Parameters

[in] name The new name of the current variant Mapping.

Exceptions

std::runtime_error

if:

A variant with the supplied name already exists in the current Frame.
The current Frame is a mirror for the variant Mappings in another Frame. This is only the case if the astMirrorVariants function has been called to make the current Frame act as a mirror.

Definition at line 463 of file FrameSet.h.

◆ setBase() [1/2]

void ast::FrameSet::setBase ( int ind )

inline

Set Base: index of base Frame.

Definition at line 471 of file FrameSet.h.

◆ setBase() [2/2]

void ast::FrameDict::setBase ( std::string const & domain )

inline

Variant of setBase(int) with the frame specified by domain.

Exceptions

std::out_of_range if no frame found with the specified domain

Definition at line 238 of file FrameDict.h.

◆ setCurrent() [1/2]

void ast::FrameSet::setCurrent ( int ind )

inline

Set Current: index of current Frame, starting from 1.

Definition at line 476 of file FrameSet.h.

◆ setCurrent() [2/2]

void ast::FrameDict::setCurrent ( std::string const & domain )

inline

Variant of setCurrent(int) with the frame specified by domain.

Exceptions

std::out_of_range if no frame found with the specified domain

Definition at line 247 of file FrameDict.h.

◆ setDomain()

void ast::FrameDict::setDomain ( std::string const & domain )

override

Set the domain of the current frame (and update the internal dict).

Exceptions

std::invalid_argument if another frame already has this domain

Definition at line 61 of file FrameDict.cc.

◆ Object

friend class Object

friend

Definition at line 68 of file FrameDict.h.

Member Data Documentation

◆ BASE

int constexpr ast::FrameSet::BASE = AST__BASE

staticconstexprinherited

index of base frame

Definition at line 104 of file FrameSet.h.

◆ CURRENT

int constexpr ast::FrameSet::CURRENT = AST__CURRENT

staticconstexprinherited

index of current frame

Definition at line 105 of file FrameSet.h.

◆ NOFRAME

int constexpr ast::FrameSet::NOFRAME = AST__NOFRAME

staticconstexprinherited

an invalid frame index

Definition at line 106 of file FrameSet.h.

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

include/astshim/FrameDict.h
src/FrameDict.cc

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ FrameDict() [1/6]

◆ FrameDict() [2/6]

◆ FrameDict() [3/6]

◆ ~FrameDict()

◆ FrameDict() [4/6]

◆ FrameDict() [5/6]

◆ FrameDict() [6/6]

Member Function Documentation

◆ addAxes()

◆ addFrame() [1/2]

Notes

◆ addFrame() [2/2]

◆ addVariant()

◆ copy()

◆ copyPolymorphic()

◆ getAllDomains()

◆ getAllVariants()

◆ getBase()

◆ getCurrent()

◆ getFrame() [1/2]

◆ getFrame() [2/2]

◆ getFrameSet()

◆ getIndex()

◆ getMapping() [1/4]

◆ getMapping() [2/4]

Notes

◆ getMapping() [3/4]

◆ getMapping() [4/4]

◆ getNFrame()

◆ getVariant()

◆ hasDomain()

◆ mirrorVariants() [1/2]

Notes:

◆ mirrorVariants() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ remapFrame() [1/2]

Notes

◆ remapFrame() [2/2]

◆ removeFrame() [1/2]

Notes

◆ removeFrame() [2/2]

◆ renameVariant()

◆ setBase() [1/2]

◆ setBase() [2/2]

◆ setCurrent() [1/2]

◆ setCurrent() [2/2]

◆ setDomain()

Friends And Related Symbol Documentation

◆ Object

Member Data Documentation

◆ BASE

◆ CURRENT

◆ NOFRAME